Revision 5e31048f

b/trunk/Libraries/System.Threading.Tasks.Dataflow.xml
1
<?xml version="1.0"?>
2
<doc>
3
    <assembly>
4
        <name>System.Threading.Tasks.Dataflow</name>
5
    </assembly>
6
    <members>
7
        <member name="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2">
8
            <summary>
9
            Provides a dataflow block that batches a specified number of inputs of potentially differing types
10
            provided to one or more of its targets.
11
            </summary>
12
            <typeparam name="T1">Specifies the type of data accepted by the block's first target.</typeparam>
13
            <typeparam name="T2">Specifies the type of data accepted by the block's second target.</typeparam>
14
        </member>
15
        <member name="T:System.Threading.Tasks.Dataflow.IReceivableSourceBlock`1">
16
            <summary>Represents a dataflow block that supports receiving of messages without linking.</summary>
17
            <typeparam name="TOutput">Specifies the type of data supplied by the <see cref="T:System.Threading.Tasks.Dataflow.IReceivableSourceBlock`1"/>.</typeparam>
18
        </member>
19
        <member name="T:System.Threading.Tasks.Dataflow.ISourceBlock`1">
20
            <summary>Represents a dataflow block that is a source of data.</summary>
21
            <typeparam name="TOutput">Specifies the type of data supplied by the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.</typeparam>
22
        </member>
23
        <member name="T:System.Threading.Tasks.Dataflow.IDataflowBlock">
24
            <summary>Represents a dataflow block.</summary>
25
        </member>
26
        <member name="M:System.Threading.Tasks.Dataflow.IDataflowBlock.Complete">
27
            <summary>
28
        Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
29
        nor produce any more messages nor consume any more postponed messages.
30
      </summary><remarks>
31
        After Complete has been called on a dataflow block, that block will complete
32
        (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
33
        available data. Complete will not block waiting for completion to occur, but rather will initiaite
34
        the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
35
      </remarks>
36
        </member>
37
        <member name="M:System.Threading.Tasks.Dataflow.IDataflowBlock.Fault(System.Exception)">
38
            <summary>
39
        Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a 
40
        <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
41
      </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
42
        The <paramref name="exception"/> is null (Nothing in Visual Basic).
43
      </exception><remarks>
44
        After Fault has been called on a dataflow block, that block will complete
45
        (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes 
46
        buffered messages (uprocessed input messages as well as unoffered output messages) to be lost. 
47
      </remarks>
48
        </member>
49
        <member name="P:System.Threading.Tasks.Dataflow.IDataflowBlock.Completion">
50
            <summary>
51
        Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
52
      </summary><remarks>
53
        A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
54
        any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
55
        associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
56
        when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
57
        the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
58
        and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow  block has completed processing
59
        prematurely due to receiving a cancellation request.  If the task completes in the Faulted state, its Exception property will return
60
        an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
61
      </remarks>
62
        </member>
63
        <member name="M:System.Threading.Tasks.Dataflow.ISourceBlock`1.LinkTo(System.Threading.Tasks.Dataflow.ITargetBlock{`0},System.Boolean)">
64
            <summary>
65
        Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.
66
      </summary><param name="target">
67
        The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect this source.
68
      </param><param name="unlinkAfterOne">
69
        true if the source should unlink from the target after successfully propagating a single message; 
70
        otherwise, false to remain connected even after a single message has been propagated.
71
      </param><returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns><exception cref="T:System.ArgumentNullException">
72
        The <paramref name="target"/> is null (Nothing in Visual Basic).
73
      </exception>
74
        </member>
75
        <member name="M:System.Threading.Tasks.Dataflow.ISourceBlock`1.ConsumeMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0},System.Boolean@)">
76
            <summary>
77
        Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to accept and consume a  
78
        <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> previously offered by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
79
      </summary><param name="messageHeader">The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being consumed.</param><param name="target">
80
        The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> consuming the message.
81
      </param><param name="messageConsumed">
82
        True if the message was successfully consumed. False otherwise.
83
      </param><returns>
84
        <para>
85
          The value of the consumed message. This may correspond to a different <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance than was previously reserved and
86
          passed as the <paramref name="messageHeader"/> to <see cref="M:ConsumeMessage"/>. The consuming <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must 
87
          use the returned value instead of the value passed as messageValue through <see cref="M:OfferMessage"/>.
88
        </para>
89
        <para>
90
          If the message requested is not available, the return value will be null (Nothing in Visual Basic).
91
        </para>
92
      </returns><exception cref="T:System.ArgumentException">
93
        The <paramref name="messageHeader"/> is not valid.
94
      </exception><exception cref="T:System.ArgumentNullException">
95
        The <paramref name="target"/> is null (Nothing in Visual Basic).
96
      </exception><remarks>
97
        <para>
98
          Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> 
99
          instance may use <see cref="M:ConsumeMessage"/>, and it must only be used
100
          to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously 
101
          offered by this source to the target.
102
        </para>
103
      </remarks>
104
        </member>
105
        <member name="M:System.Threading.Tasks.Dataflow.ISourceBlock`1.ReserveMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
106
            <summary>
107
        Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to reserve a previously offered <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> 
108
        by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
109
      </summary><param name="messageHeader">
110
        The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being reserved.
111
      </param><param name="target">
112
        The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> reserving the message.
113
      </param><returns>true if the message was successfully reserved; otherwise, false.</returns><exception cref="T:System.ArgumentException">
114
        The <paramref name="messageHeader"/> is not valid.
115
      </exception><exception cref="T:System.ArgumentNullException">
116
        The <paramref name="target"/> is null (Nothing in Visual Basic).
117
      </exception><remarks>
118
        <para>
119
          Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> instance 
120
          may use <see cref="M:ReserveMessage"/>, and it must only be used
121
          to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously 
122
          offered by this source to the target.
123
        </para>
124
        <para>
125
          If true is returned, the <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must subsequently call either <see cref="M:ConsumeMessage"/> or <see cref="M:ReserveMessage"/> for this message.
126
          Failure to do so may result in the source being unable to propagate any further messages to this or other targets.
127
        </para>
128
        <para>
129
          <see cref="M:ReserveMessage"/> must not be called while the target is holding any internal locks.  Doing so will violate the lock hierarchy
130
          necessary to avoid deadlocks in a dataflow network.
131
        </para>
132
      </remarks>
133
        </member>
134
        <member name="M:System.Threading.Tasks.Dataflow.ISourceBlock`1.ReleaseReservation(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
135
            <summary>
136
        Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to release a previously reserved 
137
        <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
138
      </summary><param name="messageHeader">
139
        The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the reserved message being released.
140
      </param><param name="target">
141
        The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> releasing the message it previously reserved.
142
      </param><exception cref="T:System.ArgumentException">
143
        The <paramref name="messageHeader"/> is not valid.
144
      </exception><exception cref="T:System.ArgumentNullException">
145
        The <paramref name="target"/> is null (Nothing in Visual Basic).
146
      </exception><exception cref="T:System.InvalidOperationException">
147
        The <paramref name="target"/> did not have the message reserved.
148
      </exception><remarks>
149
        <para>
150
          Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> 
151
          instance may use <see cref="M:ReleaseMessage"/>, and it must only be used
152
          to release <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously 
153
          and successfully reserved by the target.
154
        </para>
155
      </remarks>
156
        </member>
157
        <member name="M:System.Threading.Tasks.Dataflow.IReceivableSourceBlock`1.TryReceive(System.Predicate{`0},`0@)">
158
            <summary>
159
        Attempts to synchronously receive an available output item from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
160
      </summary><param name="filter">
161
        The predicate a value must successfully pass in order for it to be received. 
162
        <paramref name="filter"/> may be null (Nothing in Visual Basic), in which case all items will pass.
163
      </param><param name="item">The item received from the source.</param><returns>true if an item could be received; otherwise, false.</returns><remarks>
164
        This method does not block waiting for the source to provide an item.
165
        It will return after checking for an element, whether or not an element was available.
166
      </remarks>
167
        </member>
168
        <member name="M:System.Threading.Tasks.Dataflow.IReceivableSourceBlock`1.TryReceiveAll(System.Collections.Generic.IList{`0}@)">
169
            <summary>
170
        Attempts to synchronously receive all available items from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
171
      </summary><param name="items">The items received from the source.</param><returns>true if one or more items could be received; otherwise, false.</returns><remarks>
172
        This method does not block waiting for the source to provide an item.
173
        It will return after checking for elements, whether or not an element was available.
174
      </remarks>
175
        </member>
176
        <member name="T:System.Threading.Tasks.Dataflow.Internal.IDebuggerDisplay">
177
            <summary>Implemented to provide customizable data for debugger displays.</summary>
178
        </member>
179
        <member name="P:System.Threading.Tasks.Dataflow.Internal.IDebuggerDisplay.Content">
180
            <summary>The object to be displayed as the content of a DebuggerDisplayAttribute.</summary>
181
            <remarks>
182
            The property returns an object to allow the debugger to interpret arbitrary .NET objects.
183
            The return value may be, but need not be limited to be, a string.
184
            </remarks>
185
        </member>
186
        <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.m_batchSize">
187
            <summary>The size of the batches generated by this BatchedJoin.</summary>
188
        </member>
189
        <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.m_sharedResources">
190
            <summary>State shared among the targets.</summary>
191
        </member>
192
        <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.m_target1">
193
            <summary>The target providing inputs of type T1.</summary>
194
        </member>
195
        <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.m_target2">
196
            <summary>The target providing inputs of type T2.</summary>
197
        </member>
198
        <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.m_source">
199
            <summary>The source side.</summary>
200
        </member>
201
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.#ctor(System.Int32)">
202
            <summary>Initializes this <see cref="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2"/> with the specified configuration.</summary>
203
            <param name="batchSize">The number of items to group into a batch.</param>
204
            <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="batchSize"/> must be positive.</exception>
205
        </member>
206
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.#ctor(System.Int32,System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions)">
207
            <summary>Initializes this <see cref="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2"/> with the specified configuration.</summary>
208
            <param name="batchSize">The number of items to group into a batch.</param>
209
            <param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2"/>.</param>
210
            <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="batchSize"/> must be positive.</exception>
211
            <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
212
        </member>
213
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.LinkTo(System.Threading.Tasks.Dataflow.ITargetBlock{System.Tuple{System.Collections.Generic.IList{`0},System.Collections.Generic.IList{`1}}},System.Boolean)">
214
            <summary>
215
        Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.
216
      </summary><param name="target">
217
        The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect this source.
218
      </param><param name="unlinkAfterOne">
219
        true if the source should unlink from the target after successfully propagating a single message; 
220
        otherwise, false to remain connected even after a single message has been propagated.
221
      </param><returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns><exception cref="T:System.ArgumentNullException">
222
        The <paramref name="target"/> is null (Nothing in Visual Basic).
223
      </exception>
224
        </member>
225
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.TryReceive(System.Predicate{System.Tuple{System.Collections.Generic.IList{`0},System.Collections.Generic.IList{`1}}},System.Tuple{System.Collections.Generic.IList{`0},System.Collections.Generic.IList{`1}}@)">
226
            <summary>
227
        Attempts to synchronously receive an available output item from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
228
      </summary><param name="filter">
229
        The predicate a value must successfully pass in order for it to be received. 
230
        <paramref name="filter"/> may be null (Nothing in Visual Basic), in which case all items will pass.
231
      </param><param name="item">The item received from the source.</param><returns>true if an item could be received; otherwise, false.</returns><remarks>
232
        This method does not block waiting for the source to provide an item.
233
        It will return after checking for an element, whether or not an element was available.
234
      </remarks>
235
        </member>
236
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.TryReceiveAll(System.Collections.Generic.IList{System.Tuple{System.Collections.Generic.IList{`0},System.Collections.Generic.IList{`1}}}@)">
237
            <summary>
238
        Attempts to synchronously receive all available items from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
239
      </summary><param name="items">The items received from the source.</param><returns>true if one or more items could be received; otherwise, false.</returns><remarks>
240
        This method does not block waiting for the source to provide an item.
241
        It will return after checking for elements, whether or not an element was available.
242
      </remarks>
243
        </member>
244
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.Complete">
245
            <summary>
246
        Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
247
        nor produce any more messages nor consume any more postponed messages.
248
      </summary><remarks>
249
        After Complete has been called on a dataflow block, that block will complete
250
        (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
251
        available data. Complete will not block waiting for completion to occur, but rather will initiaite
252
        the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
253
      </remarks>
254
        </member>
255
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
256
            <summary>
257
        Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a 
258
        <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
259
      </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
260
        The <paramref name="exception"/> is null (Nothing in Visual Basic).
261
      </exception><remarks>
262
        After Fault has been called on a dataflow block, that block will complete
263
        (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes 
264
        buffered messages (uprocessed input messages as well as unoffered output messages) to be lost. 
265
      </remarks>
266
        </member>
267
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.System#Threading#Tasks#Dataflow#ISourceBlock{System#Tuple{System#Collections#Generic#IList{T1}@System#Collections#Generic#IList{T2}}}#ConsumeMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{System.Tuple{System.Collections.Generic.IList{`0},System.Collections.Generic.IList{`1}}},System.Boolean@)">
268
            <summary>
269
        Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to accept and consume a  
270
        <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> previously offered by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
271
      </summary><param name="messageHeader">The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being consumed.</param><param name="target">
272
        The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> consuming the message.
273
      </param><param name="messageConsumed">
274
        True if the message was successfully consumed. False otherwise.
275
      </param><returns>
276
        <para>
277
          The value of the consumed message. This may correspond to a different <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance than was previously reserved and
278
          passed as the <paramref name="messageHeader"/> to <see cref="M:ConsumeMessage"/>. The consuming <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must 
279
          use the returned value instead of the value passed as messageValue through <see cref="M:OfferMessage"/>.
280
        </para>
281
        <para>
282
          If the message requested is not available, the return value will be null (Nothing in Visual Basic).
283
        </para>
284
      </returns><exception cref="T:System.ArgumentException">
285
        The <paramref name="messageHeader"/> is not valid.
286
      </exception><exception cref="T:System.ArgumentNullException">
287
        The <paramref name="target"/> is null (Nothing in Visual Basic).
288
      </exception><remarks>
289
        <para>
290
          Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> 
291
          instance may use <see cref="M:ConsumeMessage"/>, and it must only be used
292
          to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously 
293
          offered by this source to the target.
294
        </para>
295
      </remarks>
296
        </member>
297
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.System#Threading#Tasks#Dataflow#ISourceBlock{System#Tuple{System#Collections#Generic#IList{T1}@System#Collections#Generic#IList{T2}}}#ReserveMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{System.Tuple{System.Collections.Generic.IList{`0},System.Collections.Generic.IList{`1}}})">
298
            <summary>
299
        Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to reserve a previously offered <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> 
300
        by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
301
      </summary><param name="messageHeader">
302
        The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being reserved.
303
      </param><param name="target">
304
        The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> reserving the message.
305
      </param><returns>true if the message was successfully reserved; otherwise, false.</returns><exception cref="T:System.ArgumentException">
306
        The <paramref name="messageHeader"/> is not valid.
307
      </exception><exception cref="T:System.ArgumentNullException">
308
        The <paramref name="target"/> is null (Nothing in Visual Basic).
309
      </exception><remarks>
310
        <para>
311
          Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> instance 
312
          may use <see cref="M:ReserveMessage"/>, and it must only be used
313
          to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously 
314
          offered by this source to the target.
315
        </para>
316
        <para>
317
          If true is returned, the <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must subsequently call either <see cref="M:ConsumeMessage"/> or <see cref="M:ReserveMessage"/> for this message.
318
          Failure to do so may result in the source being unable to propagate any further messages to this or other targets.
319
        </para>
320
        <para>
321
          <see cref="M:ReserveMessage"/> must not be called while the target is holding any internal locks.  Doing so will violate the lock hierarchy
322
          necessary to avoid deadlocks in a dataflow network.
323
        </para>
324
      </remarks>
325
        </member>
326
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.System#Threading#Tasks#Dataflow#ISourceBlock{System#Tuple{System#Collections#Generic#IList{T1}@System#Collections#Generic#IList{T2}}}#ReleaseReservation(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{System.Tuple{System.Collections.Generic.IList{`0},System.Collections.Generic.IList{`1}}})">
327
            <summary>
328
        Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to release a previously reserved 
329
        <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
330
      </summary><param name="messageHeader">
331
        The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the reserved message being released.
332
      </param><param name="target">
333
        The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> releasing the message it previously reserved.
334
      </param><exception cref="T:System.ArgumentException">
335
        The <paramref name="messageHeader"/> is not valid.
336
      </exception><exception cref="T:System.ArgumentNullException">
337
        The <paramref name="target"/> is null (Nothing in Visual Basic).
338
      </exception><exception cref="T:System.InvalidOperationException">
339
        The <paramref name="target"/> did not have the message reserved.
340
      </exception><remarks>
341
        <para>
342
          Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> 
343
          instance may use <see cref="M:ReleaseMessage"/>, and it must only be used
344
          to release <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously 
345
          and successfully reserved by the target.
346
        </para>
347
      </remarks>
348
        </member>
349
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.CompleteEachTarget">
350
            <summary>
351
            Invokes Complete on each target
352
            </summary>
353
        </member>
354
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.BatchSize">
355
            <summary>Gets the size of the batches generated by this <see cref="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2"/>.</summary>
356
        </member>
357
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.Target1">
358
            <summary>Gets a target that may be used to offer messages of the first type.</summary>
359
        </member>
360
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.Target2">
361
            <summary>Gets a target that may be used to offer messages of the second type.</summary>
362
        </member>
363
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.OutputCount">
364
            <summary>
365
        Gets the number of output items available to be received from this block.
366
      </summary>
367
        </member>
368
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.Completion">
369
            <summary>
370
        Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
371
      </summary><remarks>
372
        A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
373
        any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
374
        associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
375
        when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
376
        the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
377
        and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow  block has completed processing
378
        prematurely due to receiving a cancellation request.  If the task completes in the Faulted state, its Exception property will return
379
        an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
380
      </remarks>
381
        </member>
382
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.OutputCountForDebugger">
383
            <summary>Gets the number of messages waiting to be processed.  This must only be used from the debugger as it avoids taking necessary locks.</summary>
384
        </member>
385
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebuggerDisplayContent">
386
            <summary>The data to display in the debugger display attribute.</summary>
387
        </member>
388
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
389
            <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
390
        </member>
391
        <member name="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView">
392
            <summary>Provides a debugger type proxy for the Transform.</summary>
393
        </member>
394
        <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.m_batchedJoinBlock">
395
            <summary>The block being viewed.</summary>
396
        </member>
397
        <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.m_sourceDebuggingInformation">
398
            <summary>The source half of the block being viewed.</summary>
399
        </member>
400
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.#ctor(System.Threading.Tasks.Dataflow.BatchedJoinBlock{`0,`1})">
401
            <summary>Initializes the debug view.</summary>
402
            <param name="batchedJoinBlock">The batched join being viewed.</param>
403
        </member>
404
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.OutputQueue">
405
            <summary>Gets the messages waiting to be received.</summary>
406
        </member>
407
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.BatchesCreated">
408
            <summary>Gets the number of batches created.</summary>
409
        </member>
410
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.RemainingItemsForBatch">
411
            <summary>Gets the number of items remaining to form a batch.</summary>
412
        </member>
413
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.BatchSize">
414
            <summary>Gets the size of the batches generated by this BatchedJoin.</summary>
415
        </member>
416
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.Target1">
417
            <summary>Gets the first target.</summary>
418
        </member>
419
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.Target2">
420
            <summary>Gets the second target.</summary>
421
        </member>
422
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.TaskForOutputProcessing">
423
            <summary>Gets the task being used for output processing.</summary>
424
        </member>
425
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.DataflowBlockOptions">
426
            <summary>Gets the DataflowBlockOptions used to configure this block.</summary>
427
        </member>
428
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.IsCompleted">
429
            <summary>Gets whether the block is completed.</summary>
430
        </member>
431
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.Id">
432
            <summary>Gets the block's Id.</summary>
433
        </member>
434
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.LinkedTargets">
435
            <summary>Gets the set of all targets linked from this block.</summary>
436
        </member>
437
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.NextMessageReservedFor">
438
            <summary>Gets the target that holds a reservation on the next message, if any.</summary>
439
        </member>
440
        <member name="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3">
441
            <summary>
442
            Provides a dataflow block that batches a specified number of inputs of potentially differing types
443
            provided to one or more of its targets.
444
            </summary>
445
            <typeparam name="T1">Specifies the type of data accepted by the block's first target.</typeparam>
446
            <typeparam name="T2">Specifies the type of data accepted by the block's second target.</typeparam>
447
            <typeparam name="T3">Specifies the type of data accepted by the block's third target.</typeparam>
448
        </member>
449
        <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.m_batchSize">
450
            <summary>The size of the batches generated by this BatchedJoin.</summary>
451
        </member>
452
        <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.m_sharedResources">
453
            <summary>State shared among the targets.</summary>
454
        </member>
455
        <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.m_target1">
456
            <summary>The target providing inputs of type T1.</summary>
457
        </member>
458
        <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.m_target2">
459
            <summary>The target providing inputs of type T2.</summary>
460
        </member>
461
        <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.m_target3">
462
            <summary>The target providing inputs of type T3.</summary>
463
        </member>
464
        <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.m_source">
465
            <summary>The source side.</summary>
466
        </member>
467
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.#ctor(System.Int32)">
468
            <summary>Initializes this <see cref="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3"/> with the specified configuration.</summary>
469
            <param name="batchSize">The number of items to group into a batch.</param>
470
            <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="batchSize"/> must be positive.</exception>
471
        </member>
472
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.#ctor(System.Int32,System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions)">
473
            <summary>Initializes this <see cref="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3"/> with the specified configuration.</summary>
474
            <param name="batchSize">The number of items to group into a batch.</param>
475
            <param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2"/>.</param>
476
            <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="batchSize"/> must be positive.</exception>
477
            <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
478
        </member>
479
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.LinkTo(System.Threading.Tasks.Dataflow.ITargetBlock{System.Tuple{System.Collections.Generic.IList{`0},System.Collections.Generic.IList{`1},System.Collections.Generic.IList{`2}}},System.Boolean)">
480
            <summary>
481
        Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.
482
      </summary><param name="target">
483
        The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect this source.
484
      </param><param name="unlinkAfterOne">
485
        true if the source should unlink from the target after successfully propagating a single message; 
486
        otherwise, false to remain connected even after a single message has been propagated.
487
      </param><returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns><exception cref="T:System.ArgumentNullException">
488
        The <paramref name="target"/> is null (Nothing in Visual Basic).
489
      </exception>
490
        </member>
491
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.TryReceive(System.Predicate{System.Tuple{System.Collections.Generic.IList{`0},System.Collections.Generic.IList{`1},System.Collections.Generic.IList{`2}}},System.Tuple{System.Collections.Generic.IList{`0},System.Collections.Generic.IList{`1},System.Collections.Generic.IList{`2}}@)">
492
            <summary>
493
        Attempts to synchronously receive an available output item from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
494
      </summary><param name="filter">
495
        The predicate a value must successfully pass in order for it to be received. 
496
        <paramref name="filter"/> may be null (Nothing in Visual Basic), in which case all items will pass.
497
      </param><param name="item">The item received from the source.</param><returns>true if an item could be received; otherwise, false.</returns><remarks>
498
        This method does not block waiting for the source to provide an item.
499
        It will return after checking for an element, whether or not an element was available.
500
      </remarks>
501
        </member>
502
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.TryReceiveAll(System.Collections.Generic.IList{System.Tuple{System.Collections.Generic.IList{`0},System.Collections.Generic.IList{`1},System.Collections.Generic.IList{`2}}}@)">
503
            <summary>
504
        Attempts to synchronously receive all available items from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
505
      </summary><param name="items">The items received from the source.</param><returns>true if one or more items could be received; otherwise, false.</returns><remarks>
506
        This method does not block waiting for the source to provide an item.
507
        It will return after checking for elements, whether or not an element was available.
508
      </remarks>
509
        </member>
510
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.Complete">
511
            <summary>
512
        Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
513
        nor produce any more messages nor consume any more postponed messages.
514
      </summary><remarks>
515
        After Complete has been called on a dataflow block, that block will complete
516
        (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
517
        available data. Complete will not block waiting for completion to occur, but rather will initiaite
518
        the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
519
      </remarks>
520
        </member>
521
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
522
            <summary>
523
        Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a 
524
        <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
525
      </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
526
        The <paramref name="exception"/> is null (Nothing in Visual Basic).
527
      </exception><remarks>
528
        After Fault has been called on a dataflow block, that block will complete
529
        (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes 
530
        buffered messages (uprocessed input messages as well as unoffered output messages) to be lost. 
531
      </remarks>
532
        </member>
533
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.System#Threading#Tasks#Dataflow#ISourceBlock{System#Tuple{System#Collections#Generic#IList{T1}@System#Collections#Generic#IList{T2}@System#Collections#Generic#IList{T3}}}#ConsumeMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{System.Tuple{System.Collections.Generic.IList{`0},System.Collections.Generic.IList{`1},System.Collections.Generic.IList{`2}}},System.Boolean@)">
534
            <summary>
535
        Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to accept and consume a  
536
        <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> previously offered by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
537
      </summary><param name="messageHeader">The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being consumed.</param><param name="target">
538
        The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> consuming the message.
539
      </param><param name="messageConsumed">
540
        True if the message was successfully consumed. False otherwise.
541
      </param><returns>
542
        <para>
543
          The value of the consumed message. This may correspond to a different <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance than was previously reserved and
544
          passed as the <paramref name="messageHeader"/> to <see cref="M:ConsumeMessage"/>. The consuming <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must 
545
          use the returned value instead of the value passed as messageValue through <see cref="M:OfferMessage"/>.
546
        </para>
547
        <para>
548
          If the message requested is not available, the return value will be null (Nothing in Visual Basic).
549
        </para>
550
      </returns><exception cref="T:System.ArgumentException">
551
        The <paramref name="messageHeader"/> is not valid.
552
      </exception><exception cref="T:System.ArgumentNullException">
553
        The <paramref name="target"/> is null (Nothing in Visual Basic).
554
      </exception><remarks>
555
        <para>
556
          Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> 
557
          instance may use <see cref="M:ConsumeMessage"/>, and it must only be used
558
          to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously 
559
          offered by this source to the target.
560
        </para>
561
      </remarks>
562
        </member>
563
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.System#Threading#Tasks#Dataflow#ISourceBlock{System#Tuple{System#Collections#Generic#IList{T1}@System#Collections#Generic#IList{T2}@System#Collections#Generic#IList{T3}}}#ReserveMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{System.Tuple{System.Collections.Generic.IList{`0},System.Collections.Generic.IList{`1},System.Collections.Generic.IList{`2}}})">
564
            <summary>
565
        Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to reserve a previously offered <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> 
566
        by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
567
      </summary><param name="messageHeader">
568
        The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being reserved.
569
      </param><param name="target">
570
        The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> reserving the message.
571
      </param><returns>true if the message was successfully reserved; otherwise, false.</returns><exception cref="T:System.ArgumentException">
572
        The <paramref name="messageHeader"/> is not valid.
573
      </exception><exception cref="T:System.ArgumentNullException">
574
        The <paramref name="target"/> is null (Nothing in Visual Basic).
575
      </exception><remarks>
576
        <para>
577
          Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> instance 
578
          may use <see cref="M:ReserveMessage"/>, and it must only be used
579
          to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously 
580
          offered by this source to the target.
581
        </para>
582
        <para>
583
          If true is returned, the <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must subsequently call either <see cref="M:ConsumeMessage"/> or <see cref="M:ReserveMessage"/> for this message.
584
          Failure to do so may result in the source being unable to propagate any further messages to this or other targets.
585
        </para>
586
        <para>
587
          <see cref="M:ReserveMessage"/> must not be called while the target is holding any internal locks.  Doing so will violate the lock hierarchy
588
          necessary to avoid deadlocks in a dataflow network.
589
        </para>
590
      </remarks>
591
        </member>
592
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.System#Threading#Tasks#Dataflow#ISourceBlock{System#Tuple{System#Collections#Generic#IList{T1}@System#Collections#Generic#IList{T2}@System#Collections#Generic#IList{T3}}}#ReleaseReservation(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{System.Tuple{System.Collections.Generic.IList{`0},System.Collections.Generic.IList{`1},System.Collections.Generic.IList{`2}}})">
593
            <summary>
594
        Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to release a previously reserved 
595
        <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
596
      </summary><param name="messageHeader">
597
        The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the reserved message being released.
598
      </param><param name="target">
599
        The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> releasing the message it previously reserved.
600
      </param><exception cref="T:System.ArgumentException">
601
        The <paramref name="messageHeader"/> is not valid.
602
      </exception><exception cref="T:System.ArgumentNullException">
603
        The <paramref name="target"/> is null (Nothing in Visual Basic).
604
      </exception><exception cref="T:System.InvalidOperationException">
605
        The <paramref name="target"/> did not have the message reserved.
606
      </exception><remarks>
607
        <para>
608
          Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> 
609
          instance may use <see cref="M:ReleaseMessage"/>, and it must only be used
610
          to release <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously 
611
          and successfully reserved by the target.
612
        </para>
613
      </remarks>
614
        </member>
615
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.CompleteEachTarget">
616
            <summary>
617
            Invokes Complete on each target
618
            </summary>
619
        </member>
620
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.BatchSize">
621
            <summary>Gets the size of the batches generated by this <see cref="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3"/>.</summary>
622
        </member>
623
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.Target1">
624
            <summary>Gets a target that may be used to offer messages of the first type.</summary>
625
        </member>
626
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.Target2">
627
            <summary>Gets a target that may be used to offer messages of the second type.</summary>
628
        </member>
629
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.Target3">
630
            <summary>Gets a target that may be used to offer messages of the third type.</summary>
631
        </member>
632
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.OutputCount">
633
            <summary>
634
        Gets the number of output items available to be received from this block.
635
      </summary>
636
        </member>
637
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.Completion">
638
            <summary>
639
        Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
640
      </summary><remarks>
641
        A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
642
        any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
643
        associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
644
        when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
645
        the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
646
        and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow  block has completed processing
647
        prematurely due to receiving a cancellation request.  If the task completes in the Faulted state, its Exception property will return
648
        an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
649
      </remarks>
650
        </member>
651
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.OutputCountForDebugger">
652
            <summary>Gets the number of messages waiting to be processed.  This must only be used from the debugger as it avoids taking necessary locks.</summary>
653
        </member>
654
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebuggerDisplayContent">
655
            <summary>The data to display in the debugger display attribute.</summary>
656
        </member>
657
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
658
            <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
659
        </member>
660
        <member name="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView">
661
            <summary>Provides a debugger type proxy for the Transform.</summary>
662
        </member>
663
        <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.m_batchedJoinBlock">
664
            <summary>The block being viewed.</summary>
665
        </member>
666
        <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.m_sourceDebuggingInformation">
667
            <summary>The source half of the block being viewed.</summary>
668
        </member>
669
        <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.#ctor(System.Threading.Tasks.Dataflow.BatchedJoinBlock{`0,`1,`2})">
670
            <summary>Initializes the debug view.</summary>
671
            <param name="batchedJoinBlock">The batched join being viewed.</param>
672
        </member>
673
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.OutputQueue">
674
            <summary>Gets the messages waiting to be received.</summary>
675
        </member>
676
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.BatchesCreated">
677
            <summary>Gets the number of batches created.</summary>
678
        </member>
679
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.RemainingItemsForBatch">
680
            <summary>Gets the number of items remaining to form a batch.</summary>
681
        </member>
682
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.BatchSize">
683
            <summary>Gets the size of the batches generated by this BatchedJoin.</summary>
684
        </member>
685
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.Target1">
686
            <summary>Gets the first target.</summary>
687
        </member>
688
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.Target2">
689
            <summary>Gets the second target.</summary>
690
        </member>
691
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.Target3">
692
            <summary>Gets the second target.</summary>
693
        </member>
694
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.TaskForOutputProcessing">
695
            <summary>Gets the task being used for output processing.</summary>
696
        </member>
697
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.DataflowBlockOptions">
698
            <summary>Gets the DataflowBlockOptions used to configure this block.</summary>
699
        </member>
700
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.IsCompleted">
701
            <summary>Gets whether the block is completed.</summary>
702
        </member>
703
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.Id">
704
            <summary>Gets the block's Id.</summary>
705
        </member>
706
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.LinkedTargets">
707
            <summary>Gets the set of all targets linked from this block.</summary>
708
        </member>
709
        <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.NextMessageReservedFor">
710
            <summary>Gets the target that holds a reservation on the next message, if any.</summary>
711
        </member>
712
        <member name="T:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1">
713
            <summary>Provides the target used in a BatchedJoin.</summary>
714
            <typeparam name="T">Specifies the type of data accepted by this target.</typeparam>
715
        </member>
716
        <member name="T:System.Threading.Tasks.Dataflow.ITargetBlock`1">
717
            <summary>Represents a dataflow block that is a target for data.</summary>
718
            <typeparam name="TInput">Specifies the type of data accepted by the <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.</typeparam>
719
        </member>
720
        <member name="M:System.Threading.Tasks.Dataflow.ITargetBlock`1.OfferMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,`0,System.Threading.Tasks.Dataflow.ISourceBlock{`0},System.Boolean)">
721
            <!-- No matching elements were found for the following include tag --><include file="CommonXmlDocComments.xml" path="CommonXmlDocComments/Sources/Member[@name=&quot;OfferMessage&quot;]/*"/>
722
        </member>
723
        <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.m_sharedResources">
724
            <summary>The shared resources used by all targets associated with the same batched join instance.</summary>
725
        </member>
726
        <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.m_decliningPermanently">
727
            <summary>Whether this target is declining future messages.</summary>
728
        </member>
729
        <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.m_messages">
730
            <summary>Input messages for the next batch.</summary>
731
        </member>
732
        <member name="M:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.#ctor(System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources)">
733
            <summary>Initializes the target.</summary>
734
            <param name="sharedResources">The shared resources used by all targets associated with this batched join.</param>
735
        </member>
736
        <member name="M:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.GetAndEmptyMessages">
737
            <summary>Gets the messages buffered by this target and then empties the collection.</summary>
738
            <returns>The messages from the target.</returns>
739
        </member>
740
        <member name="M:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.OfferMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,`0,System.Threading.Tasks.Dataflow.ISourceBlock{`0},System.Boolean)">
741
            <summary>
742
        Offers a message to the <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>, giving the target the opportunity to consume or postpone the message.
743
      </summary><param name="messageHeader">
744
        A <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance that represents the header of the message being offered.
745
      </param><param name="messageValue">
746
        The value of the message being offered.
747
      </param><param name="source">
748
        The <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> offering the message. This may be null (Nothing in Visual Basic).
749
      </param><param name="consumeToAccept">
750
        true if the target must call ConsumeMessage synchronously during the call to OfferMessage, prior to returning
751
        <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Accepted"/>, in order to consume the message.
752
        false if the target wanting to accept the message should not call ConsumeMessage, and should isntead simply return DataflowMessageStatus.Accepted.
753
      </param><returns>
754
        The status of the offered message. If the message was accepted by the target, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Accepted"/> is returned, and the source should
755
        no longer use the offered message, as it is now owned by the target. If the message was postponed by the target, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Postponed"/> is returned
756
        as a notification that the target may later attempt to consume or reserve the message; in the meantime, the source still owns the message and may offer it to other blocks.
757
        If the target would have otherwise postponed but source was null, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is instead returned. 
758
        If the target tried to accept the message but missed it due to the source delivering the message to another target or simply discarding it, 
759
        <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.NotAvailable"/> is returned.
760
        If the target chose not to accept the message, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is returned.  If the target
761
        chose not to accept the message and will never accept another message from this source, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.DecliningPermanently"/> is returned.
762
      </returns><exception cref="T:System.ArgumentException">
763
        The <paramref name="messageHeader"/> is not valid.
764
      </exception><exception cref="T:System.ArgumentException">
765
        <paramref name="consumeToAccept"/> may only be true if provided with a non-null <paramref name="source"/>.
766
      </exception>
767
        </member>
768
        <member name="M:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.Complete">
769
            <summary>
770
        Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
771
        nor produce any more messages nor consume any more postponed messages.
772
      </summary><remarks>
773
        After Complete has been called on a dataflow block, that block will complete
774
        (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
775
        available data. Complete will not block waiting for completion to occur, but rather will initiaite
776
        the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
777
      </remarks>
778
        </member>
779
        <member name="M:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
780
            <summary>
781
        Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a 
782
        <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
783
      </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
784
        The <paramref name="exception"/> is null (Nothing in Visual Basic).
785
      </exception><remarks>
786
        After Fault has been called on a dataflow block, that block will complete
787
        (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes 
788
        buffered messages (uprocessed input messages as well as unoffered output messages) to be lost. 
789
      </remarks>
790
        </member>
791
        <member name="P:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.Count">
792
            <summary>Gets the number of messages buffered in this target.</summary>
793
        </member>
794
        <member name="P:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Completion">
795
            <summary>
796
        Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
797
      </summary><remarks>
798
        A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
799
        any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
800
        associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
801
        when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
802
        the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
803
        and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow  block has completed processing
804
        prematurely due to receiving a cancellation request.  If the task completes in the Faulted state, its Exception property will return
805
        an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
806
      </remarks>
807
        </member>
808
        <member name="P:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.DebuggerDisplayContent">
809
            <summary>The data to display in the debugger display attribute.</summary>
810
        </member>
811
        <member name="P:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
812
            <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
813
        </member>
814
        <member name="T:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.DebugView">
815
            <summary>Provides a debugger type proxy for the Transform.</summary>
816
        </member>
817
        <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.DebugView.m_batchedJoinBlockTarget">
818
            <summary>The batched join block target being viewed.</summary>
819
        </member>
820
        <member name="M:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.DebugView.#ctor(System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget{`0})">
821
            <summary>Initializes the debug view.</summary>
822
            <param name="batchedJoinBlockTarget">The batched join target being viewed.</param>
823
        </member>
824
        <member name="P:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.DebugView.InputQueue">
825
            <summary>Gets the messages waiting to be processed.</summary>
826
        </member>
827
        <member name="P:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.DebugView.IsDecliningPermanently">
828
            <summary>Gets whether the block is declining further messages.</summary>
829
        </member>
830
        <member name="T:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources">
831
            <summary>Provides a container for resources shared across all targets used by the same BatchedJoinBlock instance.</summary>
832
        </member>
833
        <member name="M:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources.#ctor(System.Int32,System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions,System.Action,System.Action,System.Action{System.Exception},System.Action)">
834
            <summary>Initializes the shared resources.</summary>
835
            <param name="batchSize">The size of a batch to create.</param>
836
            <param name="dataflowBlockOptions">The options used to configur the shared resources.  Assumed to be immutable.</param>
837
            <param name="batchSizeReachedAction">The action to invoke when a batch is completed.</param>
838
            <param name="allTargetsDecliningAction">The action to invoke when no more targets are accepting input.</param>
839
            <param name="exceptionAction">The action to invoke when an exception needs to be logged.</param>
840
            <param name="completionAction">The action to invoke when completing, typically invoked due to a call to Fault.</param>
841
        </member>
842
        <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources.m_incomingLock">
843
            <summary>
844
            A lock used to synchronize all incoming messages on all targets. It protects all of the rest 
845
            of the shared resource's state and will be held while invoking the delegates.
846
            </summary>
847
        </member>
848
        <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources.m_batchSize">
849
            <summary>The size of the batches to generate.</summary>
850
        </member>
851
        <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources.m_batchSizeReachedAction">
852
            <summary>The action to invoke when enough elements have been accumulated to make a batch.</summary>
853
        </member>
854
        <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources.m_allTargetsDecliningPermanentlyAction">
855
            <summary>The action to invoke when all targets are declining further messages.</summary>
856
        </member>
857
        <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources.m_exceptionAction">
858
            <summary>The action to invoke when an exception has to be logged.</summary>
859
        </member>
860
        <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources.m_completionAction">
861
            <summary>The action to invoke when the owning block has to be completed.</summary>
862
        </member>
863
        <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources.m_remainingItemsInBatch">
864
            <summary>The number of items remaining to form a batch.</summary>
865
        </member>
866
        <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources.m_remainingAliveTargets">
867
            <summary>The number of targets still alive (i.e. not declining all further messages).</summary>
868
        </member>
869
        <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources.m_decliningPermanently">
870
            <summary>Whether all targets should decline all further messages.</summary>
871
        </member>
872
        <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources.m_batchesCreated">
873
            <summary>The number of batches created.</summary>
874
        </member>
875
        <member name="T:System.Threading.Tasks.Dataflow.Internal.SourceCore`1">
876
            <summary>Provides a core implementation for blocks that implement <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.</summary>
877
            <typeparam name="TOutput">Specifies the type of data supplied by the <see cref="T:System.Threading.Tasks.Dataflow.Internal.SourceCore`1"/>.</typeparam>
878
        </member>
879
        <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_completionTask">
880
            <summary>A TaskCompletionSource that represents the completion of this block.</summary>
881
        </member>
882
        <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_targetRegistry">
883
            <summary>A registry used to store all linked targets and information about them.</summary>
884
        </member>
885
        <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_messages">
886
            <summary>All of the output messages queued up to be received by consumers/targets.</summary>
887
        </member>
888
        <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_executionContext">
889
            <summary>The execution context captured when this block was instantiated.</summary>
890
        </member>
891
        <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_owningSource">
892
            <summary>The source utilizing this helper.</summary>
893
        </member>
894
        <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_dataflowBlockOptions">
895
            <summary>The options used to configure this block's execution.</summary>
896
        </member>
897
        <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_completeAction">
898
            <summary>
899
            An action to be invoked on the owner block to stop accepting messages.
900
            This action is invoked when SourceCore encounters an exception.
901
            </summary>
902
        </member>
903
        <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_itemsRemovedAction">
904
            <summary>
905
            An action to be invoked on the owner block when an item is removed.
906
            This may be null if the owner block doesn't need to be notified.
907
            </summary>
908
        </member>
909
        <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_itemCountingFunc">
910
            <summary>Item counting function</summary>
911
        </member>
912
        <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_taskForOutputProcessing">
913
            <summary>The task used to process the output and offer it to targets.</summary>
914
        </member>
915
        <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_nextMessageId">
916
            <summary>Counter for message IDs unique within this source block.</summary>
917
        </member>
918
        <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_nextMessageReservedFor">
919
            <summary>The target that the next message is reserved for, or null if nothing is reserved.</summary>
920
        </member>
921
        <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_decliningPermanently">
922
            <summary>Whether all future messages should be declined.</summary>
923
        </member>
924
        <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_enableOffering">
925
            <summary>Whether this block should again attempt to offer messages to targets.</summary>
926
        </member>
927
        <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_completionReserved">
928
            <summary>Whether someone has reserved the right to call CompleteBlockOncePossible.</summary>
929
        </member>
930
        <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_exceptions">
931
            <summary>Exceptions that may have occured and gone unhandled during processing.</summary>
932
            <remarks>
933
            Marked volatile because we compare the m_exceptions reference to null while not under a lock,
934
            but we manipulate it elsewhere (e.g. initializing it to non-null) while holding a lock.
935
            </remarks>
936
        </member>
937
        <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.#ctor(System.Threading.Tasks.Dataflow.ISourceBlock{`0},System.Threading.Tasks.Dataflow.DataflowBlockOptions,System.Action{System.Threading.Tasks.Dataflow.ISourceBlock{`0}},System.Action{System.Threading.Tasks.Dataflow.ISourceBlock{`0},System.Int32},System.Func{System.Threading.Tasks.Dataflow.ISourceBlock{`0},`0,System.Collections.Generic.IList{`0},System.Int32})">
938
            <summary>Initializes the source core.</summary>
939
            <param name="owningSource">The source utilizing this core.</param>
940
            <param name="dataflowBlockOptions">The options to use to configure the block.</param>
941
            <param name="completeAction">Action to invoke in order to decline the associated target half, which will in turn decline this source core.</param>
942
            <param name="itemsRemovedAction">Action to invoke when one or more items is removed.  This may be null.</param>
943
            <param name="itemCountingFunc">
944
            Action to invoke when the owner needs to be able to count the number of individual
945
            items in an output or set of outputs.
946
            </param>
947
        </member>
948
        <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.LinkTo(System.Threading.Tasks.Dataflow.ITargetBlock{`0},System.Boolean)">
949
            <summary>
950
        Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.
951
      </summary><param name="target">
952
        The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect this source.
953
      </param><param name="unlinkAfterOne">
954
        true if the source should unlink from the target after successfully propagating a single message; 
955
        otherwise, false to remain connected even after a single message has been propagated.
956
      </param><returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns><exception cref="T:System.ArgumentNullException">
957
        The <paramref name="target"/> is null (Nothing in Visual Basic).
958
      </exception>
959
        </member>
960
        <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.ConsumeMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0},System.Boolean@)">
961
            <summary>
962
        Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to accept and consume a  
963
        <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> previously offered by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
964
      </summary><param name="messageHeader">The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being consumed.</param><param name="target">
965
        The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> consuming the message.
966
      </param><param name="messageConsumed">
967
        True if the message was successfully consumed. False otherwise.
968
      </param><returns>
969
        <para>
970
          The value of the consumed message. This may correspond to a different <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance than was previously reserved and
971
          passed as the <paramref name="messageHeader"/> to <see cref="M:ConsumeMessage"/>. The consuming <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must 
972
          use the returned value instead of the value passed as messageValue through <see cref="M:OfferMessage"/>.
973
        </para>
974
        <para>
975
          If the message requested is not available, the return value will be null (Nothing in Visual Basic).
976
        </para>
977
      </returns><exception cref="T:System.ArgumentException">
978
        The <paramref name="messageHeader"/> is not valid.
979
      </exception><exception cref="T:System.ArgumentNullException">
980
        The <paramref name="target"/> is null (Nothing in Visual Basic).
981
      </exception><remarks>
982
        <para>
983
          Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> 
984
          instance may use <see cref="M:ConsumeMessage"/>, and it must only be used
985
          to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously 
986
          offered by this source to the target.
987
        </para>
988
      </remarks>
989
        </member>
990
        <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.ReserveMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
991
            <summary>
992
        Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to reserve a previously offered <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> 
993
        by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
994
      </summary><param name="messageHeader">
995
        The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being reserved.
996
      </param><param name="target">
997
        The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> reserving the message.
998
      </param><returns>true if the message was successfully reserved; otherwise, false.</returns><exception cref="T:System.ArgumentException">
999
        The <paramref name="messageHeader"/> is not valid.
1000
      </exception><exception cref="T:System.ArgumentNullException">
1001
        The <paramref name="target"/> is null (Nothing in Visual Basic).
1002
      </exception><remarks>
1003
        <para>
1004
          Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> instance 
1005
          may use <see cref="M:ReserveMessage"/>, and it must only be used
1006
          to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously 
1007
          offered by this source to the target.
1008
        </para>
1009
        <para>
1010
          If true is returned, the <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must subsequently call either <see cref="M:ConsumeMessage"/> or <see cref="M:ReserveMessage"/> for this message.
1011
          Failure to do so may result in the source being unable to propagate any further messages to this or other targets.
1012
        </para>
1013
        <para>
1014
          <see cref="M:ReserveMessage"/> must not be called while the target is holding any internal locks.  Doing so will violate the lock hierarchy
1015
          necessary to avoid deadlocks in a dataflow network.
1016
        </para>
1017
      </remarks>
1018
        </member>
1019
        <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.ReleaseReservation(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
1020
            <summary>
1021
        Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to release a previously reserved 
1022
        <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
1023
      </summary><param name="messageHeader">
1024
        The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the reserved message being released.
1025
      </param><param name="target">
1026
        The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> releasing the message it previously reserved.
1027
      </param><exception cref="T:System.ArgumentException">
1028
        The <paramref name="messageHeader"/> is not valid.
1029
      </exception><exception cref="T:System.ArgumentNullException">
1030
        The <paramref name="target"/> is null (Nothing in Visual Basic).
1031
      </exception><exception cref="T:System.InvalidOperationException">
1032
        The <paramref name="target"/> did not have the message reserved.
1033
      </exception><remarks>
1034
        <para>
1035
          Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> 
1036
          instance may use <see cref="M:ReleaseMessage"/>, and it must only be used
1037
          to release <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously 
1038
          and successfully reserved by the target.
1039
        </para>
1040
      </remarks>
1041
        </member>
1042
        <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.TryReceive(System.Predicate{`0},`0@)">
1043
            <summary>
1044
        Attempts to synchronously receive an available output item from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
1045
      </summary><param name="filter">
1046
        The predicate a value must successfully pass in order for it to be received. 
1047
        <paramref name="filter"/> may be null (Nothing in Visual Basic), in which case all items will pass.
1048
      </param><param name="item">The item received from the source.</param><returns>true if an item could be received; otherwise, false.</returns><remarks>
1049
        This method does not block waiting for the source to provide an item.
1050
        It will return after checking for an element, whether or not an element was available.
1051
      </remarks>
1052
        </member>
1053
        <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.TryReceiveAll(System.Collections.Generic.IList{`0}@)">
1054
            <summary>
1055
        Attempts to synchronously receive all available items from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
1056
      </summary><param name="items">The items received from the source.</param><returns>true if one or more items could be received; otherwise, false.</returns><remarks>
1057
        This method does not block waiting for the source to provide an item.
1058
        It will return after checking for elements, whether or not an element was available.
1059
      </remarks>
1060
        </member>
1061
        <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.AddMessage(`0)">
1062
            <summary>Adds a message to the source block for propagation.</summary>
1063
            <param name="item">The item to be wrapped in a message to be added.</param>
1064
        </member>
1065
        <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.AddMessages(System.Collections.Generic.IEnumerable{`0})">
1066
            <summary>Adds messages to the source block for propagation.</summary>
1067
            <param name="items">The list of items to be wrapped in messages to be added.</param>
1068
        </member>
1069
        <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.AddException(System.Exception)">
1070
            <summary>Adds an individual exceptionto this source.</summary>
1071
            <param name="exception">The exception to add</param>
1072
        </member>
1073
        <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.AddExceptions(System.Collections.Generic.List{System.Exception})">
1074
            <summary>Adds exceptions to this source.</summary>
1075
            <param name="exceptions">The exceptions to add</param>
1076
        </member>
1077
        <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.AddAndUnwrapAggregateException(System.AggregateException)">
1078
            <summary>Adds the exceptions contained in an AggregateException to this source.</summary>
1079
            <param name="aggregateException">The exception to add</param>
1080
        </member>
1081
        <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.Complete">
1082
            <summary>Informs the block that it will not be receiving additional messages.</summary>
1083
        </member>
1084
        <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.OfferToTargets(System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
1085
            <summary>Offers messages to all targets.</summary>
1086
            <param name="linkToTarget">
1087
            The newly linked target, if OfferToTargets is being called to synchronously
1088
            propagate to a target during a LinkTo operation.
1089
            </param>
1090
        </member>
1091
        <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.OfferMessageToTarget(System.Threading.Tasks.Dataflow.DataflowMessageHeader,`0,System.Threading.Tasks.Dataflow.ITargetBlock{`0},System.Boolean@)">
1092
            <summary>Offers the message to the target.</summary>
1093
            <param name="header">The header of the message to offer.</param>
1094
            <param name="message">The message being offered.</param>
1095
            <param name="target">The single target to which the message should be offered.</param>
1096
            <param name="messageWasAccepted">true if the message was accepted by the target; otherwise, false.</param>
1097
            <returns>
1098
            true if the message should not be offered to additional targets; 
1099
            false if propagation should be allowed to continue.
1100
            </returns>
1101
        </member>
1102
        <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.OfferAsyncIfNecessary(System.Boolean,System.Boolean)">
1103
            <summary>Called when we want to enable asynchronously offering message to targets.</summary>
1104
            <param name="isReplacementReplica">Whether this call is the continuation of a previous message loop.</param>
1105
            <param name="includeOutgoingOnlyChecks">Whether this call should include in "what's necessary" checks that require the outgoing lock.</param>
1106
        </member>
1107
        <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.OfferMessagesLoopWithExecutionContext">
1108
            <summary>Task body used to process messages under the right execution context.</summary>
1109
        </member>
1110
        <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.OfferMessagesLoopCore">
1111
            <summary>Task body used to process messages.</summary>
1112
        </member>
1113
        <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.CompleteBlockIfPossible">
1114
            <summary>Completes the block's processing if there's nothing left to do and never will be.</summary>
1115
        </member>
1116
        <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.CompleteBlockOncePossible">
1117
            <summary>
1118
            Completes the block.  This must only be called once, and only once all of the completion conditions are met.
1119
            As such, it must only be called from CompleteBlockIfPossible.
1120
            </summary>
1121
        </member>
1122
        <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.GetDebuggingInformation">
1123
            <summary>Gets information about this helper to be used for display in a debugger.</summary>
1124
            <returns>Debugging information about this source core.</returns>
1125
        </member>
1126
        <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.OutgoingLock">
1127
            <summary>Gets the object to use as the outgoing lock.</summary>
1128
        </member>
1129
        <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.ValueLock">
1130
            <summary>Gets the object to use as the value lock.</summary>
1131
        </member>
1132
        <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.Completion">
1133
            <summary>
1134
        Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
1135
      </summary><remarks>
1136
        A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
1137
        any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
1138
        associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
1139
        when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
1140
        the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
1141
        and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow  block has completed processing
1142
        prematurely due to receiving a cancellation request.  If the task completes in the Faulted state, its Exception property will return
1143
        an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
1144
      </remarks>
1145
        </member>
1146
        <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.OutputCount">
1147
            <summary>Gets the number of items available to be received from this block.</summary>
1148
        </member>
1149
        <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.CapturedContext">
1150
            <summary>Gets the execution context captured for this source core.</summary>
1151
        </member>
1152
        <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.HasExceptions">
1153
            <summary>Gets whether the m_exceptions list is non-null.</summary>
1154
        </member>
1155
        <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DataflowBlockOptions">
1156
            <summary>Gets the DataflowBlockOptions used to configure this block.</summary>
1157
        </member>
1158
        <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.CanceledOrFaulted">
1159
            <summary>Gets whether the source has had cancellation requested or an exception has occurred.</summary>
1160
        </member>
1161
        <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggerDisplayContent">
1162
            <summary>Gets the object to display in the debugger display attribute.</summary>
1163
        </member>
1164
        <member name="T:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggingInformation">
1165
            <summary>Provides debugging information about the source core.</summary>
1166
        </member>
1167
        <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggingInformation.m_source">
1168
            <summary>The source being viewed.</summary>
1169
        </member>
1170
        <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggingInformation.#ctor(System.Threading.Tasks.Dataflow.Internal.SourceCore{`0})">
1171
            <summary>Initializes the type proxy.</summary>
1172
            <param name="source">The source being viewed.</param>
1173
        </member>
1174
        <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggingInformation.OutputCount">
1175
            <summary>Gets the number of messages available for receiving.</summary>
1176
        </member>
1177
        <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggingInformation.OutputQueue">
1178
            <summary>Gets the messages available for receiving.</summary>
1179
        </member>
1180
        <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggingInformation.TaskForOutputProcessing">
1181
            <summary>Gets the task being used for output processing.</summary>
1182
        </member>
1183
        <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggingInformation.DataflowBlockOptions">
1184
            <summary>Gets the DataflowBlockOptions used to configure this block.</summary>
1185
        </member>
1186
        <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggingInformation.IsDecliningPermanently">
1187
            <summary>Gets whether the block is declining further messages.</summary>
1188
        </member>
1189
        <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggingInformation.IsCompleted">
1190
            <summary>Gets whether the block is completed.</summary>
1191
        </member>
1192
        <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggingInformation.LinkedTargets">
1193
            <summary>Gets the set of all targets linked from this block.</summary>
1194
        </member>
1195
        <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggingInformation.NextMessageReservedFor">
1196
            <summary>Gets the target that holds a reservation on the next message, if any.</summary>
1197
        </member>
1198
        <member name="T:System.Threading.Tasks.Dataflow.Internal.ActionOnDispose">
1199
            <summary>An IDisposable that will run an Action delegate when disposed.</summary>
1200
        </member>
1201
        <member name="F:System.Threading.Tasks.Dataflow.Internal.ActionOnDispose.s_empty">
1202
            <summary>An IDisposable that does nothing.</summary>
1203
        </member>
1204
        <member name="F:System.Threading.Tasks.Dataflow.Internal.ActionOnDispose.m_disposeDelegate">
1205
            <summary>The action to run when disposed.</summary>
1206
        </member>
1207
        <member name="F:System.Threading.Tasks.Dataflow.Internal.ActionOnDispose.m_state">
1208
            <summary>Optional state to be passed to the dispose delegate.</summary>
1209
        </member>
1210
        <member name="M:System.Threading.Tasks.Dataflow.Internal.ActionOnDispose.#ctor(System.Action{System.Object},System.Object)">
1211
            <summary>Initializes the ActionOnDispose.</summary>
1212
            <param name="actionWithState">The action to run when disposed.</param>
1213
            <param name="state">State to pass to the action when it's invoked.</param>
1214
        </member>
1215
        <member name="M:System.Threading.Tasks.Dataflow.Internal.ActionOnDispose.System#IDisposable#Dispose">
1216
            <summary>Invoke the action.</summary>
1217
        </member>
1218
        <member name="P:System.Threading.Tasks.Dataflow.Internal.ActionOnDispose.Empty">
1219
            <summary>Gets an IDisposable that does nothing.</summary>
1220
        </member>
1221
        <member name="P:System.Threading.Tasks.Dataflow.Internal.ActionOnDispose.Disposed">
1222
            <summary>Gets whether the IDisposable has been disposed.</summary>
1223
        </member>
1224
        <member name="T:System.Threading.Tasks.Dataflow.TransformBlock`2">
1225
            <summary>Provides a dataflow block that invokes a provided <see cref="T:System.Func`2"/> delegate for every data element received.</summary>
1226
            <typeparam name="TInput">Specifies the type of data received and operated on by this <see cref="T:System.Threading.Tasks.Dataflow.TransformBlock`2"/>.</typeparam>
1227
            <typeparam name="TOutput">Specifies the type of data output by this <see cref="T:System.Threading.Tasks.Dataflow.TransformBlock`2"/>.</typeparam>
1228
        </member>
1229
        <member name="T:System.Threading.Tasks.Dataflow.IPropagatorBlock`2">
1230
            <summary>Represents a dataflow block that is both a target for data and a source of data.</summary>
1231
            <typeparam name="TInput">Specifies the type of data accepted by the <see cref="T:System.Threading.Tasks.Dataflow.IPropagatorBlock`2"/>.</typeparam>
1232
            <typeparam name="TOutput">Specifies the type of data supplied by the <see cref="T:System.Threading.Tasks.Dataflow.IPropagatorBlock`2"/>.</typeparam>
1233
        </member>
1234
        <member name="F:System.Threading.Tasks.Dataflow.TransformBlock`2.m_target">
1235
            <summary>The target side.</summary>
1236
        </member>
1237
        <member name="F:System.Threading.Tasks.Dataflow.TransformBlock`2.m_reorderingBuffer">
1238
            <summary>Buffer used to reorder outputs that may have completed out-of-order between the target half and the source half.</summary>
1239
        </member>
1240
        <member name="F:System.Threading.Tasks.Dataflow.TransformBlock`2.m_source">
1241
            <summary>The source side.</summary>
1242
        </member>
1243
        <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.#ctor(System.Func{`0,`1})">
1244
            <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.TransformBlock`2"/> with the specified <see cref="T:System.Func`2"/>.</summary>
1245
            <param name="transform">The function to invoke with each data element received.</param>
1246
            <exception cref="T:System.ArgumentNullException">The <paramref name="transform"/> is null (Nothing in Visual Basic).</exception>
1247
        </member>
1248
        <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.#ctor(System.Func{`0,`1},System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions)">
1249
            <summary>
1250
            Initializes the <see cref="T:System.Threading.Tasks.Dataflow.TransformBlock`2"/> with the specified <see cref="T:System.Func`2"/> and 
1251
            <see cref="T:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions"/>.
1252
            </summary>
1253
            <param name="transform">The function to invoke with each data element received.</param>
1254
            <param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.TransformBlock`2"/>.</param>
1255
            <exception cref="T:System.ArgumentNullException">The <paramref name="transform"/> is null (Nothing in Visual Basic).</exception>
1256
            <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
1257
        </member>
1258
        <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.#ctor(System.Func{`0,System.Threading.Tasks.Task{`1}})">
1259
            <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.TransformBlock`2"/> with the specified <see cref="T:System.Func`2"/>.</summary>
1260
            <param name="transform">The function to invoke with each data element received.</param>
1261
            <exception cref="T:System.ArgumentNullException">The <paramref name="transform"/> is null (Nothing in Visual Basic).</exception>
1262
        </member>
1263
        <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.#ctor(System.Func{`0,System.Threading.Tasks.Task{`1}},System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions)">
1264
            <summary>
1265
            Initializes the <see cref="T:System.Threading.Tasks.Dataflow.TransformBlock`2"/> with the specified <see cref="T:System.Func`2"/>
1266
            and <see cref="T:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions"/>.
1267
            </summary>
1268
            <param name="transform">The function to invoke with each data element received.</param>
1269
            <param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.TransformBlock`2"/>.</param>
1270
            <exception cref="T:System.ArgumentNullException">The <paramref name="transform"/> is null (Nothing in Visual Basic).</exception>
1271
            <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
1272
        </member>
1273
        <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.#ctor(System.Delegate,System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions)">
1274
            <summary>
1275
            Initializes the <see cref="T:System.Threading.Tasks.Dataflow.TransformBlock`2"/> with the specified <see cref="T:System.Func`2"/> 
1276
            and <see cref="T:System.Threading.Tasks.Dataflow.DataflowBlockOptions"/>.
1277
            </summary>
1278
            <param name="transform">The function to invoke with each data element received.</param>
1279
            <param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.TransformBlock`2"/>.</param>
1280
            <exception cref="T:System.ArgumentNullException">The <paramref name="transform"/> is null (Nothing in Visual Basic).</exception>
1281
            <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
1282
        </member>
1283
        <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.ProcessMessage(System.Func{`0,`1},System.Collections.Generic.KeyValuePair{`0,System.Int64})">
1284
            <summary>Processes the message with a user-provided transform function that returns a TOutput.</summary>
1285
            <param name="transform">The transform function to use to process the message.</param>
1286
            <param name="messageWithId">The message to be processed.</param>
1287
        </member>
1288
        <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.ProcessMessageWithTask(System.Func{`0,System.Threading.Tasks.Task{`1}},System.Collections.Generic.KeyValuePair{`0,System.Int64})">
1289
            <summary>Processes the message with a user-provided transform function that returns a task of TOutput.</summary>
1290
            <param name="transform">The transform function to use to process the message.</param>
1291
            <param name="messageWithId">The message to be processed.</param>
1292
        </member>
1293
        <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.AsyncCompleteProcessMessageWithTask(System.Threading.Tasks.Task{`1},System.Collections.Generic.KeyValuePair{`0,System.Int64})">
1294
            <summary>Completes the processing of an asynchronous message.</summary>
1295
            <param name="completed">The completed task storing the output data generated for an input message.</param>
1296
            <param name="messageWithId">The originating message</param>
1297
        </member>
1298
        <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.Complete">
1299
            <summary>
1300
        Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
1301
        nor produce any more messages nor consume any more postponed messages.
1302
      </summary><remarks>
1303
        After Complete has been called on a dataflow block, that block will complete
1304
        (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
1305
        available data. Complete will not block waiting for completion to occur, but rather will initiaite
1306
        the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
1307
      </remarks>
1308
        </member>
1309
        <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
1310
            <summary>
1311
        Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a 
1312
        <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
1313
      </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
1314
        The <paramref name="exception"/> is null (Nothing in Visual Basic).
1315
      </exception><remarks>
1316
        After Fault has been called on a dataflow block, that block will complete
1317
        (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes 
1318
        buffered messages (uprocessed input messages as well as unoffered output messages) to be lost. 
1319
      </remarks>
1320
        </member>
1321
        <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.LinkTo(System.Threading.Tasks.Dataflow.ITargetBlock{`1},System.Boolean)">
1322
            <summary>
1323
        Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.
1324
      </summary><param name="target">
1325
        The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect this source.
1326
      </param><param name="unlinkAfterOne">
1327
        true if the source should unlink from the target after successfully propagating a single message; 
1328
        otherwise, false to remain connected even after a single message has been propagated.
1329
      </param><returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns><exception cref="T:System.ArgumentNullException">
1330
        The <paramref name="target"/> is null (Nothing in Visual Basic).
1331
      </exception>
1332
        </member>
1333
        <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.TryReceive(System.Predicate{`1},`1@)">
1334
            <summary>
1335
        Attempts to synchronously receive an available output item from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
1336
      </summary><param name="filter">
1337
        The predicate a value must successfully pass in order for it to be received. 
1338
        <paramref name="filter"/> may be null (Nothing in Visual Basic), in which case all items will pass.
1339
      </param><param name="item">The item received from the source.</param><returns>true if an item could be received; otherwise, false.</returns><remarks>
1340
        This method does not block waiting for the source to provide an item.
1341
        It will return after checking for an element, whether or not an element was available.
1342
      </remarks>
1343
        </member>
1344
        <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.TryReceiveAll(System.Collections.Generic.IList{`1}@)">
1345
            <summary>
1346
        Attempts to synchronously receive all available items from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
1347
      </summary><param name="items">The items received from the source.</param><returns>true if one or more items could be received; otherwise, false.</returns><remarks>
1348
        This method does not block waiting for the source to provide an item.
1349
        It will return after checking for elements, whether or not an element was available.
1350
      </remarks>
1351
        </member>
1352
        <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.System#Threading#Tasks#Dataflow#ITargetBlock{TInput}#OfferMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,`0,System.Threading.Tasks.Dataflow.ISourceBlock{`0},System.Boolean)">
1353
            <summary>
1354
        Offers a message to the <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>, giving the target the opportunity to consume or postpone the message.
1355
      </summary><param name="messageHeader">
1356
        A <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance that represents the header of the message being offered.
1357
      </param><param name="messageValue">
1358
        The value of the message being offered.
1359
      </param><param name="source">
1360
        The <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> offering the message. This may be null (Nothing in Visual Basic).
1361
      </param><param name="consumeToAccept">
1362
        true if the target must call ConsumeMessage synchronously during the call to OfferMessage, prior to returning
1363
        <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Accepted"/>, in order to consume the message.
1364
        false if the target wanting to accept the message should not call ConsumeMessage, and should isntead simply return DataflowMessageStatus.Accepted.
1365
      </param><returns>
1366
        The status of the offered message. If the message was accepted by the target, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Accepted"/> is returned, and the source should
1367
        no longer use the offered message, as it is now owned by the target. If the message was postponed by the target, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Postponed"/> is returned
1368
        as a notification that the target may later attempt to consume or reserve the message; in the meantime, the source still owns the message and may offer it to other blocks.
1369
        If the target would have otherwise postponed but source was null, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is instead returned. 
1370
        If the target tried to accept the message but missed it due to the source delivering the message to another target or simply discarding it, 
1371
        <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.NotAvailable"/> is returned.
1372
        If the target chose not to accept the message, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is returned.  If the target
1373
        chose not to accept the message and will never accept another message from this source, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.DecliningPermanently"/> is returned.
1374
      </returns><exception cref="T:System.ArgumentException">
1375
        The <paramref name="messageHeader"/> is not valid.
1376
      </exception><exception cref="T:System.ArgumentException">
1377
        <paramref name="consumeToAccept"/> may only be true if provided with a non-null <paramref name="source"/>.
1378
      </exception>
1379
        </member>
1380
        <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.System#Threading#Tasks#Dataflow#ISourceBlock{TOutput}#ConsumeMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`1},System.Boolean@)">
1381
            <summary>
1382
        Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to accept and consume a  
1383
        <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> previously offered by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
1384
      </summary><param name="messageHeader">The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being consumed.</param><param name="target">
1385
        The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> consuming the message.
1386
      </param><param name="messageConsumed">
1387
        True if the message was successfully consumed. False otherwise.
1388
      </param><returns>
1389
        <para>
1390
          The value of the consumed message. This may correspond to a different <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance than was previously reserved and
1391
          passed as the <paramref name="messageHeader"/> to <see cref="M:ConsumeMessage"/>. The consuming <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must 
1392
          use the returned value instead of the value passed as messageValue through <see cref="M:OfferMessage"/>.
1393
        </para>
1394
        <para>
1395
          If the message requested is not available, the return value will be null (Nothing in Visual Basic).
1396
        </para>
1397
      </returns><exception cref="T:System.ArgumentException">
1398
        The <paramref name="messageHeader"/> is not valid.
1399
      </exception><exception cref="T:System.ArgumentNullException">
1400
        The <paramref name="target"/> is null (Nothing in Visual Basic).
1401
      </exception><remarks>
1402
        <para>
1403
          Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> 
1404
          instance may use <see cref="M:ConsumeMessage"/>, and it must only be used
1405
          to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously 
1406
          offered by this source to the target.
1407
        </para>
1408
      </remarks>
1409
        </member>
1410
        <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.System#Threading#Tasks#Dataflow#ISourceBlock{TOutput}#ReserveMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`1})">
1411
            <summary>
1412
        Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to reserve a previously offered <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> 
1413
        by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
1414
      </summary><param name="messageHeader">
1415
        The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being reserved.
1416
      </param><param name="target">
1417
        The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> reserving the message.
1418
      </param><returns>true if the message was successfully reserved; otherwise, false.</returns><exception cref="T:System.ArgumentException">
1419
        The <paramref name="messageHeader"/> is not valid.
1420
      </exception><exception cref="T:System.ArgumentNullException">
1421
        The <paramref name="target"/> is null (Nothing in Visual Basic).
1422
      </exception><remarks>
1423
        <para>
1424
          Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> instance 
1425
          may use <see cref="M:ReserveMessage"/>, and it must only be used
1426
          to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously 
1427
          offered by this source to the target.
1428
        </para>
1429
        <para>
1430
          If true is returned, the <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must subsequently call either <see cref="M:ConsumeMessage"/> or <see cref="M:ReserveMessage"/> for this message.
1431
          Failure to do so may result in the source being unable to propagate any further messages to this or other targets.
1432
        </para>
1433
        <para>
1434
          <see cref="M:ReserveMessage"/> must not be called while the target is holding any internal locks.  Doing so will violate the lock hierarchy
1435
          necessary to avoid deadlocks in a dataflow network.
1436
        </para>
1437
      </remarks>
1438
        </member>
1439
        <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.System#Threading#Tasks#Dataflow#ISourceBlock{TOutput}#ReleaseReservation(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`1})">
1440
            <summary>
1441
        Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to release a previously reserved 
1442
        <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
1443
      </summary><param name="messageHeader">
1444
        The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the reserved message being released.
1445
      </param><param name="target">
1446
        The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> releasing the message it previously reserved.
1447
      </param><exception cref="T:System.ArgumentException">
1448
        The <paramref name="messageHeader"/> is not valid.
1449
      </exception><exception cref="T:System.ArgumentNullException">
1450
        The <paramref name="target"/> is null (Nothing in Visual Basic).
1451
      </exception><exception cref="T:System.InvalidOperationException">
1452
        The <paramref name="target"/> did not have the message reserved.
1453
      </exception><remarks>
1454
        <para>
1455
          Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> 
1456
          instance may use <see cref="M:ReleaseMessage"/>, and it must only be used
1457
          to release <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously 
1458
          and successfully reserved by the target.
1459
        </para>
1460
      </remarks>
1461
        </member>
1462
        <member name="P:System.Threading.Tasks.Dataflow.TransformBlock`2.Completion">
1463
            <summary>
1464
        Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
1465
      </summary><remarks>
1466
        A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
1467
        any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
1468
        associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
1469
        when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
1470
        the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
1471
        and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow  block has completed processing
1472
        prematurely due to receiving a cancellation request.  If the task completes in the Faulted state, its Exception property will return
1473
        an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
1474
      </remarks>
1475
        </member>
1476
        <member name="P:System.Threading.Tasks.Dataflow.TransformBlock`2.InputCount">
1477
            <summary>
1478
        Gets the number of input items waiting to be processed by this block.
1479
      </summary><remarks>
1480
        The InputCount does not include any items currently being processed by the block or any items that 
1481
        have already been processed by the block.
1482
      </remarks>
1483
        </member>
1484
        <member name="P:System.Threading.Tasks.Dataflow.TransformBlock`2.OutputCount">
1485
            <summary>
... This diff was truncated because it exceeds the maximum size that can be displayed.

Also available in: Unified diff