1 <?xml version="1.0"?>
\r
4 <name>System.Threading.Tasks.Dataflow</name>
\r
7 <member name="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2">
\r
9 Provides a dataflow block that batches a specified number of inputs of potentially differing types
\r
10 provided to one or more of its targets.
\r
12 <typeparam name="T1">Specifies the type of data accepted by the block's first target.</typeparam>
\r
13 <typeparam name="T2">Specifies the type of data accepted by the block's second target.</typeparam>
\r
15 <member name="T:System.Threading.Tasks.Dataflow.IReceivableSourceBlock`1">
\r
16 <summary>Represents a dataflow block that supports receiving of messages without linking.</summary>
\r
17 <typeparam name="TOutput">Specifies the type of data supplied by the <see cref="T:System.Threading.Tasks.Dataflow.IReceivableSourceBlock`1"/>.</typeparam>
\r
19 <member name="T:System.Threading.Tasks.Dataflow.ISourceBlock`1">
\r
20 <summary>Represents a dataflow block that is a source of data.</summary>
\r
21 <typeparam name="TOutput">Specifies the type of data supplied by the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.</typeparam>
\r
23 <member name="T:System.Threading.Tasks.Dataflow.IDataflowBlock">
\r
24 <summary>Represents a dataflow block.</summary>
\r
26 <member name="M:System.Threading.Tasks.Dataflow.IDataflowBlock.Complete">
\r
28 Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
\r
29 nor produce any more messages nor consume any more postponed messages.
\r
31 After Complete has been called on a dataflow block, that block will complete
\r
32 (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
\r
33 available data. Complete will not block waiting for completion to occur, but rather will initiaite
\r
34 the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
\r
37 <member name="M:System.Threading.Tasks.Dataflow.IDataflowBlock.Fault(System.Exception)">
\r
39 Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a
\r
40 <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
\r
41 </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
\r
42 The <paramref name="exception"/> is null (Nothing in Visual Basic).
\r
43 </exception><remarks>
\r
44 After Fault has been called on a dataflow block, that block will complete
\r
45 (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes
\r
46 buffered messages (uprocessed input messages as well as unoffered output messages) to be lost.
\r
49 <member name="P:System.Threading.Tasks.Dataflow.IDataflowBlock.Completion">
\r
51 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
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
\r
54 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
55 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
56 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
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,
\r
58 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
59 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
60 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
63 <member name="M:System.Threading.Tasks.Dataflow.ISourceBlock`1.LinkTo(System.Threading.Tasks.Dataflow.ITargetBlock{`0},System.Boolean)">
\r
65 Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.
\r
66 </summary><param name="target">
\r
67 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect this source.
\r
68 </param><param name="unlinkAfterOne">
\r
69 true if the source should unlink from the target after successfully propagating a single message;
\r
70 otherwise, false to remain connected even after a single message has been propagated.
\r
71 </param><returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns><exception cref="T:System.ArgumentNullException">
\r
72 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
75 <member name="M:System.Threading.Tasks.Dataflow.ISourceBlock`1.ConsumeMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0},System.Boolean@)">
\r
77 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to accept and consume a
\r
78 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> previously offered by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
79 </summary><param name="messageHeader">The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being consumed.</param><param name="target">
\r
80 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> consuming the message.
\r
81 </param><param name="messageConsumed">
\r
82 True if the message was successfully consumed. False otherwise.
\r
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
\r
86 passed as the <paramref name="messageHeader"/> to <see cref="M:ConsumeMessage"/>. The consuming <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must
\r
87 use the returned value instead of the value passed as messageValue through <see cref="M:OfferMessage"/>.
\r
90 If the message requested is not available, the return value will be null (Nothing in Visual Basic).
\r
92 </returns><exception cref="T:System.ArgumentException">
\r
93 The <paramref name="messageHeader"/> is not valid.
\r
94 </exception><exception cref="T:System.ArgumentNullException">
\r
95 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
96 </exception><remarks>
\r
98 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
99 instance may use <see cref="M:ConsumeMessage"/>, and it must only be used
\r
100 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
101 offered by this source to the target.
\r
105 <member name="M:System.Threading.Tasks.Dataflow.ISourceBlock`1.ReserveMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
\r
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"/>
\r
108 by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
109 </summary><param name="messageHeader">
\r
110 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being reserved.
\r
111 </param><param name="target">
\r
112 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> reserving the message.
\r
113 </param><returns>true if the message was successfully reserved; otherwise, false.</returns><exception cref="T:System.ArgumentException">
\r
114 The <paramref name="messageHeader"/> is not valid.
\r
115 </exception><exception cref="T:System.ArgumentNullException">
\r
116 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
117 </exception><remarks>
\r
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
\r
120 may use <see cref="M:ReserveMessage"/>, and it must only be used
\r
121 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
122 offered by this source to the target.
\r
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.
\r
126 Failure to do so may result in the source being unable to propagate any further messages to this or other targets.
\r
129 <see cref="M:ReserveMessage"/> must not be called while the target is holding any internal locks. Doing so will violate the lock hierarchy
\r
130 necessary to avoid deadlocks in a dataflow network.
\r
134 <member name="M:System.Threading.Tasks.Dataflow.ISourceBlock`1.ReleaseReservation(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
\r
136 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to release a previously reserved
\r
137 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
138 </summary><param name="messageHeader">
\r
139 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the reserved message being released.
\r
140 </param><param name="target">
\r
141 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> releasing the message it previously reserved.
\r
142 </param><exception cref="T:System.ArgumentException">
\r
143 The <paramref name="messageHeader"/> is not valid.
\r
144 </exception><exception cref="T:System.ArgumentNullException">
\r
145 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
146 </exception><exception cref="T:System.InvalidOperationException">
\r
147 The <paramref name="target"/> did not have the message reserved.
\r
148 </exception><remarks>
\r
150 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
151 instance may use <see cref="M:ReleaseMessage"/>, and it must only be used
\r
152 to release <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
153 and successfully reserved by the target.
\r
157 <member name="M:System.Threading.Tasks.Dataflow.IReceivableSourceBlock`1.TryReceive(System.Predicate{`0},`0@)">
\r
159 Attempts to synchronously receive an available output item from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
160 </summary><param name="filter">
\r
161 The predicate a value must successfully pass in order for it to be received.
\r
162 <paramref name="filter"/> may be null (Nothing in Visual Basic), in which case all items will pass.
\r
163 </param><param name="item">The item received from the source.</param><returns>true if an item could be received; otherwise, false.</returns><remarks>
\r
164 This method does not block waiting for the source to provide an item.
\r
165 It will return after checking for an element, whether or not an element was available.
\r
168 <member name="M:System.Threading.Tasks.Dataflow.IReceivableSourceBlock`1.TryReceiveAll(System.Collections.Generic.IList{`0}@)">
\r
170 Attempts to synchronously receive all available items from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
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>
\r
172 This method does not block waiting for the source to provide an item.
\r
173 It will return after checking for elements, whether or not an element was available.
\r
176 <member name="T:System.Threading.Tasks.Dataflow.Internal.IDebuggerDisplay">
\r
177 <summary>Implemented to provide customizable data for debugger displays.</summary>
\r
179 <member name="P:System.Threading.Tasks.Dataflow.Internal.IDebuggerDisplay.Content">
\r
180 <summary>The object to be displayed as the content of a DebuggerDisplayAttribute.</summary>
\r
182 The property returns an object to allow the debugger to interpret arbitrary .NET objects.
\r
183 The return value may be, but need not be limited to be, a string.
\r
186 <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.m_batchSize">
\r
187 <summary>The size of the batches generated by this BatchedJoin.</summary>
\r
189 <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.m_sharedResources">
\r
190 <summary>State shared among the targets.</summary>
\r
192 <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.m_target1">
\r
193 <summary>The target providing inputs of type T1.</summary>
\r
195 <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.m_target2">
\r
196 <summary>The target providing inputs of type T2.</summary>
\r
198 <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.m_source">
\r
199 <summary>The source side.</summary>
\r
201 <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.#ctor(System.Int32)">
\r
202 <summary>Initializes this <see cref="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2"/> with the specified configuration.</summary>
\r
203 <param name="batchSize">The number of items to group into a batch.</param>
\r
204 <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="batchSize"/> must be positive.</exception>
\r
206 <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.#ctor(System.Int32,System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions)">
\r
207 <summary>Initializes this <see cref="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2"/> with the specified configuration.</summary>
\r
208 <param name="batchSize">The number of items to group into a batch.</param>
\r
209 <param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2"/>.</param>
\r
210 <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="batchSize"/> must be positive.</exception>
\r
211 <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
\r
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)">
\r
215 Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.
\r
216 </summary><param name="target">
\r
217 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect this source.
\r
218 </param><param name="unlinkAfterOne">
\r
219 true if the source should unlink from the target after successfully propagating a single message;
\r
220 otherwise, false to remain connected even after a single message has been propagated.
\r
221 </param><returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns><exception cref="T:System.ArgumentNullException">
\r
222 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
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}}@)">
\r
227 Attempts to synchronously receive an available output item from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
228 </summary><param name="filter">
\r
229 The predicate a value must successfully pass in order for it to be received.
\r
230 <paramref name="filter"/> may be null (Nothing in Visual Basic), in which case all items will pass.
\r
231 </param><param name="item">The item received from the source.</param><returns>true if an item could be received; otherwise, false.</returns><remarks>
\r
232 This method does not block waiting for the source to provide an item.
\r
233 It will return after checking for an element, whether or not an element was available.
\r
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}}}@)">
\r
238 Attempts to synchronously receive all available items from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
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>
\r
240 This method does not block waiting for the source to provide an item.
\r
241 It will return after checking for elements, whether or not an element was available.
\r
244 <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.Complete">
\r
246 Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
\r
247 nor produce any more messages nor consume any more postponed messages.
\r
248 </summary><remarks>
\r
249 After Complete has been called on a dataflow block, that block will complete
\r
250 (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
\r
251 available data. Complete will not block waiting for completion to occur, but rather will initiaite
\r
252 the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
\r
255 <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
\r
257 Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a
\r
258 <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
\r
259 </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
\r
260 The <paramref name="exception"/> is null (Nothing in Visual Basic).
\r
261 </exception><remarks>
\r
262 After Fault has been called on a dataflow block, that block will complete
\r
263 (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes
\r
264 buffered messages (uprocessed input messages as well as unoffered output messages) to be lost.
\r
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@)">
\r
269 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to accept and consume a
\r
270 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> previously offered by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
271 </summary><param name="messageHeader">The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being consumed.</param><param name="target">
\r
272 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> consuming the message.
\r
273 </param><param name="messageConsumed">
\r
274 True if the message was successfully consumed. False otherwise.
\r
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
\r
278 passed as the <paramref name="messageHeader"/> to <see cref="M:ConsumeMessage"/>. The consuming <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must
\r
279 use the returned value instead of the value passed as messageValue through <see cref="M:OfferMessage"/>.
\r
282 If the message requested is not available, the return value will be null (Nothing in Visual Basic).
\r
284 </returns><exception cref="T:System.ArgumentException">
\r
285 The <paramref name="messageHeader"/> is not valid.
\r
286 </exception><exception cref="T:System.ArgumentNullException">
\r
287 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
288 </exception><remarks>
\r
290 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
291 instance may use <see cref="M:ConsumeMessage"/>, and it must only be used
\r
292 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
293 offered by this source to the target.
\r
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}}})">
\r
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"/>
\r
300 by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
301 </summary><param name="messageHeader">
\r
302 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being reserved.
\r
303 </param><param name="target">
\r
304 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> reserving the message.
\r
305 </param><returns>true if the message was successfully reserved; otherwise, false.</returns><exception cref="T:System.ArgumentException">
\r
306 The <paramref name="messageHeader"/> is not valid.
\r
307 </exception><exception cref="T:System.ArgumentNullException">
\r
308 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
309 </exception><remarks>
\r
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
\r
312 may use <see cref="M:ReserveMessage"/>, and it must only be used
\r
313 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
314 offered by this source to the target.
\r
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.
\r
318 Failure to do so may result in the source being unable to propagate any further messages to this or other targets.
\r
321 <see cref="M:ReserveMessage"/> must not be called while the target is holding any internal locks. Doing so will violate the lock hierarchy
\r
322 necessary to avoid deadlocks in a dataflow network.
\r
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}}})">
\r
328 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to release a previously reserved
\r
329 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
330 </summary><param name="messageHeader">
\r
331 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the reserved message being released.
\r
332 </param><param name="target">
\r
333 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> releasing the message it previously reserved.
\r
334 </param><exception cref="T:System.ArgumentException">
\r
335 The <paramref name="messageHeader"/> is not valid.
\r
336 </exception><exception cref="T:System.ArgumentNullException">
\r
337 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
338 </exception><exception cref="T:System.InvalidOperationException">
\r
339 The <paramref name="target"/> did not have the message reserved.
\r
340 </exception><remarks>
\r
342 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
343 instance may use <see cref="M:ReleaseMessage"/>, and it must only be used
\r
344 to release <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
345 and successfully reserved by the target.
\r
349 <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.CompleteEachTarget">
\r
351 Invokes Complete on each target
\r
354 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.BatchSize">
\r
355 <summary>Gets the size of the batches generated by this <see cref="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2"/>.</summary>
\r
357 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.Target1">
\r
358 <summary>Gets a target that may be used to offer messages of the first type.</summary>
\r
360 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.Target2">
\r
361 <summary>Gets a target that may be used to offer messages of the second type.</summary>
\r
363 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.OutputCount">
\r
365 Gets the number of output items available to be received from this block.
\r
368 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.Completion">
\r
370 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
371 </summary><remarks>
\r
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
\r
373 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
374 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
375 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
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,
\r
377 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
378 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
379 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
382 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.OutputCountForDebugger">
\r
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>
\r
385 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebuggerDisplayContent">
\r
386 <summary>The data to display in the debugger display attribute.</summary>
\r
388 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
\r
389 <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
\r
391 <member name="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView">
\r
392 <summary>Provides a debugger type proxy for the Transform.</summary>
\r
394 <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.m_batchedJoinBlock">
\r
395 <summary>The block being viewed.</summary>
\r
397 <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.m_sourceDebuggingInformation">
\r
398 <summary>The source half of the block being viewed.</summary>
\r
400 <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.#ctor(System.Threading.Tasks.Dataflow.BatchedJoinBlock{`0,`1})">
\r
401 <summary>Initializes the debug view.</summary>
\r
402 <param name="batchedJoinBlock">The batched join being viewed.</param>
\r
404 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.OutputQueue">
\r
405 <summary>Gets the messages waiting to be received.</summary>
\r
407 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.BatchesCreated">
\r
408 <summary>Gets the number of batches created.</summary>
\r
410 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.RemainingItemsForBatch">
\r
411 <summary>Gets the number of items remaining to form a batch.</summary>
\r
413 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.BatchSize">
\r
414 <summary>Gets the size of the batches generated by this BatchedJoin.</summary>
\r
416 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.Target1">
\r
417 <summary>Gets the first target.</summary>
\r
419 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.Target2">
\r
420 <summary>Gets the second target.</summary>
\r
422 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.TaskForOutputProcessing">
\r
423 <summary>Gets the task being used for output processing.</summary>
\r
425 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.DataflowBlockOptions">
\r
426 <summary>Gets the DataflowBlockOptions used to configure this block.</summary>
\r
428 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.IsCompleted">
\r
429 <summary>Gets whether the block is completed.</summary>
\r
431 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.Id">
\r
432 <summary>Gets the block's Id.</summary>
\r
434 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.LinkedTargets">
\r
435 <summary>Gets the set of all targets linked from this block.</summary>
\r
437 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2.DebugView.NextMessageReservedFor">
\r
438 <summary>Gets the target that holds a reservation on the next message, if any.</summary>
\r
440 <member name="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3">
\r
442 Provides a dataflow block that batches a specified number of inputs of potentially differing types
\r
443 provided to one or more of its targets.
\r
445 <typeparam name="T1">Specifies the type of data accepted by the block's first target.</typeparam>
\r
446 <typeparam name="T2">Specifies the type of data accepted by the block's second target.</typeparam>
\r
447 <typeparam name="T3">Specifies the type of data accepted by the block's third target.</typeparam>
\r
449 <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.m_batchSize">
\r
450 <summary>The size of the batches generated by this BatchedJoin.</summary>
\r
452 <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.m_sharedResources">
\r
453 <summary>State shared among the targets.</summary>
\r
455 <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.m_target1">
\r
456 <summary>The target providing inputs of type T1.</summary>
\r
458 <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.m_target2">
\r
459 <summary>The target providing inputs of type T2.</summary>
\r
461 <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.m_target3">
\r
462 <summary>The target providing inputs of type T3.</summary>
\r
464 <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.m_source">
\r
465 <summary>The source side.</summary>
\r
467 <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.#ctor(System.Int32)">
\r
468 <summary>Initializes this <see cref="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3"/> with the specified configuration.</summary>
\r
469 <param name="batchSize">The number of items to group into a batch.</param>
\r
470 <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="batchSize"/> must be positive.</exception>
\r
472 <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.#ctor(System.Int32,System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions)">
\r
473 <summary>Initializes this <see cref="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3"/> with the specified configuration.</summary>
\r
474 <param name="batchSize">The number of items to group into a batch.</param>
\r
475 <param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2"/>.</param>
\r
476 <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="batchSize"/> must be positive.</exception>
\r
477 <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
\r
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)">
\r
481 Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.
\r
482 </summary><param name="target">
\r
483 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect this source.
\r
484 </param><param name="unlinkAfterOne">
\r
485 true if the source should unlink from the target after successfully propagating a single message;
\r
486 otherwise, false to remain connected even after a single message has been propagated.
\r
487 </param><returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns><exception cref="T:System.ArgumentNullException">
\r
488 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
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}}@)">
\r
493 Attempts to synchronously receive an available output item from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
494 </summary><param name="filter">
\r
495 The predicate a value must successfully pass in order for it to be received.
\r
496 <paramref name="filter"/> may be null (Nothing in Visual Basic), in which case all items will pass.
\r
497 </param><param name="item">The item received from the source.</param><returns>true if an item could be received; otherwise, false.</returns><remarks>
\r
498 This method does not block waiting for the source to provide an item.
\r
499 It will return after checking for an element, whether or not an element was available.
\r
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}}}@)">
\r
504 Attempts to synchronously receive all available items from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
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>
\r
506 This method does not block waiting for the source to provide an item.
\r
507 It will return after checking for elements, whether or not an element was available.
\r
510 <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.Complete">
\r
512 Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
\r
513 nor produce any more messages nor consume any more postponed messages.
\r
514 </summary><remarks>
\r
515 After Complete has been called on a dataflow block, that block will complete
\r
516 (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
\r
517 available data. Complete will not block waiting for completion to occur, but rather will initiaite
\r
518 the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
\r
521 <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
\r
523 Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a
\r
524 <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
\r
525 </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
\r
526 The <paramref name="exception"/> is null (Nothing in Visual Basic).
\r
527 </exception><remarks>
\r
528 After Fault has been called on a dataflow block, that block will complete
\r
529 (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes
\r
530 buffered messages (uprocessed input messages as well as unoffered output messages) to be lost.
\r
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@)">
\r
535 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to accept and consume a
\r
536 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> previously offered by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
537 </summary><param name="messageHeader">The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being consumed.</param><param name="target">
\r
538 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> consuming the message.
\r
539 </param><param name="messageConsumed">
\r
540 True if the message was successfully consumed. False otherwise.
\r
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
\r
544 passed as the <paramref name="messageHeader"/> to <see cref="M:ConsumeMessage"/>. The consuming <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must
\r
545 use the returned value instead of the value passed as messageValue through <see cref="M:OfferMessage"/>.
\r
548 If the message requested is not available, the return value will be null (Nothing in Visual Basic).
\r
550 </returns><exception cref="T:System.ArgumentException">
\r
551 The <paramref name="messageHeader"/> is not valid.
\r
552 </exception><exception cref="T:System.ArgumentNullException">
\r
553 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
554 </exception><remarks>
\r
556 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
557 instance may use <see cref="M:ConsumeMessage"/>, and it must only be used
\r
558 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
559 offered by this source to the target.
\r
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}}})">
\r
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"/>
\r
566 by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
567 </summary><param name="messageHeader">
\r
568 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being reserved.
\r
569 </param><param name="target">
\r
570 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> reserving the message.
\r
571 </param><returns>true if the message was successfully reserved; otherwise, false.</returns><exception cref="T:System.ArgumentException">
\r
572 The <paramref name="messageHeader"/> is not valid.
\r
573 </exception><exception cref="T:System.ArgumentNullException">
\r
574 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
575 </exception><remarks>
\r
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
\r
578 may use <see cref="M:ReserveMessage"/>, and it must only be used
\r
579 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
580 offered by this source to the target.
\r
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.
\r
584 Failure to do so may result in the source being unable to propagate any further messages to this or other targets.
\r
587 <see cref="M:ReserveMessage"/> must not be called while the target is holding any internal locks. Doing so will violate the lock hierarchy
\r
588 necessary to avoid deadlocks in a dataflow network.
\r
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}}})">
\r
594 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to release a previously reserved
\r
595 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
596 </summary><param name="messageHeader">
\r
597 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the reserved message being released.
\r
598 </param><param name="target">
\r
599 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> releasing the message it previously reserved.
\r
600 </param><exception cref="T:System.ArgumentException">
\r
601 The <paramref name="messageHeader"/> is not valid.
\r
602 </exception><exception cref="T:System.ArgumentNullException">
\r
603 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
604 </exception><exception cref="T:System.InvalidOperationException">
\r
605 The <paramref name="target"/> did not have the message reserved.
\r
606 </exception><remarks>
\r
608 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
609 instance may use <see cref="M:ReleaseMessage"/>, and it must only be used
\r
610 to release <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
611 and successfully reserved by the target.
\r
615 <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.CompleteEachTarget">
\r
617 Invokes Complete on each target
\r
620 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.BatchSize">
\r
621 <summary>Gets the size of the batches generated by this <see cref="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3"/>.</summary>
\r
623 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.Target1">
\r
624 <summary>Gets a target that may be used to offer messages of the first type.</summary>
\r
626 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.Target2">
\r
627 <summary>Gets a target that may be used to offer messages of the second type.</summary>
\r
629 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.Target3">
\r
630 <summary>Gets a target that may be used to offer messages of the third type.</summary>
\r
632 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.OutputCount">
\r
634 Gets the number of output items available to be received from this block.
\r
637 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.Completion">
\r
639 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
640 </summary><remarks>
\r
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
\r
642 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
643 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
644 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
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,
\r
646 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
647 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
648 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
651 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.OutputCountForDebugger">
\r
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>
\r
654 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebuggerDisplayContent">
\r
655 <summary>The data to display in the debugger display attribute.</summary>
\r
657 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
\r
658 <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
\r
660 <member name="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView">
\r
661 <summary>Provides a debugger type proxy for the Transform.</summary>
\r
663 <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.m_batchedJoinBlock">
\r
664 <summary>The block being viewed.</summary>
\r
666 <member name="F:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.m_sourceDebuggingInformation">
\r
667 <summary>The source half of the block being viewed.</summary>
\r
669 <member name="M:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.#ctor(System.Threading.Tasks.Dataflow.BatchedJoinBlock{`0,`1,`2})">
\r
670 <summary>Initializes the debug view.</summary>
\r
671 <param name="batchedJoinBlock">The batched join being viewed.</param>
\r
673 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.OutputQueue">
\r
674 <summary>Gets the messages waiting to be received.</summary>
\r
676 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.BatchesCreated">
\r
677 <summary>Gets the number of batches created.</summary>
\r
679 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.RemainingItemsForBatch">
\r
680 <summary>Gets the number of items remaining to form a batch.</summary>
\r
682 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.BatchSize">
\r
683 <summary>Gets the size of the batches generated by this BatchedJoin.</summary>
\r
685 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.Target1">
\r
686 <summary>Gets the first target.</summary>
\r
688 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.Target2">
\r
689 <summary>Gets the second target.</summary>
\r
691 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.Target3">
\r
692 <summary>Gets the second target.</summary>
\r
694 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.TaskForOutputProcessing">
\r
695 <summary>Gets the task being used for output processing.</summary>
\r
697 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.DataflowBlockOptions">
\r
698 <summary>Gets the DataflowBlockOptions used to configure this block.</summary>
\r
700 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.IsCompleted">
\r
701 <summary>Gets whether the block is completed.</summary>
\r
703 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.Id">
\r
704 <summary>Gets the block's Id.</summary>
\r
706 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.LinkedTargets">
\r
707 <summary>Gets the set of all targets linked from this block.</summary>
\r
709 <member name="P:System.Threading.Tasks.Dataflow.BatchedJoinBlock`3.DebugView.NextMessageReservedFor">
\r
710 <summary>Gets the target that holds a reservation on the next message, if any.</summary>
\r
712 <member name="T:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1">
\r
713 <summary>Provides the target used in a BatchedJoin.</summary>
\r
714 <typeparam name="T">Specifies the type of data accepted by this target.</typeparam>
\r
716 <member name="T:System.Threading.Tasks.Dataflow.ITargetBlock`1">
\r
717 <summary>Represents a dataflow block that is a target for data.</summary>
\r
718 <typeparam name="TInput">Specifies the type of data accepted by the <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.</typeparam>
\r
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)">
\r
721 <!-- No matching elements were found for the following include tag --><include file="CommonXmlDocComments.xml" path="CommonXmlDocComments/Sources/Member[@name="OfferMessage"]/*"/>
\r
723 <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.m_sharedResources">
\r
724 <summary>The shared resources used by all targets associated with the same batched join instance.</summary>
\r
726 <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.m_decliningPermanently">
\r
727 <summary>Whether this target is declining future messages.</summary>
\r
729 <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.m_messages">
\r
730 <summary>Input messages for the next batch.</summary>
\r
732 <member name="M:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.#ctor(System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources)">
\r
733 <summary>Initializes the target.</summary>
\r
734 <param name="sharedResources">The shared resources used by all targets associated with this batched join.</param>
\r
736 <member name="M:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.GetAndEmptyMessages">
\r
737 <summary>Gets the messages buffered by this target and then empties the collection.</summary>
\r
738 <returns>The messages from the target.</returns>
\r
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)">
\r
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.
\r
743 </summary><param name="messageHeader">
\r
744 A <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance that represents the header of the message being offered.
\r
745 </param><param name="messageValue">
\r
746 The value of the message being offered.
\r
747 </param><param name="source">
\r
748 The <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> offering the message. This may be null (Nothing in Visual Basic).
\r
749 </param><param name="consumeToAccept">
\r
750 true if the target must call ConsumeMessage synchronously during the call to OfferMessage, prior to returning
\r
751 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Accepted"/>, in order to consume the message.
\r
752 false if the target wanting to accept the message should not call ConsumeMessage, and should isntead simply return DataflowMessageStatus.Accepted.
\r
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
\r
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
\r
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.
\r
757 If the target would have otherwise postponed but source was null, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is instead returned.
\r
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,
\r
759 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.NotAvailable"/> is returned.
\r
760 If the target chose not to accept the message, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is returned. If the target
\r
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.
\r
762 </returns><exception cref="T:System.ArgumentException">
\r
763 The <paramref name="messageHeader"/> is not valid.
\r
764 </exception><exception cref="T:System.ArgumentException">
\r
765 <paramref name="consumeToAccept"/> may only be true if provided with a non-null <paramref name="source"/>.
\r
768 <member name="M:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.Complete">
\r
770 Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
\r
771 nor produce any more messages nor consume any more postponed messages.
\r
772 </summary><remarks>
\r
773 After Complete has been called on a dataflow block, that block will complete
\r
774 (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
\r
775 available data. Complete will not block waiting for completion to occur, but rather will initiaite
\r
776 the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
\r
779 <member name="M:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
\r
781 Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a
\r
782 <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
\r
783 </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
\r
784 The <paramref name="exception"/> is null (Nothing in Visual Basic).
\r
785 </exception><remarks>
\r
786 After Fault has been called on a dataflow block, that block will complete
\r
787 (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes
\r
788 buffered messages (uprocessed input messages as well as unoffered output messages) to be lost.
\r
791 <member name="P:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.Count">
\r
792 <summary>Gets the number of messages buffered in this target.</summary>
\r
794 <member name="P:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Completion">
\r
796 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
797 </summary><remarks>
\r
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
\r
799 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
800 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
801 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
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,
\r
803 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
804 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
805 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
808 <member name="P:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.DebuggerDisplayContent">
\r
809 <summary>The data to display in the debugger display attribute.</summary>
\r
811 <member name="P:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
\r
812 <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
\r
814 <member name="T:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.DebugView">
\r
815 <summary>Provides a debugger type proxy for the Transform.</summary>
\r
817 <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.DebugView.m_batchedJoinBlockTarget">
\r
818 <summary>The batched join block target being viewed.</summary>
\r
820 <member name="M:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.DebugView.#ctor(System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget{`0})">
\r
821 <summary>Initializes the debug view.</summary>
\r
822 <param name="batchedJoinBlockTarget">The batched join target being viewed.</param>
\r
824 <member name="P:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.DebugView.InputQueue">
\r
825 <summary>Gets the messages waiting to be processed.</summary>
\r
827 <member name="P:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTarget`1.DebugView.IsDecliningPermanently">
\r
828 <summary>Gets whether the block is declining further messages.</summary>
\r
830 <member name="T:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources">
\r
831 <summary>Provides a container for resources shared across all targets used by the same BatchedJoinBlock instance.</summary>
\r
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)">
\r
834 <summary>Initializes the shared resources.</summary>
\r
835 <param name="batchSize">The size of a batch to create.</param>
\r
836 <param name="dataflowBlockOptions">The options used to configur the shared resources. Assumed to be immutable.</param>
\r
837 <param name="batchSizeReachedAction">The action to invoke when a batch is completed.</param>
\r
838 <param name="allTargetsDecliningAction">The action to invoke when no more targets are accepting input.</param>
\r
839 <param name="exceptionAction">The action to invoke when an exception needs to be logged.</param>
\r
840 <param name="completionAction">The action to invoke when completing, typically invoked due to a call to Fault.</param>
\r
842 <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources.m_incomingLock">
\r
844 A lock used to synchronize all incoming messages on all targets. It protects all of the rest
\r
845 of the shared resource's state and will be held while invoking the delegates.
\r
848 <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources.m_batchSize">
\r
849 <summary>The size of the batches to generate.</summary>
\r
851 <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources.m_batchSizeReachedAction">
\r
852 <summary>The action to invoke when enough elements have been accumulated to make a batch.</summary>
\r
854 <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources.m_allTargetsDecliningPermanentlyAction">
\r
855 <summary>The action to invoke when all targets are declining further messages.</summary>
\r
857 <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources.m_exceptionAction">
\r
858 <summary>The action to invoke when an exception has to be logged.</summary>
\r
860 <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources.m_completionAction">
\r
861 <summary>The action to invoke when the owning block has to be completed.</summary>
\r
863 <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources.m_remainingItemsInBatch">
\r
864 <summary>The number of items remaining to form a batch.</summary>
\r
866 <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources.m_remainingAliveTargets">
\r
867 <summary>The number of targets still alive (i.e. not declining all further messages).</summary>
\r
869 <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources.m_decliningPermanently">
\r
870 <summary>Whether all targets should decline all further messages.</summary>
\r
872 <member name="F:System.Threading.Tasks.Dataflow.Internal.BatchedJoinBlockTargetSharedResources.m_batchesCreated">
\r
873 <summary>The number of batches created.</summary>
\r
875 <member name="T:System.Threading.Tasks.Dataflow.Internal.SourceCore`1">
\r
876 <summary>Provides a core implementation for blocks that implement <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.</summary>
\r
877 <typeparam name="TOutput">Specifies the type of data supplied by the <see cref="T:System.Threading.Tasks.Dataflow.Internal.SourceCore`1"/>.</typeparam>
\r
879 <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_completionTask">
\r
880 <summary>A TaskCompletionSource that represents the completion of this block.</summary>
\r
882 <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_targetRegistry">
\r
883 <summary>A registry used to store all linked targets and information about them.</summary>
\r
885 <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_messages">
\r
886 <summary>All of the output messages queued up to be received by consumers/targets.</summary>
\r
888 <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_executionContext">
\r
889 <summary>The execution context captured when this block was instantiated.</summary>
\r
891 <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_owningSource">
\r
892 <summary>The source utilizing this helper.</summary>
\r
894 <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_dataflowBlockOptions">
\r
895 <summary>The options used to configure this block's execution.</summary>
\r
897 <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_completeAction">
\r
899 An action to be invoked on the owner block to stop accepting messages.
\r
900 This action is invoked when SourceCore encounters an exception.
\r
903 <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_itemsRemovedAction">
\r
905 An action to be invoked on the owner block when an item is removed.
\r
906 This may be null if the owner block doesn't need to be notified.
\r
909 <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_itemCountingFunc">
\r
910 <summary>Item counting function</summary>
\r
912 <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_taskForOutputProcessing">
\r
913 <summary>The task used to process the output and offer it to targets.</summary>
\r
915 <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_nextMessageId">
\r
916 <summary>Counter for message IDs unique within this source block.</summary>
\r
918 <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_nextMessageReservedFor">
\r
919 <summary>The target that the next message is reserved for, or null if nothing is reserved.</summary>
\r
921 <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_decliningPermanently">
\r
922 <summary>Whether all future messages should be declined.</summary>
\r
924 <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_enableOffering">
\r
925 <summary>Whether this block should again attempt to offer messages to targets.</summary>
\r
927 <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_completionReserved">
\r
928 <summary>Whether someone has reserved the right to call CompleteBlockOncePossible.</summary>
\r
930 <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.m_exceptions">
\r
931 <summary>Exceptions that may have occured and gone unhandled during processing.</summary>
\r
933 Marked volatile because we compare the m_exceptions reference to null while not under a lock,
\r
934 but we manipulate it elsewhere (e.g. initializing it to non-null) while holding a lock.
\r
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})">
\r
938 <summary>Initializes the source core.</summary>
\r
939 <param name="owningSource">The source utilizing this core.</param>
\r
940 <param name="dataflowBlockOptions">The options to use to configure the block.</param>
\r
941 <param name="completeAction">Action to invoke in order to decline the associated target half, which will in turn decline this source core.</param>
\r
942 <param name="itemsRemovedAction">Action to invoke when one or more items is removed. This may be null.</param>
\r
943 <param name="itemCountingFunc">
\r
944 Action to invoke when the owner needs to be able to count the number of individual
\r
945 items in an output or set of outputs.
\r
948 <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.LinkTo(System.Threading.Tasks.Dataflow.ITargetBlock{`0},System.Boolean)">
\r
950 Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.
\r
951 </summary><param name="target">
\r
952 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect this source.
\r
953 </param><param name="unlinkAfterOne">
\r
954 true if the source should unlink from the target after successfully propagating a single message;
\r
955 otherwise, false to remain connected even after a single message has been propagated.
\r
956 </param><returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns><exception cref="T:System.ArgumentNullException">
\r
957 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
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@)">
\r
962 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to accept and consume a
\r
963 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> previously offered by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
964 </summary><param name="messageHeader">The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being consumed.</param><param name="target">
\r
965 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> consuming the message.
\r
966 </param><param name="messageConsumed">
\r
967 True if the message was successfully consumed. False otherwise.
\r
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
\r
971 passed as the <paramref name="messageHeader"/> to <see cref="M:ConsumeMessage"/>. The consuming <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must
\r
972 use the returned value instead of the value passed as messageValue through <see cref="M:OfferMessage"/>.
\r
975 If the message requested is not available, the return value will be null (Nothing in Visual Basic).
\r
977 </returns><exception cref="T:System.ArgumentException">
\r
978 The <paramref name="messageHeader"/> is not valid.
\r
979 </exception><exception cref="T:System.ArgumentNullException">
\r
980 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
981 </exception><remarks>
\r
983 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
984 instance may use <see cref="M:ConsumeMessage"/>, and it must only be used
\r
985 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
986 offered by this source to the target.
\r
990 <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.ReserveMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
\r
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"/>
\r
993 by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
994 </summary><param name="messageHeader">
\r
995 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being reserved.
\r
996 </param><param name="target">
\r
997 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> reserving the message.
\r
998 </param><returns>true if the message was successfully reserved; otherwise, false.</returns><exception cref="T:System.ArgumentException">
\r
999 The <paramref name="messageHeader"/> is not valid.
\r
1000 </exception><exception cref="T:System.ArgumentNullException">
\r
1001 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
1002 </exception><remarks>
\r
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
\r
1005 may use <see cref="M:ReserveMessage"/>, and it must only be used
\r
1006 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
1007 offered by this source to the target.
\r
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.
\r
1011 Failure to do so may result in the source being unable to propagate any further messages to this or other targets.
\r
1014 <see cref="M:ReserveMessage"/> must not be called while the target is holding any internal locks. Doing so will violate the lock hierarchy
\r
1015 necessary to avoid deadlocks in a dataflow network.
\r
1019 <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.ReleaseReservation(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
\r
1021 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to release a previously reserved
\r
1022 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
1023 </summary><param name="messageHeader">
\r
1024 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the reserved message being released.
\r
1025 </param><param name="target">
\r
1026 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> releasing the message it previously reserved.
\r
1027 </param><exception cref="T:System.ArgumentException">
\r
1028 The <paramref name="messageHeader"/> is not valid.
\r
1029 </exception><exception cref="T:System.ArgumentNullException">
\r
1030 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
1031 </exception><exception cref="T:System.InvalidOperationException">
\r
1032 The <paramref name="target"/> did not have the message reserved.
\r
1033 </exception><remarks>
\r
1035 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
1036 instance may use <see cref="M:ReleaseMessage"/>, and it must only be used
\r
1037 to release <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
1038 and successfully reserved by the target.
\r
1042 <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.TryReceive(System.Predicate{`0},`0@)">
\r
1044 Attempts to synchronously receive an available output item from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
1045 </summary><param name="filter">
\r
1046 The predicate a value must successfully pass in order for it to be received.
\r
1047 <paramref name="filter"/> may be null (Nothing in Visual Basic), in which case all items will pass.
\r
1048 </param><param name="item">The item received from the source.</param><returns>true if an item could be received; otherwise, false.</returns><remarks>
\r
1049 This method does not block waiting for the source to provide an item.
\r
1050 It will return after checking for an element, whether or not an element was available.
\r
1053 <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.TryReceiveAll(System.Collections.Generic.IList{`0}@)">
\r
1055 Attempts to synchronously receive all available items from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
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>
\r
1057 This method does not block waiting for the source to provide an item.
\r
1058 It will return after checking for elements, whether or not an element was available.
\r
1061 <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.AddMessage(`0)">
\r
1062 <summary>Adds a message to the source block for propagation.</summary>
\r
1063 <param name="item">The item to be wrapped in a message to be added.</param>
\r
1065 <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.AddMessages(System.Collections.Generic.IEnumerable{`0})">
\r
1066 <summary>Adds messages to the source block for propagation.</summary>
\r
1067 <param name="items">The list of items to be wrapped in messages to be added.</param>
\r
1069 <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.AddException(System.Exception)">
\r
1070 <summary>Adds an individual exceptionto this source.</summary>
\r
1071 <param name="exception">The exception to add</param>
\r
1073 <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.AddExceptions(System.Collections.Generic.List{System.Exception})">
\r
1074 <summary>Adds exceptions to this source.</summary>
\r
1075 <param name="exceptions">The exceptions to add</param>
\r
1077 <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.AddAndUnwrapAggregateException(System.AggregateException)">
\r
1078 <summary>Adds the exceptions contained in an AggregateException to this source.</summary>
\r
1079 <param name="aggregateException">The exception to add</param>
\r
1081 <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.Complete">
\r
1082 <summary>Informs the block that it will not be receiving additional messages.</summary>
\r
1084 <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.OfferToTargets(System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
\r
1085 <summary>Offers messages to all targets.</summary>
\r
1086 <param name="linkToTarget">
\r
1087 The newly linked target, if OfferToTargets is being called to synchronously
\r
1088 propagate to a target during a LinkTo operation.
\r
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@)">
\r
1092 <summary>Offers the message to the target.</summary>
\r
1093 <param name="header">The header of the message to offer.</param>
\r
1094 <param name="message">The message being offered.</param>
\r
1095 <param name="target">The single target to which the message should be offered.</param>
\r
1096 <param name="messageWasAccepted">true if the message was accepted by the target; otherwise, false.</param>
\r
1098 true if the message should not be offered to additional targets;
\r
1099 false if propagation should be allowed to continue.
\r
1102 <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.OfferAsyncIfNecessary(System.Boolean,System.Boolean)">
\r
1103 <summary>Called when we want to enable asynchronously offering message to targets.</summary>
\r
1104 <param name="isReplacementReplica">Whether this call is the continuation of a previous message loop.</param>
\r
1105 <param name="includeOutgoingOnlyChecks">Whether this call should include in "what's necessary" checks that require the outgoing lock.</param>
\r
1107 <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.OfferMessagesLoopWithExecutionContext">
\r
1108 <summary>Task body used to process messages under the right execution context.</summary>
\r
1110 <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.OfferMessagesLoopCore">
\r
1111 <summary>Task body used to process messages.</summary>
\r
1113 <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.CompleteBlockIfPossible">
\r
1114 <summary>Completes the block's processing if there's nothing left to do and never will be.</summary>
\r
1116 <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.CompleteBlockOncePossible">
\r
1118 Completes the block. This must only be called once, and only once all of the completion conditions are met.
\r
1119 As such, it must only be called from CompleteBlockIfPossible.
\r
1122 <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.GetDebuggingInformation">
\r
1123 <summary>Gets information about this helper to be used for display in a debugger.</summary>
\r
1124 <returns>Debugging information about this source core.</returns>
\r
1126 <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.OutgoingLock">
\r
1127 <summary>Gets the object to use as the outgoing lock.</summary>
\r
1129 <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.ValueLock">
\r
1130 <summary>Gets the object to use as the value lock.</summary>
\r
1132 <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.Completion">
\r
1134 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
1135 </summary><remarks>
\r
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
\r
1137 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
1138 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
1139 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
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,
\r
1141 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
1142 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
1143 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
1146 <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.OutputCount">
\r
1147 <summary>Gets the number of items available to be received from this block.</summary>
\r
1149 <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.CapturedContext">
\r
1150 <summary>Gets the execution context captured for this source core.</summary>
\r
1152 <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.HasExceptions">
\r
1153 <summary>Gets whether the m_exceptions list is non-null.</summary>
\r
1155 <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DataflowBlockOptions">
\r
1156 <summary>Gets the DataflowBlockOptions used to configure this block.</summary>
\r
1158 <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.CanceledOrFaulted">
\r
1159 <summary>Gets whether the source has had cancellation requested or an exception has occurred.</summary>
\r
1161 <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggerDisplayContent">
\r
1162 <summary>Gets the object to display in the debugger display attribute.</summary>
\r
1164 <member name="T:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggingInformation">
\r
1165 <summary>Provides debugging information about the source core.</summary>
\r
1167 <member name="F:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggingInformation.m_source">
\r
1168 <summary>The source being viewed.</summary>
\r
1170 <member name="M:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggingInformation.#ctor(System.Threading.Tasks.Dataflow.Internal.SourceCore{`0})">
\r
1171 <summary>Initializes the type proxy.</summary>
\r
1172 <param name="source">The source being viewed.</param>
\r
1174 <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggingInformation.OutputCount">
\r
1175 <summary>Gets the number of messages available for receiving.</summary>
\r
1177 <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggingInformation.OutputQueue">
\r
1178 <summary>Gets the messages available for receiving.</summary>
\r
1180 <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggingInformation.TaskForOutputProcessing">
\r
1181 <summary>Gets the task being used for output processing.</summary>
\r
1183 <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggingInformation.DataflowBlockOptions">
\r
1184 <summary>Gets the DataflowBlockOptions used to configure this block.</summary>
\r
1186 <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggingInformation.IsDecliningPermanently">
\r
1187 <summary>Gets whether the block is declining further messages.</summary>
\r
1189 <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggingInformation.IsCompleted">
\r
1190 <summary>Gets whether the block is completed.</summary>
\r
1192 <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggingInformation.LinkedTargets">
\r
1193 <summary>Gets the set of all targets linked from this block.</summary>
\r
1195 <member name="P:System.Threading.Tasks.Dataflow.Internal.SourceCore`1.DebuggingInformation.NextMessageReservedFor">
\r
1196 <summary>Gets the target that holds a reservation on the next message, if any.</summary>
\r
1198 <member name="T:System.Threading.Tasks.Dataflow.Internal.ActionOnDispose">
\r
1199 <summary>An IDisposable that will run an Action delegate when disposed.</summary>
\r
1201 <member name="F:System.Threading.Tasks.Dataflow.Internal.ActionOnDispose.s_empty">
\r
1202 <summary>An IDisposable that does nothing.</summary>
\r
1204 <member name="F:System.Threading.Tasks.Dataflow.Internal.ActionOnDispose.m_disposeDelegate">
\r
1205 <summary>The action to run when disposed.</summary>
\r
1207 <member name="F:System.Threading.Tasks.Dataflow.Internal.ActionOnDispose.m_state">
\r
1208 <summary>Optional state to be passed to the dispose delegate.</summary>
\r
1210 <member name="M:System.Threading.Tasks.Dataflow.Internal.ActionOnDispose.#ctor(System.Action{System.Object},System.Object)">
\r
1211 <summary>Initializes the ActionOnDispose.</summary>
\r
1212 <param name="actionWithState">The action to run when disposed.</param>
\r
1213 <param name="state">State to pass to the action when it's invoked.</param>
\r
1215 <member name="M:System.Threading.Tasks.Dataflow.Internal.ActionOnDispose.System#IDisposable#Dispose">
\r
1216 <summary>Invoke the action.</summary>
\r
1218 <member name="P:System.Threading.Tasks.Dataflow.Internal.ActionOnDispose.Empty">
\r
1219 <summary>Gets an IDisposable that does nothing.</summary>
\r
1221 <member name="P:System.Threading.Tasks.Dataflow.Internal.ActionOnDispose.Disposed">
\r
1222 <summary>Gets whether the IDisposable has been disposed.</summary>
\r
1224 <member name="T:System.Threading.Tasks.Dataflow.TransformBlock`2">
\r
1225 <summary>Provides a dataflow block that invokes a provided <see cref="T:System.Func`2"/> delegate for every data element received.</summary>
\r
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>
\r
1227 <typeparam name="TOutput">Specifies the type of data output by this <see cref="T:System.Threading.Tasks.Dataflow.TransformBlock`2"/>.</typeparam>
\r
1229 <member name="T:System.Threading.Tasks.Dataflow.IPropagatorBlock`2">
\r
1230 <summary>Represents a dataflow block that is both a target for data and a source of data.</summary>
\r
1231 <typeparam name="TInput">Specifies the type of data accepted by the <see cref="T:System.Threading.Tasks.Dataflow.IPropagatorBlock`2"/>.</typeparam>
\r
1232 <typeparam name="TOutput">Specifies the type of data supplied by the <see cref="T:System.Threading.Tasks.Dataflow.IPropagatorBlock`2"/>.</typeparam>
\r
1234 <member name="F:System.Threading.Tasks.Dataflow.TransformBlock`2.m_target">
\r
1235 <summary>The target side.</summary>
\r
1237 <member name="F:System.Threading.Tasks.Dataflow.TransformBlock`2.m_reorderingBuffer">
\r
1238 <summary>Buffer used to reorder outputs that may have completed out-of-order between the target half and the source half.</summary>
\r
1240 <member name="F:System.Threading.Tasks.Dataflow.TransformBlock`2.m_source">
\r
1241 <summary>The source side.</summary>
\r
1243 <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.#ctor(System.Func{`0,`1})">
\r
1244 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.TransformBlock`2"/> with the specified <see cref="T:System.Func`2"/>.</summary>
\r
1245 <param name="transform">The function to invoke with each data element received.</param>
\r
1246 <exception cref="T:System.ArgumentNullException">The <paramref name="transform"/> is null (Nothing in Visual Basic).</exception>
\r
1248 <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.#ctor(System.Func{`0,`1},System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions)">
\r
1250 Initializes the <see cref="T:System.Threading.Tasks.Dataflow.TransformBlock`2"/> with the specified <see cref="T:System.Func`2"/> and
\r
1251 <see cref="T:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions"/>.
\r
1253 <param name="transform">The function to invoke with each data element received.</param>
\r
1254 <param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.TransformBlock`2"/>.</param>
\r
1255 <exception cref="T:System.ArgumentNullException">The <paramref name="transform"/> is null (Nothing in Visual Basic).</exception>
\r
1256 <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
\r
1258 <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.#ctor(System.Func{`0,System.Threading.Tasks.Task{`1}})">
\r
1259 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.TransformBlock`2"/> with the specified <see cref="T:System.Func`2"/>.</summary>
\r
1260 <param name="transform">The function to invoke with each data element received.</param>
\r
1261 <exception cref="T:System.ArgumentNullException">The <paramref name="transform"/> is null (Nothing in Visual Basic).</exception>
\r
1263 <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.#ctor(System.Func{`0,System.Threading.Tasks.Task{`1}},System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions)">
\r
1265 Initializes the <see cref="T:System.Threading.Tasks.Dataflow.TransformBlock`2"/> with the specified <see cref="T:System.Func`2"/>
\r
1266 and <see cref="T:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions"/>.
\r
1268 <param name="transform">The function to invoke with each data element received.</param>
\r
1269 <param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.TransformBlock`2"/>.</param>
\r
1270 <exception cref="T:System.ArgumentNullException">The <paramref name="transform"/> is null (Nothing in Visual Basic).</exception>
\r
1271 <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
\r
1273 <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.#ctor(System.Delegate,System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions)">
\r
1275 Initializes the <see cref="T:System.Threading.Tasks.Dataflow.TransformBlock`2"/> with the specified <see cref="T:System.Func`2"/>
\r
1276 and <see cref="T:System.Threading.Tasks.Dataflow.DataflowBlockOptions"/>.
\r
1278 <param name="transform">The function to invoke with each data element received.</param>
\r
1279 <param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.TransformBlock`2"/>.</param>
\r
1280 <exception cref="T:System.ArgumentNullException">The <paramref name="transform"/> is null (Nothing in Visual Basic).</exception>
\r
1281 <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
\r
1283 <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.ProcessMessage(System.Func{`0,`1},System.Collections.Generic.KeyValuePair{`0,System.Int64})">
\r
1284 <summary>Processes the message with a user-provided transform function that returns a TOutput.</summary>
\r
1285 <param name="transform">The transform function to use to process the message.</param>
\r
1286 <param name="messageWithId">The message to be processed.</param>
\r
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})">
\r
1289 <summary>Processes the message with a user-provided transform function that returns a task of TOutput.</summary>
\r
1290 <param name="transform">The transform function to use to process the message.</param>
\r
1291 <param name="messageWithId">The message to be processed.</param>
\r
1293 <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.AsyncCompleteProcessMessageWithTask(System.Threading.Tasks.Task{`1},System.Collections.Generic.KeyValuePair{`0,System.Int64})">
\r
1294 <summary>Completes the processing of an asynchronous message.</summary>
\r
1295 <param name="completed">The completed task storing the output data generated for an input message.</param>
\r
1296 <param name="messageWithId">The originating message</param>
\r
1298 <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.Complete">
\r
1300 Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
\r
1301 nor produce any more messages nor consume any more postponed messages.
\r
1302 </summary><remarks>
\r
1303 After Complete has been called on a dataflow block, that block will complete
\r
1304 (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
\r
1305 available data. Complete will not block waiting for completion to occur, but rather will initiaite
\r
1306 the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
\r
1309 <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
\r
1311 Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a
\r
1312 <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
\r
1313 </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
\r
1314 The <paramref name="exception"/> is null (Nothing in Visual Basic).
\r
1315 </exception><remarks>
\r
1316 After Fault has been called on a dataflow block, that block will complete
\r
1317 (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes
\r
1318 buffered messages (uprocessed input messages as well as unoffered output messages) to be lost.
\r
1321 <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.LinkTo(System.Threading.Tasks.Dataflow.ITargetBlock{`1},System.Boolean)">
\r
1323 Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.
\r
1324 </summary><param name="target">
\r
1325 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect this source.
\r
1326 </param><param name="unlinkAfterOne">
\r
1327 true if the source should unlink from the target after successfully propagating a single message;
\r
1328 otherwise, false to remain connected even after a single message has been propagated.
\r
1329 </param><returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns><exception cref="T:System.ArgumentNullException">
\r
1330 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
1333 <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.TryReceive(System.Predicate{`1},`1@)">
\r
1335 Attempts to synchronously receive an available output item from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
1336 </summary><param name="filter">
\r
1337 The predicate a value must successfully pass in order for it to be received.
\r
1338 <paramref name="filter"/> may be null (Nothing in Visual Basic), in which case all items will pass.
\r
1339 </param><param name="item">The item received from the source.</param><returns>true if an item could be received; otherwise, false.</returns><remarks>
\r
1340 This method does not block waiting for the source to provide an item.
\r
1341 It will return after checking for an element, whether or not an element was available.
\r
1344 <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.TryReceiveAll(System.Collections.Generic.IList{`1}@)">
\r
1346 Attempts to synchronously receive all available items from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
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>
\r
1348 This method does not block waiting for the source to provide an item.
\r
1349 It will return after checking for elements, whether or not an element was available.
\r
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)">
\r
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.
\r
1355 </summary><param name="messageHeader">
\r
1356 A <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance that represents the header of the message being offered.
\r
1357 </param><param name="messageValue">
\r
1358 The value of the message being offered.
\r
1359 </param><param name="source">
\r
1360 The <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> offering the message. This may be null (Nothing in Visual Basic).
\r
1361 </param><param name="consumeToAccept">
\r
1362 true if the target must call ConsumeMessage synchronously during the call to OfferMessage, prior to returning
\r
1363 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Accepted"/>, in order to consume the message.
\r
1364 false if the target wanting to accept the message should not call ConsumeMessage, and should isntead simply return DataflowMessageStatus.Accepted.
\r
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
\r
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
\r
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.
\r
1369 If the target would have otherwise postponed but source was null, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is instead returned.
\r
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,
\r
1371 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.NotAvailable"/> is returned.
\r
1372 If the target chose not to accept the message, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is returned. If the target
\r
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.
\r
1374 </returns><exception cref="T:System.ArgumentException">
\r
1375 The <paramref name="messageHeader"/> is not valid.
\r
1376 </exception><exception cref="T:System.ArgumentException">
\r
1377 <paramref name="consumeToAccept"/> may only be true if provided with a non-null <paramref name="source"/>.
\r
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@)">
\r
1382 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to accept and consume a
\r
1383 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> previously offered by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
1384 </summary><param name="messageHeader">The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being consumed.</param><param name="target">
\r
1385 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> consuming the message.
\r
1386 </param><param name="messageConsumed">
\r
1387 True if the message was successfully consumed. False otherwise.
\r
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
\r
1391 passed as the <paramref name="messageHeader"/> to <see cref="M:ConsumeMessage"/>. The consuming <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must
\r
1392 use the returned value instead of the value passed as messageValue through <see cref="M:OfferMessage"/>.
\r
1395 If the message requested is not available, the return value will be null (Nothing in Visual Basic).
\r
1397 </returns><exception cref="T:System.ArgumentException">
\r
1398 The <paramref name="messageHeader"/> is not valid.
\r
1399 </exception><exception cref="T:System.ArgumentNullException">
\r
1400 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
1401 </exception><remarks>
\r
1403 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
1404 instance may use <see cref="M:ConsumeMessage"/>, and it must only be used
\r
1405 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
1406 offered by this source to the target.
\r
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})">
\r
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"/>
\r
1413 by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
1414 </summary><param name="messageHeader">
\r
1415 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being reserved.
\r
1416 </param><param name="target">
\r
1417 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> reserving the message.
\r
1418 </param><returns>true if the message was successfully reserved; otherwise, false.</returns><exception cref="T:System.ArgumentException">
\r
1419 The <paramref name="messageHeader"/> is not valid.
\r
1420 </exception><exception cref="T:System.ArgumentNullException">
\r
1421 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
1422 </exception><remarks>
\r
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
\r
1425 may use <see cref="M:ReserveMessage"/>, and it must only be used
\r
1426 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
1427 offered by this source to the target.
\r
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.
\r
1431 Failure to do so may result in the source being unable to propagate any further messages to this or other targets.
\r
1434 <see cref="M:ReserveMessage"/> must not be called while the target is holding any internal locks. Doing so will violate the lock hierarchy
\r
1435 necessary to avoid deadlocks in a dataflow network.
\r
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})">
\r
1441 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to release a previously reserved
\r
1442 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
1443 </summary><param name="messageHeader">
\r
1444 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the reserved message being released.
\r
1445 </param><param name="target">
\r
1446 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> releasing the message it previously reserved.
\r
1447 </param><exception cref="T:System.ArgumentException">
\r
1448 The <paramref name="messageHeader"/> is not valid.
\r
1449 </exception><exception cref="T:System.ArgumentNullException">
\r
1450 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
1451 </exception><exception cref="T:System.InvalidOperationException">
\r
1452 The <paramref name="target"/> did not have the message reserved.
\r
1453 </exception><remarks>
\r
1455 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
1456 instance may use <see cref="M:ReleaseMessage"/>, and it must only be used
\r
1457 to release <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
1458 and successfully reserved by the target.
\r
1462 <member name="P:System.Threading.Tasks.Dataflow.TransformBlock`2.Completion">
\r
1464 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
1465 </summary><remarks>
\r
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
\r
1467 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
1468 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
1469 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
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,
\r
1471 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
1472 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
1473 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
1476 <member name="P:System.Threading.Tasks.Dataflow.TransformBlock`2.InputCount">
\r
1478 Gets the number of input items waiting to be processed by this block.
\r
1479 </summary><remarks>
\r
1480 The InputCount does not include any items currently being processed by the block or any items that
\r
1481 have already been processed by the block.
\r
1484 <member name="P:System.Threading.Tasks.Dataflow.TransformBlock`2.OutputCount">
\r
1486 Gets the number of output items available to be received from this block.
\r
1489 <member name="P:System.Threading.Tasks.Dataflow.TransformBlock`2.InputCountForDebugger">
\r
1490 <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>
\r
1492 <member name="P:System.Threading.Tasks.Dataflow.TransformBlock`2.OutputCountForDebugger">
\r
1493 <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>
\r
1495 <member name="P:System.Threading.Tasks.Dataflow.TransformBlock`2.DebuggerDisplayContent">
\r
1496 <summary>The data to display in the debugger display attribute.</summary>
\r
1498 <member name="P:System.Threading.Tasks.Dataflow.TransformBlock`2.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
\r
1499 <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
\r
1501 <member name="T:System.Threading.Tasks.Dataflow.TransformBlock`2.DebugView">
\r
1502 <summary>Provides a debugger type proxy for the TransformBlock.</summary>
\r
1504 <member name="F:System.Threading.Tasks.Dataflow.TransformBlock`2.DebugView.m_transformBlock">
\r
1505 <summary>The transform being viewed.</summary>
\r
1507 <member name="F:System.Threading.Tasks.Dataflow.TransformBlock`2.DebugView.m_targetDebuggingInformation">
\r
1508 <summary>The target half of the block being viewed.</summary>
\r
1510 <member name="F:System.Threading.Tasks.Dataflow.TransformBlock`2.DebugView.m_sourceDebuggingInformation">
\r
1511 <summary>The source half of the block being viewed.</summary>
\r
1513 <member name="M:System.Threading.Tasks.Dataflow.TransformBlock`2.DebugView.#ctor(System.Threading.Tasks.Dataflow.TransformBlock{`0,`1})">
\r
1514 <summary>Initializes the debug view.</summary>
\r
1515 <param name="transformBlock">The transform being viewed.</param>
\r
1517 <member name="P:System.Threading.Tasks.Dataflow.TransformBlock`2.DebugView.InputQueue">
\r
1518 <summary>Gets the messages waiting to be processed.</summary>
\r
1520 <member name="P:System.Threading.Tasks.Dataflow.TransformBlock`2.DebugView.PostponedMessages">
\r
1521 <summary>Gets any postponed messages.</summary>
\r
1523 <member name="P:System.Threading.Tasks.Dataflow.TransformBlock`2.DebugView.OutputQueue">
\r
1524 <summary>Gets the messages waiting to be received.</summary>
\r
1526 <member name="P:System.Threading.Tasks.Dataflow.TransformBlock`2.DebugView.CurrentDegreeOfParallelism">
\r
1527 <summary>Gets the number of oustanding input operations.</summary>
\r
1529 <member name="P:System.Threading.Tasks.Dataflow.TransformBlock`2.DebugView.TaskForOutputProcessing">
\r
1530 <summary>Gets the task being used for output processing.</summary>
\r
1532 <member name="P:System.Threading.Tasks.Dataflow.TransformBlock`2.DebugView.DataflowBlockOptions">
\r
1533 <summary>Gets the DataflowBlockOptions used to configure this block.</summary>
\r
1535 <member name="P:System.Threading.Tasks.Dataflow.TransformBlock`2.DebugView.IsDecliningPermanently">
\r
1536 <summary>Gets whether the block is declining further messages.</summary>
\r
1538 <member name="P:System.Threading.Tasks.Dataflow.TransformBlock`2.DebugView.IsCompleted">
\r
1539 <summary>Gets whether the block is completed.</summary>
\r
1541 <member name="P:System.Threading.Tasks.Dataflow.TransformBlock`2.DebugView.Id">
\r
1542 <summary>Gets the block's Id.</summary>
\r
1544 <member name="P:System.Threading.Tasks.Dataflow.TransformBlock`2.DebugView.LinkedTargets">
\r
1545 <summary>Gets the set of all targets linked from this block.</summary>
\r
1547 <member name="P:System.Threading.Tasks.Dataflow.TransformBlock`2.DebugView.NextMessageReservedFor">
\r
1548 <summary>Gets the target that holds a reservation on the next message, if any.</summary>
\r
1550 <member name="T:System.Threading.Tasks.Dataflow.Internal.TargetCoreOptions">
\r
1551 <summary>Options used to configure a target core.</summary>
\r
1553 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetCoreOptions.None">
\r
1554 <summary>Synchronous completion, both a target and a source, etc.</summary>
\r
1556 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetCoreOptions.UsesAsyncCompletion">
\r
1557 <summary>Whether the block relies on the delegate to signal when an async operation has completed.</summary>
\r
1559 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetCoreOptions.RepresentsBlockCompletion">
\r
1561 Whether the block containing this target core is just a target or also has a source side.
\r
1562 If it's just a target, then this target core's completion represents the entire block's completion.
\r
1565 <member name="T:System.Threading.Tasks.Dataflow.Internal.TargetCore`1">
\r
1567 Provides a core implementation of <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.</summary>
\r
1568 <typeparam name="TInput">Specifies the type of data accepted by the <see cref="T:System.Threading.Tasks.Dataflow.Internal.TargetCore`1"/>.</typeparam>
\r
1570 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.m_messages">
\r
1571 <summary>The messages in this target.</summary>
\r
1572 <remarks>This field doubles as the IncomingLock.</remarks>
\r
1574 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.m_executionContext">
\r
1575 <summary>The context captured when the block was instantiated.</summary>
\r
1577 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.m_completionSource">
\r
1578 <summary>A task representing the completion of the block.</summary>
\r
1580 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.m_owningTarget">
\r
1581 <summary>The target block using this helper.</summary>
\r
1583 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.m_dataflowBlockOptions">
\r
1584 <summary>The options associated with this block.</summary>
\r
1586 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.m_callAction">
\r
1587 <summary>An action to invoke for every accepted message.</summary>
\r
1589 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.m_targetCoreOptions">
\r
1590 <summary>Whether the block relies on the delegate to signal when an async operation has completed.</summary>
\r
1592 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.m_boundingState">
\r
1593 <summary>Bounding state for when the block is executing in bounded mode.</summary>
\r
1595 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.m_reorderingBuffer">
\r
1596 <summary>The reordering buffer used by the owner. May be null.</summary>
\r
1598 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.m_exceptions">
\r
1599 <summary>Exceptions that may have occured and gone unhandled during processing.</summary>
\r
1601 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.m_decliningPermanently">
\r
1602 <summary>Whether to stop accepting new messages.</summary>
\r
1604 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.m_numberOfOutstandingOperations">
\r
1605 <summary>The number of operations (including service tasks) currently running asynchronously.</summary>
\r
1606 <remarks>Must always be accessed from inside a lock.</remarks>
\r
1608 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.m_numberOfOutstandingServiceTasks">
\r
1609 <summary>The number of service tasks in async mode currently running.</summary>
\r
1610 <remarks>Must always be accessed from inside a lock.</remarks>
\r
1612 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.m_nextAvailableInputMessageId">
\r
1613 <summary>The next available ID we can assign to a message about to be processed.</summary>
\r
1615 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.m_completionReserved">
\r
1616 <summary>A task has reserved the right to run the completion routine.</summary>
\r
1618 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.#ctor(System.Threading.Tasks.Dataflow.ITargetBlock{`0},System.Action{System.Collections.Generic.KeyValuePair{`0,System.Int64}},System.Threading.Tasks.Dataflow.Internal.IReorderingBuffer,System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions,System.Threading.Tasks.Dataflow.Internal.TargetCoreOptions)">
\r
1619 <summary>Initializes the target core.</summary>
\r
1620 <param name="owningTarget">The target using this helper.</param>
\r
1621 <param name="callAction">An action to invoke for all accepted items.</param>
\r
1622 <param name="reorderingBuffer">The reordering buffer used by the owner; may be null.</param>
\r
1623 <param name="dataflowBlockOptions">The options to use to configure this block. The target core assumes these options are immutable.</param>
\r
1624 <param name="targetCoreOptions">Options for how the target core should behave.</param>
\r
1626 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.Complete(System.Exception,System.Boolean,System.Boolean,System.Boolean)">
\r
1627 <summary>Internal Complete entry point with extra parameters for different contexts.</summary>
\r
1628 <param name="exception">If not null, the block will be faulted.</param>
\r
1629 <param name="dropPendingMessages">If true, any unprocessed input messages will be dropped.</param>
\r
1630 <param name="storeExceptionEvenIfAlreadyCompleting">If true, an exception will be stored after m_decliningPermanently has been set to true.</param>
\r
1631 <param name="unwrapInnerExceptions">If true, exception will be treated as an AggregateException.</param>
\r
1633 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.OfferMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,`0,System.Threading.Tasks.Dataflow.ISourceBlock{`0},System.Boolean)">
\r
1635 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.
\r
1636 </summary><param name="messageHeader">
\r
1637 A <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance that represents the header of the message being offered.
\r
1638 </param><param name="messageValue">
\r
1639 The value of the message being offered.
\r
1640 </param><param name="source">
\r
1641 The <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> offering the message. This may be null (Nothing in Visual Basic).
\r
1642 </param><param name="consumeToAccept">
\r
1643 true if the target must call ConsumeMessage synchronously during the call to OfferMessage, prior to returning
\r
1644 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Accepted"/>, in order to consume the message.
\r
1645 false if the target wanting to accept the message should not call ConsumeMessage, and should isntead simply return DataflowMessageStatus.Accepted.
\r
1647 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
\r
1648 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
\r
1649 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.
\r
1650 If the target would have otherwise postponed but source was null, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is instead returned.
\r
1651 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,
\r
1652 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.NotAvailable"/> is returned.
\r
1653 If the target chose not to accept the message, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is returned. If the target
\r
1654 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.
\r
1655 </returns><exception cref="T:System.ArgumentException">
\r
1656 The <paramref name="messageHeader"/> is not valid.
\r
1657 </exception><exception cref="T:System.ArgumentException">
\r
1658 <paramref name="consumeToAccept"/> may only be true if provided with a non-null <paramref name="source"/>.
\r
1661 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.SignalOneAsyncMessageCompleted">
\r
1662 <summary>Signals to the target core that a previously launched asynchronous operation has now completed.</summary>
\r
1664 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.SignalOneAsyncMessageCompleted(System.Int32)">
\r
1665 <summary>Signals to the target core that a previously launched asynchronous operation has now completed.</summary>
\r
1666 <param name="boundingCountChange">The number of elements by which to change the bounding count, if bounding is occurring.</param>
\r
1668 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.ProcessAsyncIfNecessary(System.Boolean)">
\r
1669 <summary>Called when new messages are available to be processed.</summary>
\r
1670 <param name="repeat">Whether this call is the continuation of a previous message loop.</param>
\r
1672 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.ProcessMessagesLoopWithExecutionContext">
\r
1673 <summary>Task body used to process messages under the right execution context.</summary>
\r
1675 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.ProcessMessageLoopCore">
\r
1676 <summary>Task body used to process messages.</summary>
\r
1678 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.TryGetNextMessageForNewAsyncOperation(System.Collections.Generic.KeyValuePair{`0,System.Int64}@)">
\r
1679 <summary>Retrieves the next message from the input queue for the useAsyncCompletion mode.</summary>
\r
1680 <param name="messageWithId">The next message retrieved.</param>
\r
1681 <returns>true if a message was found and removed; otherwise, false.</returns>
\r
1683 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.TryGetNextAvailableOrPostponedMessage(System.Collections.Generic.KeyValuePair{`0,System.Int64}@)">
\r
1685 Either takes the next available message from the input queue or retrieves a postponed
\r
1686 message from a source, based on whether we're in greedy or non-greedy mode.
\r
1688 <param name="messageWithId">The retrieved item with its Id.</param>
\r
1689 <returns>true if a message could be removed and returned; otherwise, false.</returns>
\r
1691 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.TryConsumePostponedMessage(System.Collections.Generic.KeyValuePair{`0,System.Int64}@)">
\r
1692 <summary>Consumes a single postponed message.</summary>
\r
1693 <returns>true if a message was consumed; otherwise, false.</returns>
\r
1695 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.CompleteBlockIfPossible">
\r
1696 <summary>Completes the block once all completion conditions are met.</summary>
\r
1698 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.CompleteBlockOncePossible">
\r
1700 Completes the block. This must only be called once, and only once all of the completion conditions are met.
\r
1701 As such, it must only be called from CompleteBlockIfPossible.
\r
1704 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.ChangeBoundingCount(System.Int32)">
\r
1705 <summary>Increases or decreases the bounding count.</summary>
\r
1706 <param name="count">The incremental addition (positive to increase, negative to decrease).</param>
\r
1708 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.GetDebuggingInformation">
\r
1709 <summary>Gets information about this helper to be used for display in a debugger.</summary>
\r
1710 <returns>Debugging information about this target.</returns>
\r
1712 <member name="P:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.IncomingLock">
\r
1713 <summary>Gets the object used as the incoming lock.</summary>
\r
1715 <member name="P:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.Completion">
\r
1717 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
1718 </summary><remarks>
\r
1719 A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
\r
1720 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
1721 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
1722 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
1723 the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
\r
1724 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
1725 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
1726 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
1729 <member name="P:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.InputCount">
\r
1730 <summary>Gets the number of items waiting to be processed by this target.</summary>
\r
1732 <member name="P:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.UsesAsyncCompletion">
\r
1733 <summary>Gets whether this instance has been cosntructed for async processing.</summary>
\r
1735 <member name="P:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.HasRoomForMoreOperations">
\r
1736 <summary>Gets whether there's room to launch more processing operations.</summary>
\r
1738 <member name="P:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.HasRoomForMoreServiceTasks">
\r
1739 <summary>Gets whether there's room to launch more service tasks for doing/launching processing operations.</summary>
\r
1741 <member name="P:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.CanceledOrFaulted">
\r
1742 <summary>Gets whether the target has had cancellation requested or an exception has occurred.</summary>
\r
1744 <member name="P:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.IsBounded">
\r
1745 <summary>Gets whether the target core is operating in a bounded mode.</summary>
\r
1747 <member name="P:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.DebuggerDisplayContent">
\r
1748 <summary>Gets the object to display in the debugger display attribute.</summary>
\r
1750 <member name="T:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.DebuggingInformation">
\r
1751 <summary>Provides a wrapper for commonly needed debugging information.</summary>
\r
1753 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.DebuggingInformation.m_target">
\r
1754 <summary>The target being viewed.</summary>
\r
1756 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.DebuggingInformation.#ctor(System.Threading.Tasks.Dataflow.Internal.TargetCore{`0})">
\r
1757 <summary>Initializes the debugging helper.</summary>
\r
1758 <param name="target">The target being viewed.</param>
\r
1760 <member name="P:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.DebuggingInformation.InputCount">
\r
1761 <summary>Gets the number of messages waiting to be processed.</summary>
\r
1763 <member name="P:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.DebuggingInformation.InputQueue">
\r
1764 <summary>Gets the messages waiting to be processed.</summary>
\r
1766 <member name="P:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.DebuggingInformation.PostponedMessages">
\r
1767 <summary>Gets any postponed messages.</summary>
\r
1769 <member name="P:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.DebuggingInformation.CurrentDegreeOfParallelism">
\r
1770 <summary>Gets the current number of outstanding input processing operations.</summary>
\r
1772 <member name="P:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.DebuggingInformation.DataflowBlockOptions">
\r
1773 <summary>Gets the DataflowBlockOptions used to configure this block.</summary>
\r
1775 <member name="P:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.DebuggingInformation.IsDecliningPermanently">
\r
1776 <summary>Gets whether the block is declining further messages.</summary>
\r
1778 <member name="P:System.Threading.Tasks.Dataflow.Internal.TargetCore`1.DebuggingInformation.IsCompleted">
\r
1779 <summary>Gets whether the block is completed.</summary>
\r
1781 <member name="T:System.Threading.Tasks.Dataflow.DataflowBlock">
\r
1783 Provides a set of static (Shared in Visual Basic) methods for working with dataflow blocks.
\r
1786 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.LinkTo``1(System.Threading.Tasks.Dataflow.ISourceBlock{``0},System.Threading.Tasks.Dataflow.ITargetBlock{``0})">
\r
1787 <summary>Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.</summary>
\r
1788 <param name="source">The source from which to link.</param>
\r
1789 <param name="target">The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect the source.</param>
\r
1790 <returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns>
\r
1791 <exception cref="T:System.ArgumentNullException">The <paramref name="source"/> is null (Nothing in Visual Basic).</exception>
\r
1792 <exception cref="T:System.ArgumentNullException">The <paramref name="target"/> is null (Nothing in Visual Basic).</exception>
\r
1794 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.LinkTo``1(System.Threading.Tasks.Dataflow.ISourceBlock{``0},System.Threading.Tasks.Dataflow.ITargetBlock{``0},System.Predicate{``0})">
\r
1795 <summary>Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> using the specified filter.</summary>
\r
1796 <param name="source">The source from which to link.</param>
\r
1797 <param name="target">The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect the source.</param>
\r
1798 <param name="predicate">The filter a message must pass in order for it to propagate from the source to the target.</param>
\r
1799 <returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns>
\r
1800 <exception cref="T:System.ArgumentNullException">The <paramref name="source"/> is null (Nothing in Visual Basic).</exception>
\r
1801 <exception cref="T:System.ArgumentNullException">The <paramref name="target"/> is null (Nothing in Visual Basic).</exception>
\r
1802 <exception cref="T:System.ArgumentNullException">The <paramref name="predicate"/> is null (Nothing in Visual Basic).</exception>
\r
1804 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.LinkTo``1(System.Threading.Tasks.Dataflow.ISourceBlock{``0},System.Threading.Tasks.Dataflow.ITargetBlock{``0},System.Predicate{``0},System.Boolean)">
\r
1805 <summary>Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> using the specified filter.</summary>
\r
1806 <param name="source">The source from which to link.</param>
\r
1807 <param name="target">The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect the source.</param>
\r
1808 <param name="predicate">The filter a message must pass in order for it to propagate from the source to the target.</param>
\r
1809 <param name="discardsMessages">true if messages that don't meet the predicate are discarded; otherwise, false, to decline such messages.</param>
\r
1810 <returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns>
\r
1811 <exception cref="T:System.ArgumentNullException">The <paramref name="source"/> is null (Nothing in Visual Basic).</exception>
\r
1812 <exception cref="T:System.ArgumentNullException">The <paramref name="target"/> is null (Nothing in Visual Basic).</exception>
\r
1813 <exception cref="T:System.ArgumentNullException">The <paramref name="predicate"/> is null (Nothing in Visual Basic).</exception>
\r
1815 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.Post``1(System.Threading.Tasks.Dataflow.ITargetBlock{``0},``0)">
\r
1816 <summary>Posts an item to the <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.</summary>
\r
1817 <typeparam name="TInput">Specifies the type of data accepted by the target block.</typeparam>
\r
1818 <param name="target">The target block.</param>
\r
1819 <param name="item">The item being offered to the target.</param>
\r
1820 <returns>true if the item was accepted by the target block; otherwise, false.</returns>
\r
1822 This method will return once the target block has decided to accept or decline the item,
\r
1823 but unless otherwise dictated by special semantics of the target block, it does not wait
\r
1824 for the item to actually be processed (for example, <see cref="T:System.Threading.Tasks.Dataflow.ActionBlock`1"/>
\r
1825 will return from Post as soon as it has stored the posted item into its input queue). From the perspective
\r
1826 of the block's processing, Post is asynchronous. For target blocks that support postponing offered messages,
\r
1827 or for blocks that may do more processing in their Post implementation, consider using
\r
1828 <see cref="T:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsync">SendAsync</see>,
\r
1829 which will return immediately and will enable the target to postpone the posted message and later consume it
\r
1830 after SendAsync returns.
\r
1833 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsync``1(System.Threading.Tasks.Dataflow.ITargetBlock{``0},``0)">
\r
1834 <summary>Asynchronously offers a message to the target message block, allowing for postponement.</summary>
\r
1835 <typeparam name="TInput">Specifies the type of the data to post to the target.</typeparam>
\r
1836 <param name="target">The target to which to post the data.</param>
\r
1837 <param name="item">The item being offered to the target.</param>
\r
1839 A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous send. If the target
\r
1840 accepts and consumes the offered element during the call to <see cref="M:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsync``1(System.Threading.Tasks.Dataflow.ITargetBlock{``0},``0)"/>, upon return
\r
1841 from the call the resulting <see cref="T:System.Threading.Tasks.Task`1"/> will be completed and its <see cref="P:System.Threading.Tasks.Task`1.Result">Result</see>
\r
1842 property will return true. If the target declines the offered element during the call, upon return from the call the resulting <see cref="T:System.Threading.Tasks.Task`1"/> will
\r
1843 be completed and its <see cref="P:System.Threading.Tasks.Task`1.Result">Result</see> property will return false. If the target
\r
1844 postpones the offered element, the element will be buffered until such time that the target consumes or releases it, at which
\r
1845 point the Task will complete, with its<see cref="P:System.Threading.Tasks.Task`1.Result"/>indicating whether the message was consumed. If the target
\r
1846 never attempts to consume or release the message, the returned task will never complete.
\r
1848 <exception cref="T:System.ArgumentNullException">The <paramref name="target"/> is null (Nothing in Visual Basic).</exception>
\r
1850 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.TryReceive``1(System.Threading.Tasks.Dataflow.IReceivableSourceBlock{``0},``0@)">
\r
1852 Attempts to synchronously receive an item from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
1854 <param name="source">The source from which to receive.</param>
\r
1855 <param name="item">The item received from the source.</param>
\r
1856 <returns>true if an item could be received; otherwise, false.</returns>
\r
1858 This method does not wait until the source has an item to provide.
\r
1859 It will return whether or not an element was available.
\r
1862 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveAsync``1(System.Threading.Tasks.Dataflow.ISourceBlock{``0})">
\r
1863 <summary>Asynchronously receives a value from the specified source.</summary>
\r
1864 <typeparam name="TOutput">Specifies the type of data contained in the source.</typeparam>
\r
1865 <param name="source">The source from which to asynchronously receive.</param>
\r
1867 A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous receive operation. When an item is successfully received from the source,
\r
1868 the returned task will be completed and its <see cref="P:System.Threading.Tasks.Task`1.Result">Result</see> will return the received item. If an item cannot be retrieved,
\r
1869 because the source is empty and completed, the returned task will be canceled.
\r
1871 <exception cref="T:System.ArgumentNullException">The <paramref name="source"/> is null (Nothing in Visual Basic).</exception>
\r
1873 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveAsync``1(System.Threading.Tasks.Dataflow.ISourceBlock{``0},System.Threading.CancellationToken)">
\r
1874 <summary>Asynchronously receives a value from the specified source.</summary>
\r
1875 <typeparam name="TOutput">Specifies the type of data contained in the source.</typeparam>
\r
1876 <param name="source">The source from which to asynchronously receive.</param>
\r
1877 <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> which may be used to cancel the receive operation.</param>
\r
1879 A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous receive operation. When an item is successfully received from the source,
\r
1880 the returned task will be completed and its <see cref="P:System.Threading.Tasks.Task`1.Result">Result</see> will return the received item. If an item cannot be retrieved,
\r
1881 either because cancellation is requested or the source is empty and completed, the returned task will be canceled.
\r
1883 <exception cref="T:System.ArgumentNullException">The <paramref name="source"/> is null (Nothing in Visual Basic).</exception>
\r
1885 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveAsync``1(System.Threading.Tasks.Dataflow.ISourceBlock{``0},System.TimeSpan)">
\r
1886 <summary>Asynchronously receives a value from the specified source.</summary>
\r
1887 <typeparam name="TOutput">Specifies the type of data contained in the source.</typeparam>
\r
1888 <param name="source">The source from which to asynchronously receive.</param>
\r
1889 <param name="timeout">A <see cref="T:System.TimeSpan"/> that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.</param>
\r
1891 A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous receive operation. When an item is successfully received from the source,
\r
1892 the returned task will be completed and its <see cref="P:System.Threading.Tasks.Task`1.Result">Result</see> will return the received item. If an item cannot be retrieved,
\r
1893 either because the timeout expires or the source is empty and completed, the returned task will be canceled.
\r
1895 <exception cref="T:System.ArgumentNullException">The <paramref name="source"/> is null (Nothing in Visual Basic).</exception>
\r
1896 <exception cref="T:System.ArgumentOutOfRangeException">
\r
1897 timeout is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than <see cref="F:System.Int32.MaxValue"/>.
\r
1900 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveAsync``1(System.Threading.Tasks.Dataflow.ISourceBlock{``0},System.TimeSpan,System.Threading.CancellationToken)">
\r
1901 <summary>Asynchronously receives a value from the specified source.</summary>
\r
1902 <typeparam name="TOutput">Specifies the type of data contained in the source.</typeparam>
\r
1903 <param name="source">The source from which to asynchronously receive.</param>
\r
1904 <param name="timeout">A <see cref="T:System.TimeSpan"/> that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.</param>
\r
1905 <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> which may be used to cancel the receive operation.</param>
\r
1907 A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous receive operation. When an item is successfully received from the source,
\r
1908 the returned task will be completed and its <see cref="P:System.Threading.Tasks.Task`1.Result">Result</see> will return the received item. If an item cannot be retrieved,
\r
1909 either because the timeout expires, cancellation is requested, or the source is empty and completed, the returned task will be canceled.
\r
1911 <exception cref="T:System.ArgumentNullException">The <paramref name="source"/> is null (Nothing in Visual Basic).</exception>
\r
1912 <exception cref="T:System.ArgumentOutOfRangeException">
\r
1913 timeout is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than <see cref="F:System.Int32.MaxValue"/>.
\r
1916 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.Receive``1(System.Threading.Tasks.Dataflow.ISourceBlock{``0})">
\r
1917 <summary>Synchronously receives an item from the source.</summary>
\r
1918 <typeparam name="TOutput">Specifies the type of data contained in the source.</typeparam>
\r
1919 <param name="source">The source from which to receive.</param>
\r
1920 <returns>The received item.</returns>
\r
1921 <exception cref="T:System.ArgumentNullException">The <paramref name="source"/> is null (Nothing in Visual Basic).</exception>
\r
1922 <exception cref="T:System.InvalidOperationException">No item could be received from the source.</exception>
\r
1924 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.Receive``1(System.Threading.Tasks.Dataflow.ISourceBlock{``0},System.Threading.CancellationToken)">
\r
1925 <summary>Synchronously receives an item from the source.</summary>
\r
1926 <typeparam name="TOutput">Specifies the type of data contained in the source.</typeparam>
\r
1927 <param name="source">The source from which to receive.</param>
\r
1928 <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> which may be used to cancel the receive operation.</param>
\r
1929 <returns>The received item.</returns>
\r
1930 <exception cref="T:System.ArgumentNullException">The <paramref name="source"/> is null (Nothing in Visual Basic).</exception>
\r
1931 <exception cref="T:System.InvalidOperationException">No item could be received from the source.</exception>
\r
1932 <exception cref="T:System.OperationCanceledException">The operation was canceled before an item was received from the source.</exception>
\r
1934 If the source successfully offered an item that was received by this operation, it will be returned, even if a concurrent cancellation request occurs.
\r
1937 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.Receive``1(System.Threading.Tasks.Dataflow.ISourceBlock{``0},System.TimeSpan)">
\r
1938 <summary>Synchronously receives an item from the source.</summary>
\r
1939 <typeparam name="TOutput">Specifies the type of data contained in the source.</typeparam>
\r
1940 <param name="source">The source from which to receive.</param>
\r
1941 <param name="timeout">A <see cref="T:System.TimeSpan"/> that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.</param>
\r
1942 <returns>The received item.</returns>
\r
1943 <exception cref="T:System.ArgumentOutOfRangeException">
\r
1944 timeout is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than <see cref="F:System.Int32.MaxValue"/>.
\r
1946 <exception cref="T:System.ArgumentNullException">The <paramref name="source"/> is null (Nothing in Visual Basic).</exception>
\r
1947 <exception cref="T:System.InvalidOperationException">No item could be received from the source.</exception>
\r
1948 <exception cref="T:System.TimeoutException">The specified timeout expired before an item was received from the source.</exception>
\r
1950 If the source successfully offered an item that was received by this operation, it will be returned, even if a concurrent timeout occurs.
\r
1953 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.Receive``1(System.Threading.Tasks.Dataflow.ISourceBlock{``0},System.TimeSpan,System.Threading.CancellationToken)">
\r
1954 <summary>Synchronously receives an item from the source.</summary>
\r
1955 <typeparam name="TOutput">Specifies the type of data contained in the source.</typeparam>
\r
1956 <param name="source">The source from which to receive.</param>
\r
1957 <param name="timeout">A <see cref="T:System.TimeSpan"/> that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.</param>
\r
1958 <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> which may be used to cancel the receive operation.</param>
\r
1959 <returns>The received item.</returns>
\r
1960 <exception cref="T:System.ArgumentNullException">The <paramref name="source"/> is null (Nothing in Visual Basic).</exception>
\r
1961 <exception cref="T:System.ArgumentOutOfRangeException">
\r
1962 timeout is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than <see cref="F:System.Int32.MaxValue"/>.
\r
1964 <exception cref="T:System.InvalidOperationException">No item could be received from the source.</exception>
\r
1965 <exception cref="T:System.TimeoutException">The specified timeout expired before an item was received from the source.</exception>
\r
1966 <exception cref="T:System.OperationCanceledException">The operation was canceled before an item was received from the source.</exception>
\r
1968 If the source successfully offered an item that was received by this operation, it will be returned, even if a concurrent timeout or cancellation request occurs.
\r
1971 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveCore``1(System.Threading.Tasks.Dataflow.ISourceBlock{``0},System.Boolean,System.TimeSpan,System.Threading.CancellationToken)">
\r
1972 <summary>Receives an item from the source.</summary>
\r
1973 <typeparam name="TOutput">Specifies the type of data contained in the source.</typeparam>
\r
1974 <param name="source">The source from which to receive.</param>
\r
1975 <param name="attemptTryReceive">Whether to first attempt using TryReceive to get a value from the source.</param>
\r
1976 <param name="timeout">A <see cref="T:System.TimeSpan"/> that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.</param>
\r
1977 <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> which may be used to cancel the receive operation.</param>
\r
1978 <returns>A Task for the receive operation.</returns>
\r
1980 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveCoreByLinking``1(System.Threading.Tasks.Dataflow.ISourceBlock{``0},System.Int32,System.Threading.CancellationToken)">
\r
1981 <summary>Receives an item from the source by linking a temporary target from it.</summary>
\r
1982 <typeparam name="TOutput">Specifies the type of data contained in the source.</typeparam>
\r
1983 <param name="source">The source from which to receive.</param>
\r
1984 <param name="millisecondsTimeout">The number of milliseconds to wait, or -1 to wait indefinitely.</param>
\r
1985 <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> which may be used to cancel the receive operation.</param>
\r
1987 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.OutputAvailableAsync``1(System.Threading.Tasks.Dataflow.ISourceBlock{``0})">
\r
1989 Provides a <see cref="T:System.Threading.Tasks.Task`1"/>
\r
1990 that asynchronously monitors the source for available output.
\r
1992 <typeparam name="TOutput">Specifies the type of data contained in the source.</typeparam>
\r
1993 <param name="source">The source to monitor.</param>
\r
1995 A <see cref="T:System.Threading.Tasks.Task`1"/> that informs of whether and when
\r
1996 more output is available. When the task completes, if it's<see cref="P:System.Threading.Tasks.Task`1.Result"/> is true, more output
\r
1997 is available in the source (though another consumer of the source may retrieve the data).
\r
1998 If it returns false, more output is not and will never be available, due to the source
\r
1999 completing prior to output being available.
\r
2002 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.Encapsulate``2(System.Threading.Tasks.Dataflow.ITargetBlock{``0},System.Threading.Tasks.Dataflow.ISourceBlock{``1})">
\r
2003 <summary>Encapsulates a target and a source into a single propagator.</summary>
\r
2004 <typeparam name="TInput">Specifies the type of input expected by the target.</typeparam>
\r
2005 <typeparam name="TOutput">Specifies the type of output produced by the source.</typeparam>
\r
2006 <param name="target">The target to encapsulate.</param>
\r
2007 <param name="source">The source to encapsulate.</param>
\r
2008 <returns>The encapsulated target and source.</returns>
\r
2010 This method does not in any way connect the target to the source. It creates a
\r
2011 propagator block whose target methods delegate to the specified target and whose
\r
2012 source methods delegate to the specified source. Any connection between the target
\r
2013 and the source is left for the developer to explicitly provide. The propagator's
\r
2014 <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> implementation delegates to the specified source.
\r
2017 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.Choose``2(System.Threading.Tasks.Dataflow.ISourceBlock{``0},System.Action{``0},System.Threading.Tasks.Dataflow.ISourceBlock{``1},System.Action{``1})">
\r
2018 <summary>Monitors two dataflow sources, invoking the provided handler for whichever source makes data available first.</summary>
\r
2019 <typeparam name="T1">Specifies type of data contained in the first source.</typeparam>
\r
2020 <typeparam name="T2">Specifies type of data contained in the second source.</typeparam>
\r
2021 <param name="source1">The first source.</param>
\r
2022 <param name="action1">The handler to execute on data from the first source.</param>
\r
2023 <param name="source2">The second source.</param>
\r
2024 <param name="action2">The handler to execute on data from the second source.</param>
\r
2027 A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous choice.
\r
2028 If both sources are completed prior to the choice completing,
\r
2029 the resulting task will be canceled. When one of the sources has data available and successfully propagates
\r
2030 it to the choice, the resulting task will complete when the handler completes: if the handler throws an exception,
\r
2031 the task will end in the <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state containing the unhandled exception, otherwise the task
\r
2032 will end with its <see cref="P:System.Threading.Tasks.Task`1.Result"/> set to either 0 or 1 to
\r
2033 represent the first or second source, respectively.
\r
2036 This method will only consume an element from one of the two data sources, never both.
\r
2039 <exception cref="T:System.ArgumentNullException">The <paramref name="source1"/> is null (Nothing in Visual Basic).</exception>
\r
2040 <exception cref="T:System.ArgumentNullException">The <paramref name="action1"/> is null (Nothing in Visual Basic).</exception>
\r
2041 <exception cref="T:System.ArgumentNullException">The <paramref name="source2"/> is null (Nothing in Visual Basic).</exception>
\r
2042 <exception cref="T:System.ArgumentNullException">The <paramref name="action2"/> is null (Nothing in Visual Basic).</exception>
\r
2044 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.Choose``2(System.Threading.Tasks.Dataflow.ISourceBlock{``0},System.Action{``0},System.Threading.Tasks.Dataflow.ISourceBlock{``1},System.Action{``1},System.Threading.Tasks.Dataflow.DataflowBlockOptions)">
\r
2045 <summary>Monitors two dataflow sources, invoking the provided handler for whichever source makes data available first.</summary>
\r
2046 <typeparam name="T1">Specifies type of data contained in the first source.</typeparam>
\r
2047 <typeparam name="T2">Specifies type of data contained in the second source.</typeparam>
\r
2048 <param name="source1">The first source.</param>
\r
2049 <param name="action1">The handler to execute on data from the first source.</param>
\r
2050 <param name="source2">The second source.</param>
\r
2051 <param name="action2">The handler to execute on data from the second source.</param>
\r
2052 <param name="dataflowBlockOptions">The options with which to configure this choice.</param>
\r
2055 A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous choice.
\r
2056 If both sources are completed prior to the choice completing, or if the CancellationToken
\r
2057 provided as part of <paramref name="dataflowBlockOptions"/> is canceled prior to the choice completing,
\r
2058 the resulting task will be canceled. When one of the sources has data available and successfully propagates
\r
2059 it to the choice, the resulting task will complete when the handler completes: if the handler throws an exception,
\r
2060 the task will end in the <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state containing the unhandled exception, otherwise the task
\r
2061 will end with its <see cref="P:System.Threading.Tasks.Task`1.Result"/> set to either 0 or 1 to
\r
2062 represent the first or second source, respectively.
\r
2065 This method will only consume an element from one of the two data sources, never both.
\r
2066 If cancellation is requested after an element has been received, the cancellation request will be ignored,
\r
2067 and the relevant handler will be allowed to execute.
\r
2070 <exception cref="T:System.ArgumentNullException">The <paramref name="source1"/> is null (Nothing in Visual Basic).</exception>
\r
2071 <exception cref="T:System.ArgumentNullException">The <paramref name="action1"/> is null (Nothing in Visual Basic).</exception>
\r
2072 <exception cref="T:System.ArgumentNullException">The <paramref name="source2"/> is null (Nothing in Visual Basic).</exception>
\r
2073 <exception cref="T:System.ArgumentNullException">The <paramref name="action2"/> is null (Nothing in Visual Basic).</exception>
\r
2074 <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
\r
2076 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.Choose``3(System.Threading.Tasks.Dataflow.ISourceBlock{``0},System.Action{``0},System.Threading.Tasks.Dataflow.ISourceBlock{``1},System.Action{``1},System.Threading.Tasks.Dataflow.ISourceBlock{``2},System.Action{``2})">
\r
2077 <summary>Monitors two dataflow sources, invoking the provided handler for whichever source makes data available first.</summary>
\r
2078 <typeparam name="T1">Specifies type of data contained in the first source.</typeparam>
\r
2079 <typeparam name="T2">Specifies type of data contained in the second source.</typeparam>
\r
2080 <typeparam name="T3">Specifies type of data contained in the third source.</typeparam>
\r
2081 <param name="source1">The first source.</param>
\r
2082 <param name="action1">The handler to execute on data from the first source.</param>
\r
2083 <param name="source2">The second source.</param>
\r
2084 <param name="action2">The handler to execute on data from the second source.</param>
\r
2085 <param name="source3">The third source.</param>
\r
2086 <param name="action3">The handler to execute on data from the third source.</param>
\r
2089 A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous choice.
\r
2090 If all sources are completed prior to the choice completing,
\r
2091 the resulting task will be canceled. When one of the sources has data available and successfully propagates
\r
2092 it to the choice, the resulting task will complete when the handler completes: if the handler throws an exception,
\r
2093 the task will end in the <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state containing the unhandled exception, otherwise the task
\r
2094 will end with its <see cref="P:System.Threading.Tasks.Task`1.Result"/> set to the 0-based index of the source.
\r
2097 This method will only consume an element from one of the data sources, never more than one.
\r
2100 <exception cref="T:System.ArgumentNullException">The <paramref name="source1"/> is null (Nothing in Visual Basic).</exception>
\r
2101 <exception cref="T:System.ArgumentNullException">The <paramref name="action1"/> is null (Nothing in Visual Basic).</exception>
\r
2102 <exception cref="T:System.ArgumentNullException">The <paramref name="source2"/> is null (Nothing in Visual Basic).</exception>
\r
2103 <exception cref="T:System.ArgumentNullException">The <paramref name="action2"/> is null (Nothing in Visual Basic).</exception>
\r
2104 <exception cref="T:System.ArgumentNullException">The <paramref name="source3"/> is null (Nothing in Visual Basic).</exception>
\r
2105 <exception cref="T:System.ArgumentNullException">The <paramref name="action3"/> is null (Nothing in Visual Basic).</exception>
\r
2107 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.Choose``3(System.Threading.Tasks.Dataflow.ISourceBlock{``0},System.Action{``0},System.Threading.Tasks.Dataflow.ISourceBlock{``1},System.Action{``1},System.Threading.Tasks.Dataflow.ISourceBlock{``2},System.Action{``2},System.Threading.Tasks.Dataflow.DataflowBlockOptions)">
\r
2108 <summary>Monitors two dataflow sources, invoking the provided handler for whichever source makes data available first.</summary>
\r
2109 <typeparam name="T1">Specifies type of data contained in the first source.</typeparam>
\r
2110 <typeparam name="T2">Specifies type of data contained in the second source.</typeparam>
\r
2111 <typeparam name="T3">Specifies type of data contained in the third source.</typeparam>
\r
2112 <param name="source1">The first source.</param>
\r
2113 <param name="action1">The handler to execute on data from the first source.</param>
\r
2114 <param name="source2">The second source.</param>
\r
2115 <param name="action2">The handler to execute on data from the second source.</param>
\r
2116 <param name="source3">The third source.</param>
\r
2117 <param name="action3">The handler to execute on data from the third source.</param>
\r
2118 <param name="dataflowBlockOptions">The options with which to configure this choice.</param>
\r
2121 A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous choice.
\r
2122 If all sources are completed prior to the choice completing, or if the CancellationToken
\r
2123 provided as part of <paramref name="dataflowBlockOptions"/> is canceled prior to the choice completing,
\r
2124 the resulting task will be canceled. When one of the sources has data available and successfully propagates
\r
2125 it to the choice, the resulting task will complete when the handler completes: if the handler throws an exception,
\r
2126 the task will end in the <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state containing the unhandled exception, otherwise the task
\r
2127 will end with its <see cref="P:System.Threading.Tasks.Task`1.Result"/> set to the 0-based index of the source.
\r
2130 This method will only consume an element from one of the data sources, never more than one.
\r
2131 If cancellation is requested after an element has been received, the cancellation request will be ignored,
\r
2132 and the relevant handler will be allowed to execute.
\r
2135 <exception cref="T:System.ArgumentNullException">The <paramref name="source1"/> is null (Nothing in Visual Basic).</exception>
\r
2136 <exception cref="T:System.ArgumentNullException">The <paramref name="action1"/> is null (Nothing in Visual Basic).</exception>
\r
2137 <exception cref="T:System.ArgumentNullException">The <paramref name="source2"/> is null (Nothing in Visual Basic).</exception>
\r
2138 <exception cref="T:System.ArgumentNullException">The <paramref name="action2"/> is null (Nothing in Visual Basic).</exception>
\r
2139 <exception cref="T:System.ArgumentNullException">The <paramref name="source3"/> is null (Nothing in Visual Basic).</exception>
\r
2140 <exception cref="T:System.ArgumentNullException">The <paramref name="action3"/> is null (Nothing in Visual Basic).</exception>
\r
2141 <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
\r
2143 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.CreateChooseBranch``1(System.Runtime.CompilerServices.StrongBox{System.Threading.Tasks.Task},System.Threading.CancellationTokenSource,System.Threading.Tasks.TaskCompletionSource{System.Int32},System.Threading.Tasks.TaskScheduler,System.Int32,System.Threading.Tasks.Dataflow.ISourceBlock{``0},System.Action{``0})">
\r
2144 <summary>Creates a target for a branch of a Choose.</summary>
\r
2145 <typeparam name="T">Specifies the type of data coming through this branch.</typeparam>
\r
2146 <param name="boxedCompleted">A strong box around the completed Task from any target. Also sync obj for access to the targets.</param>
\r
2147 <param name="cts">The CancellationTokenSource used to issue tear down / cancellation requests.</param>
\r
2148 <param name="result">The result task used to represent the overall Choose operation.</param>
\r
2149 <param name="scheduler">The TaskScheduler on which to scheduler work.</param>
\r
2150 <param name="branchId">The ID of this branch, used to complete the resultTask.</param>
\r
2151 <param name="source">The source with which this branch is associated.</param>
\r
2152 <param name="action">The action to run for a single element received from the source.</param>
\r
2153 <returns>A task representing the branch.</returns>
\r
2155 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.AsObservable``1(System.Threading.Tasks.Dataflow.ISourceBlock{``0})">
\r
2156 <summary>Creates a new <see cref="T:System.IObservable`1"/> abstraction over the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.</summary>
\r
2157 <typeparam name="TOutput">Specifies the type of data contained in the source.</typeparam>
\r
2158 <param name="source">The source to wrap.</param>
\r
2159 <returns>An IObservable{TOutput} that enables observers to be subscribed to the source.</returns>
\r
2160 <exception cref="T:System.ArgumentNullException">The <paramref name="source"/> is null (Nothing in Visual Basic).</exception>
\r
2162 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.s_nonGreedyExecutionOptions">
\r
2163 <summary>Cached options for non-greedy processing.</summary>
\r
2165 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.AsObserver``1(System.Threading.Tasks.Dataflow.ITargetBlock{``0})">
\r
2166 <summary>Creates a new <see cref="T:System.IObserver`1"/> abstraction over the <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.</summary>
\r
2167 <typeparam name="TInput">Specifies the type of input accepted by the target block.</typeparam>
\r
2168 <param name="target">The target to wrap.</param>
\r
2169 <returns>An observer that wraps the target block.</returns>
\r
2171 <member name="T:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1">
\r
2172 <summary>Provides a synchronous filter for use in filtered LinkTos.</summary>
\r
2173 <typeparam name="T">Specifies the type of data being filtered.</typeparam>
\r
2175 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.m_source">
\r
2176 <summary>The source connected with this filter.</summary>
\r
2178 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.m_target">
\r
2179 <summary>The target with which this block is associated.</summary>
\r
2181 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.m_userProvidedPredicate">
\r
2182 <summary>The predicate provided by the user.</summary>
\r
2184 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.m_discardsMessages">
\r
2185 <summary>Whether to accept and drop messages that don't meet the filter.</summary>
\r
2187 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.m_executionContext">
\r
2188 <summary>The execution context captured when this propagator was instantiated.</summary>
\r
2190 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.#ctor(System.Threading.Tasks.Dataflow.ISourceBlock{`0},System.Threading.Tasks.Dataflow.ITargetBlock{`0},System.Predicate{`0},System.Boolean)">
\r
2191 <summary>Initializes the filter passthrough.</summary>
\r
2192 <param name="source">The source connected to this filter.</param>
\r
2193 <param name="target">The target to which filtered messages should be passed.</param>
\r
2194 <param name="predicate">The predicate to run for each messsage.</param>
\r
2195 <param name="discardsMessages">Whether to accept and drop messages that don't meet the filter.</param>
\r
2197 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.RunPredicate(`0)">
\r
2198 <summary>Runs the user-provided predicate over an item in the correct execution context.</summary>
\r
2199 <param name="item">The item to evaluate.</param>
\r
2200 <returns>true if the item passed the filter; otherwise, false.</returns>
\r
2202 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.System#Threading#Tasks#Dataflow#ITargetBlock{T}#OfferMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,`0,System.Threading.Tasks.Dataflow.ISourceBlock{`0},System.Boolean)">
\r
2204 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.
\r
2205 </summary><param name="messageHeader">
\r
2206 A <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance that represents the header of the message being offered.
\r
2207 </param><param name="messageValue">
\r
2208 The value of the message being offered.
\r
2209 </param><param name="source">
\r
2210 The <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> offering the message. This may be null (Nothing in Visual Basic).
\r
2211 </param><param name="consumeToAccept">
\r
2212 true if the target must call ConsumeMessage synchronously during the call to OfferMessage, prior to returning
\r
2213 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Accepted"/>, in order to consume the message.
\r
2214 false if the target wanting to accept the message should not call ConsumeMessage, and should isntead simply return DataflowMessageStatus.Accepted.
\r
2216 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
\r
2217 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
\r
2218 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.
\r
2219 If the target would have otherwise postponed but source was null, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is instead returned.
\r
2220 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,
\r
2221 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.NotAvailable"/> is returned.
\r
2222 If the target chose not to accept the message, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is returned. If the target
\r
2223 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.
\r
2224 </returns><exception cref="T:System.ArgumentException">
\r
2225 The <paramref name="messageHeader"/> is not valid.
\r
2226 </exception><exception cref="T:System.ArgumentException">
\r
2227 <paramref name="consumeToAccept"/> may only be true if provided with a non-null <paramref name="source"/>.
\r
2230 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.System#Threading#Tasks#Dataflow#ISourceBlock{T}#ConsumeMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0},System.Boolean@)">
\r
2232 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to accept and consume a
\r
2233 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> previously offered by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
2234 </summary><param name="messageHeader">The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being consumed.</param><param name="target">
\r
2235 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> consuming the message.
\r
2236 </param><param name="messageConsumed">
\r
2237 True if the message was successfully consumed. False otherwise.
\r
2240 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
\r
2241 passed as the <paramref name="messageHeader"/> to <see cref="M:ConsumeMessage"/>. The consuming <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must
\r
2242 use the returned value instead of the value passed as messageValue through <see cref="M:OfferMessage"/>.
\r
2245 If the message requested is not available, the return value will be null (Nothing in Visual Basic).
\r
2247 </returns><exception cref="T:System.ArgumentException">
\r
2248 The <paramref name="messageHeader"/> is not valid.
\r
2249 </exception><exception cref="T:System.ArgumentNullException">
\r
2250 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
2251 </exception><remarks>
\r
2253 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
2254 instance may use <see cref="M:ConsumeMessage"/>, and it must only be used
\r
2255 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
2256 offered by this source to the target.
\r
2260 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.System#Threading#Tasks#Dataflow#ISourceBlock{T}#ReserveMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
\r
2262 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"/>
\r
2263 by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
2264 </summary><param name="messageHeader">
\r
2265 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being reserved.
\r
2266 </param><param name="target">
\r
2267 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> reserving the message.
\r
2268 </param><returns>true if the message was successfully reserved; otherwise, false.</returns><exception cref="T:System.ArgumentException">
\r
2269 The <paramref name="messageHeader"/> is not valid.
\r
2270 </exception><exception cref="T:System.ArgumentNullException">
\r
2271 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
2272 </exception><remarks>
\r
2274 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> instance
\r
2275 may use <see cref="M:ReserveMessage"/>, and it must only be used
\r
2276 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
2277 offered by this source to the target.
\r
2280 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.
\r
2281 Failure to do so may result in the source being unable to propagate any further messages to this or other targets.
\r
2284 <see cref="M:ReserveMessage"/> must not be called while the target is holding any internal locks. Doing so will violate the lock hierarchy
\r
2285 necessary to avoid deadlocks in a dataflow network.
\r
2289 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.System#Threading#Tasks#Dataflow#ISourceBlock{T}#ReleaseReservation(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
\r
2291 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to release a previously reserved
\r
2292 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
2293 </summary><param name="messageHeader">
\r
2294 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the reserved message being released.
\r
2295 </param><param name="target">
\r
2296 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> releasing the message it previously reserved.
\r
2297 </param><exception cref="T:System.ArgumentException">
\r
2298 The <paramref name="messageHeader"/> is not valid.
\r
2299 </exception><exception cref="T:System.ArgumentNullException">
\r
2300 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
2301 </exception><exception cref="T:System.InvalidOperationException">
\r
2302 The <paramref name="target"/> did not have the message reserved.
\r
2303 </exception><remarks>
\r
2305 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
2306 instance may use <see cref="M:ReleaseMessage"/>, and it must only be used
\r
2307 to release <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
2308 and successfully reserved by the target.
\r
2312 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Complete">
\r
2314 Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
\r
2315 nor produce any more messages nor consume any more postponed messages.
\r
2316 </summary><remarks>
\r
2317 After Complete has been called on a dataflow block, that block will complete
\r
2318 (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
\r
2319 available data. Complete will not block waiting for completion to occur, but rather will initiaite
\r
2320 the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
\r
2323 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
\r
2325 Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a
\r
2326 <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
\r
2327 </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
\r
2328 The <paramref name="exception"/> is null (Nothing in Visual Basic).
\r
2329 </exception><remarks>
\r
2330 After Fault has been called on a dataflow block, that block will complete
\r
2331 (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes
\r
2332 buffered messages (uprocessed input messages as well as unoffered output messages) to be lost.
\r
2335 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.System#Threading#Tasks#Dataflow#ISourceBlock{T}#LinkTo(System.Threading.Tasks.Dataflow.ITargetBlock{`0},System.Boolean)">
\r
2337 Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.
\r
2338 </summary><param name="target">
\r
2339 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect this source.
\r
2340 </param><param name="unlinkAfterOne">
\r
2341 true if the source should unlink from the target after successfully propagating a single message;
\r
2342 otherwise, false to remain connected even after a single message has been propagated.
\r
2343 </param><returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns><exception cref="T:System.ArgumentNullException">
\r
2344 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
2347 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Completion">
\r
2349 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
2350 </summary><remarks>
\r
2351 A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
\r
2352 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
2353 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
2354 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
2355 the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
\r
2356 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
2357 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
2358 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
2361 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.DebuggerDisplayContent">
\r
2362 <summary>The data to display in the debugger display attribute.</summary>
\r
2364 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
\r
2365 <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
\r
2367 <member name="T:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.PredicateContextState">
\r
2368 <summary>Manually closes over state necessary in FilteredLinkPropagator.</summary>
\r
2370 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.PredicateContextState.Input">
\r
2371 <summary>The input to be filtered.</summary>
\r
2373 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.PredicateContextState.Predicate">
\r
2374 <summary>The predicate function.</summary>
\r
2376 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.PredicateContextState.Output">
\r
2377 <summary>The result of the filtering operation.</summary>
\r
2379 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.PredicateContextState.#ctor(`0,System.Predicate{`0})">
\r
2380 <summary>Initializes the predicate state.</summary>
\r
2381 <param name="input">The input to be filtered.</param>
\r
2382 <param name="predicate">The predicate function.</param>
\r
2384 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.PredicateContextState.Run">
\r
2385 <summary>Runs the predicate function over the input and stores the result into the output.</summary>
\r
2387 <member name="T:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.DebugView">
\r
2388 <summary>Provides a debugger type proxy for a filter.</summary>
\r
2390 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.DebugView.m_filter">
\r
2391 <summary>The filter.</summary>
\r
2393 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.DebugView.#ctor(System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator{`0})">
\r
2394 <summary>Initializes the debug view.</summary>
\r
2395 <param name="filter">The filter to view.</param>
\r
2397 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.DebugView.LinkedTarget">
\r
2398 <summary>The linked target for this filter.</summary>
\r
2400 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.FilteredLinkPropagator`1.DebugView.DiscardsMessages">
\r
2401 <summary>Whether the filter is discarding messages.</summary>
\r
2403 <member name="T:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1">
\r
2405 Provides a source used by SendAsync that will buffer a single message and signal when it's been accepted or declined.
\r
2407 <remarks>This source must only be passed to a single target, and must only be used once.</remarks>
\r
2409 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.m_target">
\r
2410 <summary>The target to offer to.</summary>
\r
2412 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.m_messageValue">
\r
2413 <summary>The buffered message.</summary>
\r
2415 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.#ctor(System.Threading.Tasks.Dataflow.ITargetBlock{`0},`0)">
\r
2416 <summary>Initializes the source.</summary>
\r
2417 <param name="target">The target to offer to.</param>
\r
2418 <param name="messageValue">The message to offer and buffer.</param>
\r
2420 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.Finalize">
\r
2421 <summary>Finalizer that completes the returned task if all references to this source are dropped.</summary>
\r
2423 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.CompleteAsAccepted(System.Boolean)">
\r
2424 <summary>Completes the source in an "Accepted" state.</summary>
\r
2425 <param name="runAsync">true to accept asynchronously; false to accept synchronously.</param>
\r
2427 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.CompleteAsDeclined(System.Boolean)">
\r
2428 <summary>Completes the source in an "Declined" state.</summary>
\r
2429 <param name="runAsync">true to decline asynchronously; false to decline synchronously.</param>
\r
2431 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.CompleteAsFaulted(System.Exception,System.Boolean)">
\r
2432 <summary>Completes the source in faulted state.</summary>
\r
2433 <param name="exception">The exception with which to fault.</param>
\r
2434 <param name="runAsync">true to fault asynchronously; false to fault synchronously.</param>
\r
2436 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.RunCompletionAction(System.Action{System.Object},System.Object,System.Boolean)">
\r
2437 <summary>Executes a completion action.</summary>
\r
2438 <param name="completionAction">The action to execute, passed the state.</param>
\r
2439 <param name="completionActionState">The state to pass into the delegate.</param>
\r
2440 <param name="runAsync">true to execute the action asynchronously; false to execute it synchronously.</param>
\r
2442 async should be true if this is being called on a path that has the target on the stack, e.g.
\r
2443 the target is calling to ConsumeMessage. We don't want to block the target indefinitely
\r
2444 with any synchronous continuations off of the returned send async task.
\r
2447 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.OfferToTargetAsync">
\r
2448 <summary>Offers the message to the target asynchronously.</summary>
\r
2450 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.OfferToTarget">
\r
2451 <summary>Offers the message to the target synchronously.</summary>
\r
2453 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.System#Threading#Tasks#Dataflow#ISourceBlock{TOutput}#ConsumeMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0},System.Boolean@)">
\r
2454 <summary>Called by the target to consume the buffered message.</summary>
\r
2456 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.System#Threading#Tasks#Dataflow#ISourceBlock{TOutput}#ReserveMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
\r
2457 <summary>Called by the target to reserve the buffered message.</summary>
\r
2459 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.System#Threading#Tasks#Dataflow#ISourceBlock{TOutput}#ReleaseReservation(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
\r
2460 <summary>Called by the target to release a reservation on the buffered message.</summary>
\r
2462 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.System#Threading#Tasks#Dataflow#ISourceBlock{TOutput}#LinkTo(System.Threading.Tasks.Dataflow.ITargetBlock{`0},System.Boolean)">
\r
2463 <summary>Not supported.</summary>
\r
2465 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Complete">
\r
2466 <summary>Not supported.</summary>
\r
2468 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
\r
2470 Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a
\r
2471 <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
\r
2472 </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
\r
2473 The <paramref name="exception"/> is null (Nothing in Visual Basic).
\r
2474 </exception><remarks>
\r
2475 After Fault has been called on a dataflow block, that block will complete
\r
2476 (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes
\r
2477 buffered messages (uprocessed input messages as well as unoffered output messages) to be lost.
\r
2480 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Completion">
\r
2481 <summary>Not supported.</summary>
\r
2483 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.DebuggerDisplayContent">
\r
2484 <summary>The data to display in the debugger display attribute.</summary>
\r
2486 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
\r
2487 <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
\r
2489 <member name="T:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.DebugView">
\r
2490 <summary>Provides a debugger type proxy for the source.</summary>
\r
2492 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.DebugView.m_source">
\r
2493 <summary>The source.</summary>
\r
2495 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.DebugView.#ctor(System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource{`0})">
\r
2496 <summary>Initializes the debug view.</summary>
\r
2497 <param name="source">The source to view.</param>
\r
2499 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.DebugView.Target">
\r
2500 <summary>The target to which we're linked.</summary>
\r
2502 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.DebugView.Message">
\r
2503 <summary>The message buffered by the source.</summary>
\r
2505 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.SendAsyncSource`1.DebugView.Completion">
\r
2506 <summary>The Task represented the posting of the message.</summary>
\r
2508 <member name="T:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveCoreByLinkingCleanupReason">
\r
2509 <summary>The reason for a ReceiveCoreByLinking call failing.</summary>
\r
2511 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveCoreByLinkingCleanupReason.Success">
\r
2512 <summary>The Receive operation completed successfully, obtaining a value from the source.</summary>
\r
2514 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveCoreByLinkingCleanupReason.Timer">
\r
2515 <summary>The timer expired before a value could be received.</summary>
\r
2517 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveCoreByLinkingCleanupReason.Cancellation">
\r
2518 <summary>The cancellation token had cancellation requested before a value could be received.</summary>
\r
2520 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveCoreByLinkingCleanupReason.SourceCompletion">
\r
2521 <summary>The source completed before a value could be received.</summary>
\r
2523 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveCoreByLinkingCleanupReason.SourceProtocolError">
\r
2524 <summary>An error occurred while linking up the target.</summary>
\r
2526 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveCoreByLinkingCleanupReason.ErrorDuringCleanup">
\r
2527 <summary>An error during cleanup after completion for another reason.</summary>
\r
2529 <member name="T:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveTarget`1">
\r
2530 <summary>Provides a TaskCompletionSource that is also a dataflow target for use in ReceiveCore.</summary>
\r
2531 <typeparam name="T">Specifies the type of data offered to the target.</typeparam>
\r
2533 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveTarget`1.CachedLinkingTimerCallback">
\r
2534 <summary>Cached delegate used in ReceiveCoreByLinking on the created timer. Passed the ReceiveTarget as the argument.</summary>
\r
2535 <remarks>The C# compiler will not cache this delegate by default due to it being a generic method on a non-generic class.</remarks>
\r
2537 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveTarget`1.CachedLinkingCancellationCallback">
\r
2538 <summary>Cached delegate used in ReceiveCoreByLinking on the cancellation token. Passed the ReceiveTarget as the state argument.</summary>
\r
2539 <remarks>The C# compiler will not cache this delegate by default due to it being a generic method on a non-generic class.</remarks>
\r
2541 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveTarget`1.CachedLinkingCompletionCallback">
\r
2542 <summary>Cached delegate used in ReceiveCoreByLinking to know when the source completes. Passed the ReceiveTarget as the state argument.</summary>
\r
2544 The C# compiler will not cache this delegate by default due to it being a generic method on a non-generic class.
\r
2545 The completed parameter may be null; it should not be used here, and is only part of the signature so as to
\r
2546 match the relevant ContinueWith overload.
\r
2549 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveTarget`1.m_receivedException">
\r
2550 <summary>The received exception if an error occurred.</summary>
\r
2552 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveTarget`1.m_receivedValue">
\r
2553 <summary>The received value if we accepted a value from the source.</summary>
\r
2555 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveTarget`1.m_cleanupReserved">
\r
2556 <summary>Indicates a code path is already on route to complete the target. 0 is false, 1 is true.</summary>
\r
2558 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveTarget`1.m_cts">
\r
2559 <summary>The cancellation token source representing both external and internal cancellation.</summary>
\r
2561 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveTarget`1.m_regFromExternalCancellationToken">
\r
2562 <summary>The registration on the external token that cancels the internal token.</summary>
\r
2564 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveTarget`1.m_timer">
\r
2565 <summary>The timer that fires when the timeout has been exceeded.</summary>
\r
2567 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveTarget`1.m_unlink">
\r
2568 <summary>The unlinker from removing this target from the source from which we're receiving.</summary>
\r
2570 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveTarget`1.#ctor">
\r
2571 <summary>Initializes the target.</summary>
\r
2573 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveTarget`1.ReserveCleanupAndComplete">
\r
2574 <summary>Atomically (using IncomingLock) tries to reserve the completion routine.</summary>
\r
2575 <returns>Whether access to the completion routine was reserved for this caller.</returns>
\r
2577 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveTarget`1.System#Threading#Tasks#Dataflow#ITargetBlock{T}#OfferMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,`0,System.Threading.Tasks.Dataflow.ISourceBlock{`0},System.Boolean)">
\r
2578 <summary>Offers a message to be used to complete the TaskCompletionSource.</summary>
\r
2580 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveTarget`1.CleanupAndComplete(System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveCoreByLinkingCleanupReason)">
\r
2581 <summary>Cleans up the target for completion.</summary>
\r
2582 <param name="reason">The reason we're completing and cleaning up.</param>
\r
2583 <remarks>This method must only be called once on this instance.</remarks>
\r
2585 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveTarget`1.CreateExceptionForSourceCompletion">
\r
2586 <summary>Creates an exception to use when a source completed before receiving a value.</summary>
\r
2587 <returns>The initialized exception.</returns>
\r
2589 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveTarget`1.CreateExceptionForTimeout">
\r
2590 <summary>Creates an exception to use when a timeout occurs before receiving a value.</summary>
\r
2591 <returns>The initialized exception.</returns>
\r
2593 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveTarget`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Complete">
\r
2595 Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
\r
2596 nor produce any more messages nor consume any more postponed messages.
\r
2597 </summary><remarks>
\r
2598 After Complete has been called on a dataflow block, that block will complete
\r
2599 (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
\r
2600 available data. Complete will not block waiting for completion to occur, but rather will initiaite
\r
2601 the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
\r
2604 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveTarget`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
\r
2606 Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a
\r
2607 <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
\r
2608 </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
\r
2609 The <paramref name="exception"/> is null (Nothing in Visual Basic).
\r
2610 </exception><remarks>
\r
2611 After Fault has been called on a dataflow block, that block will complete
\r
2612 (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes
\r
2613 buffered messages (uprocessed input messages as well as unoffered output messages) to be lost.
\r
2616 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveTarget`1.IncomingLock">
\r
2617 <summary>Gets the sync obj used to synchronize all activity on this target.</summary>
\r
2619 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveTarget`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Completion">
\r
2621 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
2622 </summary><remarks>
\r
2623 A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
\r
2624 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
2625 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
2626 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
2627 the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
\r
2628 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
2629 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
2630 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
2633 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveTarget`1.DebuggerDisplayContent">
\r
2634 <summary>The data to display in the debugger display attribute.</summary>
\r
2636 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.ReceiveTarget`1.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
\r
2637 <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
\r
2639 <member name="T:System.Threading.Tasks.Dataflow.DataflowBlock.OutputAvailableAsyncTarget`1">
\r
2640 <summary>Provides a target used in HasMoreAsync operations.</summary>
\r
2641 <typeparam name="T">Specifies the type of data in the data source being checked.</typeparam>
\r
2643 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.OutputAvailableAsyncTarget`1.#ctor">
\r
2644 <summary>Initializes the target.</summary>
\r
2646 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.OutputAvailableAsyncTarget`1.System#Threading#Tasks#Dataflow#ITargetBlock{T}#OfferMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,`0,System.Threading.Tasks.Dataflow.ISourceBlock{`0},System.Boolean)">
\r
2647 <summary>Completes the task when offered a message (but doesn't consume the message).</summary>
\r
2649 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.OutputAvailableAsyncTarget`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Complete">
\r
2651 Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
\r
2652 nor produce any more messages nor consume any more postponed messages.
\r
2653 </summary><remarks>
\r
2654 After Complete has been called on a dataflow block, that block will complete
\r
2655 (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
\r
2656 available data. Complete will not block waiting for completion to occur, but rather will initiaite
\r
2657 the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
\r
2660 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.OutputAvailableAsyncTarget`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
\r
2662 Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a
\r
2663 <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
\r
2664 </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
\r
2665 The <paramref name="exception"/> is null (Nothing in Visual Basic).
\r
2666 </exception><remarks>
\r
2667 After Fault has been called on a dataflow block, that block will complete
\r
2668 (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes
\r
2669 buffered messages (uprocessed input messages as well as unoffered output messages) to be lost.
\r
2672 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.OutputAvailableAsyncTarget`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Completion">
\r
2674 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
2675 </summary><remarks>
\r
2676 A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
\r
2677 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
2678 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
2679 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
2680 the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
\r
2681 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
2682 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
2683 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
2686 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.OutputAvailableAsyncTarget`1.DebuggerDisplayContent">
\r
2687 <summary>The data to display in the debugger display attribute.</summary>
\r
2689 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.OutputAvailableAsyncTarget`1.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
\r
2690 <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
\r
2692 <member name="T:System.Threading.Tasks.Dataflow.DataflowBlock.EncapsulatingPropagator`2">
\r
2693 <summary>Provides a dataflow block that encapsulates a target and a source to form a single propagator.</summary>
\r
2695 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.EncapsulatingPropagator`2.m_target">
\r
2696 <summary>The target half.</summary>
\r
2698 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.EncapsulatingPropagator`2.m_source">
\r
2699 <summary>The source half.</summary>
\r
2701 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.EncapsulatingPropagator`2.Complete">
\r
2703 Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
\r
2704 nor produce any more messages nor consume any more postponed messages.
\r
2705 </summary><remarks>
\r
2706 After Complete has been called on a dataflow block, that block will complete
\r
2707 (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
\r
2708 available data. Complete will not block waiting for completion to occur, but rather will initiaite
\r
2709 the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
\r
2712 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.EncapsulatingPropagator`2.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
\r
2714 Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a
\r
2715 <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
\r
2716 </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
\r
2717 The <paramref name="exception"/> is null (Nothing in Visual Basic).
\r
2718 </exception><remarks>
\r
2719 After Fault has been called on a dataflow block, that block will complete
\r
2720 (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes
\r
2721 buffered messages (uprocessed input messages as well as unoffered output messages) to be lost.
\r
2724 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.EncapsulatingPropagator`2.OfferMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,`0,System.Threading.Tasks.Dataflow.ISourceBlock{`0},System.Boolean)">
\r
2726 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.
\r
2727 </summary><param name="messageHeader">
\r
2728 A <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance that represents the header of the message being offered.
\r
2729 </param><param name="messageValue">
\r
2730 The value of the message being offered.
\r
2731 </param><param name="source">
\r
2732 The <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> offering the message. This may be null (Nothing in Visual Basic).
\r
2733 </param><param name="consumeToAccept">
\r
2734 true if the target must call ConsumeMessage synchronously during the call to OfferMessage, prior to returning
\r
2735 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Accepted"/>, in order to consume the message.
\r
2736 false if the target wanting to accept the message should not call ConsumeMessage, and should isntead simply return DataflowMessageStatus.Accepted.
\r
2738 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
\r
2739 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
\r
2740 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.
\r
2741 If the target would have otherwise postponed but source was null, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is instead returned.
\r
2742 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,
\r
2743 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.NotAvailable"/> is returned.
\r
2744 If the target chose not to accept the message, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is returned. If the target
\r
2745 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.
\r
2746 </returns><exception cref="T:System.ArgumentException">
\r
2747 The <paramref name="messageHeader"/> is not valid.
\r
2748 </exception><exception cref="T:System.ArgumentException">
\r
2749 <paramref name="consumeToAccept"/> may only be true if provided with a non-null <paramref name="source"/>.
\r
2752 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.EncapsulatingPropagator`2.LinkTo(System.Threading.Tasks.Dataflow.ITargetBlock{`1},System.Boolean)">
\r
2754 Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.
\r
2755 </summary><param name="target">
\r
2756 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect this source.
\r
2757 </param><param name="unlinkAfterOne">
\r
2758 true if the source should unlink from the target after successfully propagating a single message;
\r
2759 otherwise, false to remain connected even after a single message has been propagated.
\r
2760 </param><returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns><exception cref="T:System.ArgumentNullException">
\r
2761 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
2764 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.EncapsulatingPropagator`2.TryReceive(System.Predicate{`1},`1@)">
\r
2766 Attempts to synchronously receive an available output item from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
2767 </summary><param name="filter">
\r
2768 The predicate a value must successfully pass in order for it to be received.
\r
2769 <paramref name="filter"/> may be null (Nothing in Visual Basic), in which case all items will pass.
\r
2770 </param><param name="item">The item received from the source.</param><returns>true if an item could be received; otherwise, false.</returns><remarks>
\r
2771 This method does not block waiting for the source to provide an item.
\r
2772 It will return after checking for an element, whether or not an element was available.
\r
2775 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.EncapsulatingPropagator`2.TryReceiveAll(System.Collections.Generic.IList{`1}@)">
\r
2777 Attempts to synchronously receive all available items from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
2778 </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>
\r
2779 This method does not block waiting for the source to provide an item.
\r
2780 It will return after checking for elements, whether or not an element was available.
\r
2783 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.EncapsulatingPropagator`2.ConsumeMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`1},System.Boolean@)">
\r
2785 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to accept and consume a
\r
2786 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> previously offered by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
2787 </summary><param name="messageHeader">The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being consumed.</param><param name="target">
\r
2788 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> consuming the message.
\r
2789 </param><param name="messageConsumed">
\r
2790 True if the message was successfully consumed. False otherwise.
\r
2793 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
\r
2794 passed as the <paramref name="messageHeader"/> to <see cref="M:ConsumeMessage"/>. The consuming <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must
\r
2795 use the returned value instead of the value passed as messageValue through <see cref="M:OfferMessage"/>.
\r
2798 If the message requested is not available, the return value will be null (Nothing in Visual Basic).
\r
2800 </returns><exception cref="T:System.ArgumentException">
\r
2801 The <paramref name="messageHeader"/> is not valid.
\r
2802 </exception><exception cref="T:System.ArgumentNullException">
\r
2803 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
2804 </exception><remarks>
\r
2806 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
2807 instance may use <see cref="M:ConsumeMessage"/>, and it must only be used
\r
2808 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
2809 offered by this source to the target.
\r
2813 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.EncapsulatingPropagator`2.ReserveMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`1})">
\r
2815 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"/>
\r
2816 by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
2817 </summary><param name="messageHeader">
\r
2818 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being reserved.
\r
2819 </param><param name="target">
\r
2820 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> reserving the message.
\r
2821 </param><returns>true if the message was successfully reserved; otherwise, false.</returns><exception cref="T:System.ArgumentException">
\r
2822 The <paramref name="messageHeader"/> is not valid.
\r
2823 </exception><exception cref="T:System.ArgumentNullException">
\r
2824 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
2825 </exception><remarks>
\r
2827 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> instance
\r
2828 may use <see cref="M:ReserveMessage"/>, and it must only be used
\r
2829 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
2830 offered by this source to the target.
\r
2833 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.
\r
2834 Failure to do so may result in the source being unable to propagate any further messages to this or other targets.
\r
2837 <see cref="M:ReserveMessage"/> must not be called while the target is holding any internal locks. Doing so will violate the lock hierarchy
\r
2838 necessary to avoid deadlocks in a dataflow network.
\r
2842 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.EncapsulatingPropagator`2.ReleaseReservation(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`1})">
\r
2844 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to release a previously reserved
\r
2845 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
2846 </summary><param name="messageHeader">
\r
2847 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the reserved message being released.
\r
2848 </param><param name="target">
\r
2849 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> releasing the message it previously reserved.
\r
2850 </param><exception cref="T:System.ArgumentException">
\r
2851 The <paramref name="messageHeader"/> is not valid.
\r
2852 </exception><exception cref="T:System.ArgumentNullException">
\r
2853 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
2854 </exception><exception cref="T:System.InvalidOperationException">
\r
2855 The <paramref name="target"/> did not have the message reserved.
\r
2856 </exception><remarks>
\r
2858 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
2859 instance may use <see cref="M:ReleaseMessage"/>, and it must only be used
\r
2860 to release <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
2861 and successfully reserved by the target.
\r
2865 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.EncapsulatingPropagator`2.Completion">
\r
2867 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
2868 </summary><remarks>
\r
2869 A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
\r
2870 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
2871 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
2872 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
2873 the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
\r
2874 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
2875 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
2876 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
2879 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.EncapsulatingPropagator`2.DebuggerDisplayContent">
\r
2880 <summary>The data to display in the debugger display attribute.</summary>
\r
2882 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.EncapsulatingPropagator`2.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
\r
2883 <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
\r
2885 <member name="T:System.Threading.Tasks.Dataflow.DataflowBlock.EncapsulatingPropagator`2.DebugView">
\r
2886 <summary>A debug view for the propagator.</summary>
\r
2888 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.EncapsulatingPropagator`2.DebugView.m_propagator">
\r
2889 <summary>The propagator being debugged.</summary>
\r
2891 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.EncapsulatingPropagator`2.DebugView.#ctor(System.Threading.Tasks.Dataflow.DataflowBlock.EncapsulatingPropagator{`0,`1})">
\r
2892 <summary>Initializes the debug view.</summary>
\r
2893 <param name="propagator">The propagator being debugged.</param>
\r
2895 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.EncapsulatingPropagator`2.DebugView.Target">
\r
2896 <summary>The target.</summary>
\r
2898 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.EncapsulatingPropagator`2.DebugView.Source">
\r
2899 <summary>The source.</summary>
\r
2901 <member name="T:System.Threading.Tasks.Dataflow.DataflowBlock.ChooseTarget`1">
\r
2902 <summary>Provides a dataflow target used by Choose to receive data from a single source.</summary>
\r
2903 <typeparam name="T">Specifies the type of data offered to this target.</typeparam>
\r
2905 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.ChooseTarget`1.s_sourceCompletionHandler">
\r
2906 <summary>Delegate used to notify the target that it should be canceled due to the source completing.</summary>
\r
2907 <remarks>The target is passed as the state.</remarks>
\r
2909 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.ChooseTarget`1.m_completed">
\r
2911 A wrapper for the task that represents the completed branch of this choice.
\r
2912 The wrapper is also the sync object used to protect all choice branch's access to shared state.
\r
2915 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.ChooseTarget`1.#ctor(System.Runtime.CompilerServices.StrongBox{System.Threading.Tasks.Task},System.Threading.CancellationToken)">
\r
2916 <summary>Initializes the target.</summary>
\r
2917 <param name="completed">The completed wrapper shared between all choice branches.</param>
\r
2918 <param name="cancellationToken">The cancellation token used to cancel this target.</param>
\r
2920 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.ChooseTarget`1.OfferMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,`0,System.Threading.Tasks.Dataflow.ISourceBlock{`0},System.Boolean)">
\r
2921 <summary>Called when this choice branch is being offered a message.</summary>
\r
2923 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.ChooseTarget`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Complete">
\r
2925 Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
\r
2926 nor produce any more messages nor consume any more postponed messages.
\r
2927 </summary><remarks>
\r
2928 After Complete has been called on a dataflow block, that block will complete
\r
2929 (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
\r
2930 available data. Complete will not block waiting for completion to occur, but rather will initiaite
\r
2931 the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
\r
2934 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.ChooseTarget`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
\r
2936 Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a
\r
2937 <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
\r
2938 </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
\r
2939 The <paramref name="exception"/> is null (Nothing in Visual Basic).
\r
2940 </exception><remarks>
\r
2941 After Fault has been called on a dataflow block, that block will complete
\r
2942 (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes
\r
2943 buffered messages (uprocessed input messages as well as unoffered output messages) to be lost.
\r
2946 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.ChooseTarget`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Completion">
\r
2948 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
2949 </summary><remarks>
\r
2950 A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
\r
2951 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
2952 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
2953 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
2954 the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
\r
2955 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
2956 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
2957 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
2960 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.ChooseTarget`1.DebuggerDisplayContent">
\r
2961 <summary>The data to display in the debugger display attribute.</summary>
\r
2963 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.ChooseTarget`1.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
\r
2964 <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
\r
2966 <member name="T:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1">
\r
2967 <summary>Provides an IObservable veneer over a source block.</summary>
\r
2969 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.Table">
\r
2970 <summary>The table that maps source to cached observable.</summary>
\r
2972 ConditionalWeakTable doesn't do the initialization under a lock, just the publication.
\r
2973 This means that if there's a race to create two observables off the same source, we could end
\r
2974 up instantiating multiple SourceObservable instances, of which only one will be published.
\r
2975 Worst case, we end up with a few additional continuations off of the source's completion task.
\r
2978 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.SubscriptionLock">
\r
2979 <summary>Object used to synchronize all subscriptions, unsubscriptions, and propagations.</summary>
\r
2981 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.m_source">
\r
2982 <summary>The wrapped source.</summary>
\r
2984 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.m_observersState">
\r
2986 The current target. We use the same target until the number of subscribers
\r
2987 drops to 0, at which point we substitute in a new target.
\r
2990 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.#ctor(System.Threading.Tasks.Dataflow.ISourceBlock{`0})">
\r
2991 <summary>Initializes the SourceObservable.</summary>
\r
2992 <param name="source">The source to wrap.</param>
\r
2994 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.GetCompletionError">
\r
2995 <summary>Gets any exceptions from the source block.</summary>
\r
2996 <returns>The aggregate exception of all errors, or null if everything completed successfully.</returns>
\r
2998 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.System#IObservable{TOutput}#Subscribe(System.IObserver{`0})">
\r
2999 <summary>Subscribes the observer to the source.</summary>
\r
3000 <param name="observer">the observer to subscribe.</param>
\r
3001 <returns>An IDisposable that may be used to unsubscribe the source.</returns>
\r
3003 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.Unsubscribe(System.IObserver{`0})">
\r
3004 <summary>Unsubscribes the observer.</summary>
\r
3005 <param name="observer">The observer being unsubscribed.</param>
\r
3007 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.ResetObserverState">
\r
3008 <summary>Resets the observer state to the original, unactive state.</summary>
\r
3009 <returns>The list of active observers prior to the reset.</returns>
\r
3011 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.DebuggerDisplayContent">
\r
3012 <summary>The data to display in the debugger display attribute.</summary>
\r
3014 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
\r
3015 <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
\r
3017 <member name="T:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.DebugView">
\r
3018 <summary>Provides a debugger type proxy for the observable.</summary>
\r
3020 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.DebugView.m_observable">
\r
3021 <summary>The observable being debugged.</summary>
\r
3023 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.DebugView.#ctor(System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable{`0})">
\r
3024 <summary>Initializes the debug view.</summary>
\r
3025 <param name="observable">The target being debugged.</param>
\r
3027 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.DebugView.Observers">
\r
3028 <summary>Gets an enumerable of the observers.</summary>
\r
3030 <member name="T:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.ObserversState">
\r
3031 <summary>State associated with the current target for propagating data to observers.</summary>
\r
3033 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.ObserversState.Observable">
\r
3034 <summary>The owning SourceObservable.</summary>
\r
3036 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.ObserversState.Target">
\r
3037 <summary>The ActionBlock that consumes data from a source and offers it to targets.</summary>
\r
3039 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.ObserversState.Canceler">
\r
3040 <summary>Used to cancel continuations when they're no longer necessary.</summary>
\r
3042 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.ObserversState.Observers">
\r
3044 A list of the observers currently registered with this target. The list is immutable
\r
3045 to enable iteration through the list while the set of observers may be changing.
\r
3048 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.ObserversState.Unlinker">
\r
3049 <summary>Used to unlink the source from this target when the last observer is unsubscribed.</summary>
\r
3051 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.ObserversState.#ctor(System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable{`0})">
\r
3052 <summary>Initializes the target instance.</summary>
\r
3053 <param name="observable">The owning observable.</param>
\r
3055 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.ObserversState.ProcessItem(`0)">
\r
3056 <summary>Forwards an item to all currently subscribed observers.</summary>
\r
3057 <param name="item">The item to forward.</param>
\r
3059 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.SourceObservable`1.ObserversState.NotifyObserversOfCompletion(System.Exception)">
\r
3060 <summary>Notifies all currently registered observers that they should complete.</summary>
\r
3061 <param name="targetException">
\r
3062 Non-null when an unexpected exception occurs during processing. Faults
\r
3063 all subscribed observers and resets the observable back to its original condition.
\r
3066 <member name="T:System.Threading.Tasks.Dataflow.DataflowBlock.TargetObserver`1">
\r
3067 <summary>Provides an observer wrapper for a target block.</summary>
\r
3069 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlock.TargetObserver`1.m_target">
\r
3070 <summary>The wrapped target.</summary>
\r
3072 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.TargetObserver`1.#ctor(System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
\r
3073 <summary>Initializes the observer.</summary>
\r
3074 <param name="target">The target to wrap.</param>
\r
3076 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.TargetObserver`1.System#IObserver{TInput}#OnNext(`0)">
\r
3077 <summary>Sends the value to the observer.</summary>
\r
3078 <param name="value">The value to send.</param>
\r
3080 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.TargetObserver`1.System#IObserver{TInput}#OnCompleted">
\r
3081 <summary>Completes the target.</summary>
\r
3083 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlock.TargetObserver`1.System#IObserver{TInput}#OnError(System.Exception)">
\r
3084 <summary>Forwards the error to the target.</summary>
\r
3085 <param name="error">The exception to forward.</param>
\r
3087 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.TargetObserver`1.DebuggerDisplayContent">
\r
3088 <summary>The data to display in the debugger display attribute.</summary>
\r
3090 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlock.TargetObserver`1.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
\r
3091 <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
\r
3093 <member name="T:System.Threading.Tasks.Dataflow.BufferBlock`1">
\r
3094 <summary>Provides a buffer for storing data.</summary>
\r
3095 <typeparam name="T">Specifies the type of the data buffered by this dataflow block.</typeparam>
\r
3097 <member name="F:System.Threading.Tasks.Dataflow.BufferBlock`1.m_source">
\r
3098 <summary>The core logic for the buffer block.</summary>
\r
3100 <member name="F:System.Threading.Tasks.Dataflow.BufferBlock`1.m_boundingState">
\r
3101 <summary>The bounding state for when in bounding mode; null if not bounding.</summary>
\r
3103 <member name="F:System.Threading.Tasks.Dataflow.BufferBlock`1.m_targetDecliningPermanently">
\r
3104 <summary>Whether all future messages should be declined on the target.</summary>
\r
3106 <member name="F:System.Threading.Tasks.Dataflow.BufferBlock`1.m_targetCompletionReserved">
\r
3107 <summary>A task has reserved the right to run the target's completion routine.</summary>
\r
3109 <member name="M:System.Threading.Tasks.Dataflow.BufferBlock`1.#ctor">
\r
3110 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.BufferBlock`1"/>.</summary>
\r
3112 <member name="M:System.Threading.Tasks.Dataflow.BufferBlock`1.#ctor(System.Threading.Tasks.Dataflow.DataflowBlockOptions)">
\r
3113 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.BufferBlock`1"/> with the specified <see cref="T:System.Threading.Tasks.Dataflow.DataflowBlockOptions"/>.</summary>
\r
3114 <param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.BufferBlock`1"/>.</param>
\r
3115 <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
\r
3117 <member name="M:System.Threading.Tasks.Dataflow.BufferBlock`1.System#Threading#Tasks#Dataflow#ITargetBlock{T}#OfferMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,`0,System.Threading.Tasks.Dataflow.ISourceBlock{`0},System.Boolean)">
\r
3119 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.
\r
3120 </summary><param name="messageHeader">
\r
3121 A <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance that represents the header of the message being offered.
\r
3122 </param><param name="messageValue">
\r
3123 The value of the message being offered.
\r
3124 </param><param name="source">
\r
3125 The <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> offering the message. This may be null (Nothing in Visual Basic).
\r
3126 </param><param name="consumeToAccept">
\r
3127 true if the target must call ConsumeMessage synchronously during the call to OfferMessage, prior to returning
\r
3128 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Accepted"/>, in order to consume the message.
\r
3129 false if the target wanting to accept the message should not call ConsumeMessage, and should isntead simply return DataflowMessageStatus.Accepted.
\r
3131 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
\r
3132 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
\r
3133 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.
\r
3134 If the target would have otherwise postponed but source was null, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is instead returned.
\r
3135 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,
\r
3136 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.NotAvailable"/> is returned.
\r
3137 If the target chose not to accept the message, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is returned. If the target
\r
3138 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.
\r
3139 </returns><exception cref="T:System.ArgumentException">
\r
3140 The <paramref name="messageHeader"/> is not valid.
\r
3141 </exception><exception cref="T:System.ArgumentException">
\r
3142 <paramref name="consumeToAccept"/> may only be true if provided with a non-null <paramref name="source"/>.
\r
3145 <member name="M:System.Threading.Tasks.Dataflow.BufferBlock`1.Complete">
\r
3147 Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
\r
3148 nor produce any more messages nor consume any more postponed messages.
\r
3149 </summary><remarks>
\r
3150 After Complete has been called on a dataflow block, that block will complete
\r
3151 (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
\r
3152 available data. Complete will not block waiting for completion to occur, but rather will initiaite
\r
3153 the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
\r
3156 <member name="M:System.Threading.Tasks.Dataflow.BufferBlock`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
\r
3158 Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a
\r
3159 <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
\r
3160 </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
\r
3161 The <paramref name="exception"/> is null (Nothing in Visual Basic).
\r
3162 </exception><remarks>
\r
3163 After Fault has been called on a dataflow block, that block will complete
\r
3164 (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes
\r
3165 buffered messages (uprocessed input messages as well as unoffered output messages) to be lost.
\r
3168 <member name="M:System.Threading.Tasks.Dataflow.BufferBlock`1.LinkTo(System.Threading.Tasks.Dataflow.ITargetBlock{`0},System.Boolean)">
\r
3170 Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.
\r
3171 </summary><param name="target">
\r
3172 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect this source.
\r
3173 </param><param name="unlinkAfterOne">
\r
3174 true if the source should unlink from the target after successfully propagating a single message;
\r
3175 otherwise, false to remain connected even after a single message has been propagated.
\r
3176 </param><returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns><exception cref="T:System.ArgumentNullException">
\r
3177 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
3180 <member name="M:System.Threading.Tasks.Dataflow.BufferBlock`1.TryReceive(System.Predicate{`0},`0@)">
\r
3182 Attempts to synchronously receive an available output item from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
3183 </summary><param name="filter">
\r
3184 The predicate a value must successfully pass in order for it to be received.
\r
3185 <paramref name="filter"/> may be null (Nothing in Visual Basic), in which case all items will pass.
\r
3186 </param><param name="item">The item received from the source.</param><returns>true if an item could be received; otherwise, false.</returns><remarks>
\r
3187 This method does not block waiting for the source to provide an item.
\r
3188 It will return after checking for an element, whether or not an element was available.
\r
3191 <member name="M:System.Threading.Tasks.Dataflow.BufferBlock`1.TryReceiveAll(System.Collections.Generic.IList{`0}@)">
\r
3193 Attempts to synchronously receive all available items from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
3194 </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>
\r
3195 This method does not block waiting for the source to provide an item.
\r
3196 It will return after checking for elements, whether or not an element was available.
\r
3199 <member name="M:System.Threading.Tasks.Dataflow.BufferBlock`1.System#Threading#Tasks#Dataflow#ISourceBlock{T}#ConsumeMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0},System.Boolean@)">
\r
3201 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to accept and consume a
\r
3202 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> previously offered by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
3203 </summary><param name="messageHeader">The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being consumed.</param><param name="target">
\r
3204 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> consuming the message.
\r
3205 </param><param name="messageConsumed">
\r
3206 True if the message was successfully consumed. False otherwise.
\r
3209 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
\r
3210 passed as the <paramref name="messageHeader"/> to <see cref="M:ConsumeMessage"/>. The consuming <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must
\r
3211 use the returned value instead of the value passed as messageValue through <see cref="M:OfferMessage"/>.
\r
3214 If the message requested is not available, the return value will be null (Nothing in Visual Basic).
\r
3216 </returns><exception cref="T:System.ArgumentException">
\r
3217 The <paramref name="messageHeader"/> is not valid.
\r
3218 </exception><exception cref="T:System.ArgumentNullException">
\r
3219 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
3220 </exception><remarks>
\r
3222 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
3223 instance may use <see cref="M:ConsumeMessage"/>, and it must only be used
\r
3224 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
3225 offered by this source to the target.
\r
3229 <member name="M:System.Threading.Tasks.Dataflow.BufferBlock`1.System#Threading#Tasks#Dataflow#ISourceBlock{T}#ReserveMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
\r
3231 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"/>
\r
3232 by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
3233 </summary><param name="messageHeader">
\r
3234 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being reserved.
\r
3235 </param><param name="target">
\r
3236 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> reserving the message.
\r
3237 </param><returns>true if the message was successfully reserved; otherwise, false.</returns><exception cref="T:System.ArgumentException">
\r
3238 The <paramref name="messageHeader"/> is not valid.
\r
3239 </exception><exception cref="T:System.ArgumentNullException">
\r
3240 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
3241 </exception><remarks>
\r
3243 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> instance
\r
3244 may use <see cref="M:ReserveMessage"/>, and it must only be used
\r
3245 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
3246 offered by this source to the target.
\r
3249 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.
\r
3250 Failure to do so may result in the source being unable to propagate any further messages to this or other targets.
\r
3253 <see cref="M:ReserveMessage"/> must not be called while the target is holding any internal locks. Doing so will violate the lock hierarchy
\r
3254 necessary to avoid deadlocks in a dataflow network.
\r
3258 <member name="M:System.Threading.Tasks.Dataflow.BufferBlock`1.System#Threading#Tasks#Dataflow#ISourceBlock{T}#ReleaseReservation(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
\r
3260 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to release a previously reserved
\r
3261 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
3262 </summary><param name="messageHeader">
\r
3263 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the reserved message being released.
\r
3264 </param><param name="target">
\r
3265 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> releasing the message it previously reserved.
\r
3266 </param><exception cref="T:System.ArgumentException">
\r
3267 The <paramref name="messageHeader"/> is not valid.
\r
3268 </exception><exception cref="T:System.ArgumentNullException">
\r
3269 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
3270 </exception><exception cref="T:System.InvalidOperationException">
\r
3271 The <paramref name="target"/> did not have the message reserved.
\r
3272 </exception><remarks>
\r
3274 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
3275 instance may use <see cref="M:ReleaseMessage"/>, and it must only be used
\r
3276 to release <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
3277 and successfully reserved by the target.
\r
3281 <member name="M:System.Threading.Tasks.Dataflow.BufferBlock`1.OnItemsRemoved(System.Int32)">
\r
3282 <summary>Notifies the block that one or more items was removed from the queue.</summary>
\r
3283 <param name="numItemsRemoved">The number of items removed.</param>
\r
3285 <member name="M:System.Threading.Tasks.Dataflow.BufferBlock`1.ConsumeAsyncIfNecessary(System.Boolean)">
\r
3286 <summary>Called when postponed messages may need to be consumed.</summary>
\r
3287 <param name="isReplacementReplica">Whether this call is the continuation of a previous message loop.</param>
\r
3289 <member name="M:System.Threading.Tasks.Dataflow.BufferBlock`1.ConsumeMessagesLoopWithExecutionContext">
\r
3290 <summary>Task body used to consume postponed messages under the right execution context.</summary>
\r
3292 <member name="M:System.Threading.Tasks.Dataflow.BufferBlock`1.ConsumeMessagesLoopCore">
\r
3293 <summary>Task body used to consume postponed messages.</summary>
\r
3295 <member name="M:System.Threading.Tasks.Dataflow.BufferBlock`1.ConsumeAndStoreOneMessageIfAvailable">
\r
3297 Retrieves one postponed message if there's room and if we can consume a postoned message.
\r
3298 Stores any consumed message into the source half.
\r
3300 <returns>true if a message could be consumed and stored; otherwise, false.</returns>
\r
3301 <remarks>This must only be called from the asynchronous processing loop.</remarks>
\r
3303 <member name="M:System.Threading.Tasks.Dataflow.BufferBlock`1.CompleteTargetIfPossible">
\r
3304 <summary>Completes the target, notifying the source, once all completion conditions are met.</summary>
\r
3306 <member name="P:System.Threading.Tasks.Dataflow.BufferBlock`1.IncomingLock">
\r
3307 <summary>Gets the lock object used to synchronize incoming requests.</summary>
\r
3309 <member name="P:System.Threading.Tasks.Dataflow.BufferBlock`1.Count">
\r
3310 <summary>Gets the number of items currently stored in the buffer.</summary>
\r
3312 <member name="P:System.Threading.Tasks.Dataflow.BufferBlock`1.Completion">
\r
3314 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
3315 </summary><remarks>
\r
3316 A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
\r
3317 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
3318 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
3319 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
3320 the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
\r
3321 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
3322 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
3323 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
3326 <member name="P:System.Threading.Tasks.Dataflow.BufferBlock`1.CountForDebugger">
\r
3327 <summary>Gets the number of messages in the buffer. This must only be used from the debugger as it avoids taking necessary locks.</summary>
\r
3329 <member name="P:System.Threading.Tasks.Dataflow.BufferBlock`1.DebuggerDisplayContent">
\r
3330 <summary>The data to display in the debugger display attribute.</summary>
\r
3332 <member name="P:System.Threading.Tasks.Dataflow.BufferBlock`1.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
\r
3333 <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
\r
3335 <member name="T:System.Threading.Tasks.Dataflow.BufferBlock`1.DebugView">
\r
3336 <summary>Provides a debugger type proxy for the BufferBlock.</summary>
\r
3338 <member name="F:System.Threading.Tasks.Dataflow.BufferBlock`1.DebugView.m_bufferBlock">
\r
3339 <summary>The buffer block.</summary>
\r
3341 <member name="F:System.Threading.Tasks.Dataflow.BufferBlock`1.DebugView.m_sourceDebuggingInformation">
\r
3342 <summary>The buffer's source half.</summary>
\r
3344 <member name="M:System.Threading.Tasks.Dataflow.BufferBlock`1.DebugView.#ctor(System.Threading.Tasks.Dataflow.BufferBlock{`0})">
\r
3345 <summary>Initializes the debug view.</summary>
\r
3346 <param name="bufferBlock">The BufferBlock being viewed.</param>
\r
3348 <member name="P:System.Threading.Tasks.Dataflow.BufferBlock`1.DebugView.PostponedMessages">
\r
3349 <summary>Gets the collection of postponed message headers.</summary>
\r
3351 <member name="P:System.Threading.Tasks.Dataflow.BufferBlock`1.DebugView.Queue">
\r
3352 <summary>Gets the messages in the buffer.</summary>
\r
3354 <member name="P:System.Threading.Tasks.Dataflow.BufferBlock`1.DebugView.TaskForInputProcessing">
\r
3355 <summary>The task used to process messages.</summary>
\r
3357 <member name="P:System.Threading.Tasks.Dataflow.BufferBlock`1.DebugView.TaskForOutputProcessing">
\r
3358 <summary>Gets the task being used for output processing.</summary>
\r
3360 <member name="P:System.Threading.Tasks.Dataflow.BufferBlock`1.DebugView.DataflowBlockOptions">
\r
3361 <summary>Gets the DataflowBlockOptions used to configure this block.</summary>
\r
3363 <member name="P:System.Threading.Tasks.Dataflow.BufferBlock`1.DebugView.IsDecliningPermanently">
\r
3364 <summary>Gets whether the block is declining further messages.</summary>
\r
3366 <member name="P:System.Threading.Tasks.Dataflow.BufferBlock`1.DebugView.IsCompleted">
\r
3367 <summary>Gets whether the block is completed.</summary>
\r
3369 <member name="P:System.Threading.Tasks.Dataflow.BufferBlock`1.DebugView.Id">
\r
3370 <summary>Gets the block's Id.</summary>
\r
3372 <member name="P:System.Threading.Tasks.Dataflow.BufferBlock`1.DebugView.LinkedTargets">
\r
3373 <summary>Gets the set of all targets linked from this block.</summary>
\r
3375 <member name="P:System.Threading.Tasks.Dataflow.BufferBlock`1.DebugView.NextMessageReservedFor">
\r
3376 <summary>Gets the set of all targets linked from this block.</summary>
\r
3378 <member name="T:System.Threading.Tasks.Dataflow.Internal.ImmutableList`1">
\r
3379 <summary>Provides a simple, immutable list.</summary>
\r
3380 <typeparam name="T">Specifies the type of the data stored in the list.</typeparam>
\r
3382 <member name="F:System.Threading.Tasks.Dataflow.Internal.ImmutableList`1.s_empty">
\r
3383 <summary>An empty list.</summary>
\r
3385 <member name="F:System.Threading.Tasks.Dataflow.Internal.ImmutableList`1.m_array">
\r
3386 <summary>The immutable data in this list instance.</summary>
\r
3388 <member name="M:System.Threading.Tasks.Dataflow.Internal.ImmutableList`1.#ctor">
\r
3389 <summary>Initializes the immutable list to be empty.</summary>
\r
3391 <member name="M:System.Threading.Tasks.Dataflow.Internal.ImmutableList`1.#ctor(`0[])">
\r
3392 <summary>Initializes the immutable list with the specified elements.</summary>
\r
3393 <param name="elements">The element array to use for this list's data.</param>
\r
3395 <member name="M:System.Threading.Tasks.Dataflow.Internal.ImmutableList`1.Add(`0)">
\r
3396 <summary>Creates a new immutable list from this list and the additional element.</summary>
\r
3397 <param name="item">The item to add.</param>
\r
3398 <returns>The new list.</returns>
\r
3400 <member name="M:System.Threading.Tasks.Dataflow.Internal.ImmutableList`1.Remove(`0)">
\r
3401 <summary>Creates a new immutable list from this list and without the specified element.</summary>
\r
3402 <param name="item">The item to remove.</param>
\r
3403 <returns>The new list.</returns>
\r
3405 <member name="M:System.Threading.Tasks.Dataflow.Internal.ImmutableList`1.Contains(`0)">
\r
3406 <summary>Gets whether the list contains the specified item.</summary>
\r
3407 <param name="item">The item to lookup.</param>
\r
3408 <returns>true if the list contains the item; otherwise, false.</returns>
\r
3410 <member name="M:System.Threading.Tasks.Dataflow.Internal.ImmutableList`1.GetEnumerator">
\r
3411 <summary>Returns an enumerator that iterates through the collection.</summary>
\r
3413 <member name="M:System.Threading.Tasks.Dataflow.Internal.ImmutableList`1.System#Collections#IEnumerable#GetEnumerator">
\r
3414 <summary>Returns an enumerator that iterates through the collection.</summary>
\r
3416 <member name="P:System.Threading.Tasks.Dataflow.Internal.ImmutableList`1.Empty">
\r
3417 <summary>Gets the empty list.</summary>
\r
3419 <member name="P:System.Threading.Tasks.Dataflow.Internal.ImmutableList`1.Count">
\r
3420 <summary>Gets the number of elements in this list.</summary>
\r
3422 <member name="T:System.Threading.Tasks.Dataflow.Internal.ImmutableList`1.DebugView">
\r
3423 <summary>Debugger type proxy for ImmutableList.</summary>
\r
3425 <member name="F:System.Threading.Tasks.Dataflow.Internal.ImmutableList`1.DebugView.m_list">
\r
3426 <summary>The list being visualized.</summary>
\r
3428 <member name="M:System.Threading.Tasks.Dataflow.Internal.ImmutableList`1.DebugView.#ctor(System.Threading.Tasks.Dataflow.Internal.ImmutableList{`0})">
\r
3429 <summary>Initializes the debug view.</summary>
\r
3430 <param name="list">The list being debugged.</param>
\r
3432 <member name="P:System.Threading.Tasks.Dataflow.Internal.ImmutableList`1.DebugView.Items">
\r
3433 <summary>Gets the contents of the list.</summary>
\r
3435 <member name="T:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1">
\r
3436 <summary>Stores targets registered with a source.</summary>
\r
3437 <typeparam name="T">Specifies the type of data accepted by the targets.</typeparam>
\r
3439 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.m_orderedTargetList">
\r
3440 <summary>An ordered list of targets. Targets should be offered messages in order from index 0 to N-1.</summary>
\r
3442 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.m_targetInformation">
\r
3443 <summary>A mapping of targets to information about them.</summary>
\r
3445 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.m_owningSource">
\r
3446 <summary>A reference to the owning source block.</summary>
\r
3448 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.m_unlinkAfterOneCount">
\r
3449 <summary>An optimization that allows us to skip dictionary lookup when there are no 'unlinkAfterOne' targets.</summary>
\r
3451 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.#ctor(System.Threading.Tasks.Dataflow.ISourceBlock{`0})">
\r
3452 <summary>Initializes the registry.</summary>
\r
3454 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.Add(System.Threading.Tasks.Dataflow.ITargetBlock{`0}@,System.Boolean)">
\r
3455 <summary>Adds a target to the registry.</summary>
\r
3456 <param name="target">The target to add.</param>
\r
3457 <param name="unlinkAfterOne">
\r
3458 A Boolean value indicating whether the target should be disconnected after one successful propagation.
\r
3461 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.Contains(System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
\r
3462 <summary>Gets whether the registry contains a particular target.</summary>
\r
3463 <param name="target">The target.</param>
\r
3464 <returns>true if the registry contains the target; otherwise, false.</returns>
\r
3466 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.Clear">
\r
3467 <summary>Clears the target registry.</summary>
\r
3469 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.Remove(System.Threading.Tasks.Dataflow.ITargetBlock{`0},System.Boolean)">
\r
3470 <summary>Removes the target from the registry.</summary>
\r
3471 <param name="target">The target to remove.</param>
\r
3472 <param name="onlyIfUnlinkAfterOne">
\r
3473 Only remove the target if it's configured to be unlinked after one propagation.
\r
3476 <member name="P:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.Count">
\r
3477 <summary>Gets the number of items in the registry.</summary>
\r
3479 <member name="P:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.OrderedTargetList">
\r
3480 <summary>Gets the ordered target list.</summary>
\r
3482 <member name="T:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.LinkedTargetInfo">
\r
3483 <summary>Information about a registered target.</summary>
\r
3485 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.LinkedTargetInfo.#ctor(System.Boolean,System.Collections.Generic.LinkedListNode{System.Threading.Tasks.Dataflow.ITargetBlock{`0}})">
\r
3486 <summary>Initializes the LinkedTargetInfo.</summary>
\r
3487 <param name="unlinkAfterOne">Whether the target should be disconnected after one successful propagation.</param>
\r
3488 <param name="listNode">The linked list node for this entry.</param>
\r
3490 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.LinkedTargetInfo.UnlinkAfterOne">
\r
3491 <summary>Whether to unlink this node after one propagation.</summary>
\r
3493 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.LinkedTargetInfo.ListNode">
\r
3494 <summary>The linked list node for this entry.</summary>
\r
3496 <member name="T:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.NopLinkPropagator">
\r
3497 <summary>Provides a nop passthrough for use with TargetRegistry.</summary>
\r
3499 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.NopLinkPropagator.m_owningSource">
\r
3500 <summary>The source that encapsulates this block.</summary>
\r
3502 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.NopLinkPropagator.m_target">
\r
3503 <summary>The target with which this block is associated.</summary>
\r
3505 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.NopLinkPropagator.#ctor(System.Threading.Tasks.Dataflow.ISourceBlock{`0},System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
\r
3506 <summary>Initializes the passthrough.</summary>
\r
3507 <param name="owningSource">The source that encapsulates this block.</param>
\r
3508 <param name="target">The target to which messages should be forwarded.</param>
\r
3510 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.NopLinkPropagator.System#Threading#Tasks#Dataflow#ITargetBlock{T}#OfferMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,`0,System.Threading.Tasks.Dataflow.ISourceBlock{`0},System.Boolean)">
\r
3512 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.
\r
3513 </summary><param name="messageHeader">
\r
3514 A <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance that represents the header of the message being offered.
\r
3515 </param><param name="messageValue">
\r
3516 The value of the message being offered.
\r
3517 </param><param name="source">
\r
3518 The <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> offering the message. This may be null (Nothing in Visual Basic).
\r
3519 </param><param name="consumeToAccept">
\r
3520 true if the target must call ConsumeMessage synchronously during the call to OfferMessage, prior to returning
\r
3521 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Accepted"/>, in order to consume the message.
\r
3522 false if the target wanting to accept the message should not call ConsumeMessage, and should isntead simply return DataflowMessageStatus.Accepted.
\r
3524 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
\r
3525 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
\r
3526 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.
\r
3527 If the target would have otherwise postponed but source was null, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is instead returned.
\r
3528 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,
\r
3529 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.NotAvailable"/> is returned.
\r
3530 If the target chose not to accept the message, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is returned. If the target
\r
3531 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.
\r
3532 </returns><exception cref="T:System.ArgumentException">
\r
3533 The <paramref name="messageHeader"/> is not valid.
\r
3534 </exception><exception cref="T:System.ArgumentException">
\r
3535 <paramref name="consumeToAccept"/> may only be true if provided with a non-null <paramref name="source"/>.
\r
3538 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.NopLinkPropagator.System#Threading#Tasks#Dataflow#ISourceBlock{T}#ConsumeMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0},System.Boolean@)">
\r
3540 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to accept and consume a
\r
3541 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> previously offered by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
3542 </summary><param name="messageHeader">The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being consumed.</param><param name="target">
\r
3543 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> consuming the message.
\r
3544 </param><param name="messageConsumed">
\r
3545 True if the message was successfully consumed. False otherwise.
\r
3548 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
\r
3549 passed as the <paramref name="messageHeader"/> to <see cref="M:ConsumeMessage"/>. The consuming <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must
\r
3550 use the returned value instead of the value passed as messageValue through <see cref="M:OfferMessage"/>.
\r
3553 If the message requested is not available, the return value will be null (Nothing in Visual Basic).
\r
3555 </returns><exception cref="T:System.ArgumentException">
\r
3556 The <paramref name="messageHeader"/> is not valid.
\r
3557 </exception><exception cref="T:System.ArgumentNullException">
\r
3558 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
3559 </exception><remarks>
\r
3561 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
3562 instance may use <see cref="M:ConsumeMessage"/>, and it must only be used
\r
3563 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
3564 offered by this source to the target.
\r
3568 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.NopLinkPropagator.System#Threading#Tasks#Dataflow#ISourceBlock{T}#ReserveMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
\r
3570 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"/>
\r
3571 by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
3572 </summary><param name="messageHeader">
\r
3573 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being reserved.
\r
3574 </param><param name="target">
\r
3575 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> reserving the message.
\r
3576 </param><returns>true if the message was successfully reserved; otherwise, false.</returns><exception cref="T:System.ArgumentException">
\r
3577 The <paramref name="messageHeader"/> is not valid.
\r
3578 </exception><exception cref="T:System.ArgumentNullException">
\r
3579 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
3580 </exception><remarks>
\r
3582 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> instance
\r
3583 may use <see cref="M:ReserveMessage"/>, and it must only be used
\r
3584 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
3585 offered by this source to the target.
\r
3588 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.
\r
3589 Failure to do so may result in the source being unable to propagate any further messages to this or other targets.
\r
3592 <see cref="M:ReserveMessage"/> must not be called while the target is holding any internal locks. Doing so will violate the lock hierarchy
\r
3593 necessary to avoid deadlocks in a dataflow network.
\r
3597 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.NopLinkPropagator.System#Threading#Tasks#Dataflow#ISourceBlock{T}#ReleaseReservation(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
\r
3599 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to release a previously reserved
\r
3600 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
3601 </summary><param name="messageHeader">
\r
3602 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the reserved message being released.
\r
3603 </param><param name="target">
\r
3604 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> releasing the message it previously reserved.
\r
3605 </param><exception cref="T:System.ArgumentException">
\r
3606 The <paramref name="messageHeader"/> is not valid.
\r
3607 </exception><exception cref="T:System.ArgumentNullException">
\r
3608 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
3609 </exception><exception cref="T:System.InvalidOperationException">
\r
3610 The <paramref name="target"/> did not have the message reserved.
\r
3611 </exception><remarks>
\r
3613 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
3614 instance may use <see cref="M:ReleaseMessage"/>, and it must only be used
\r
3615 to release <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
3616 and successfully reserved by the target.
\r
3620 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.NopLinkPropagator.System#Threading#Tasks#Dataflow#IDataflowBlock#Complete">
\r
3622 Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
\r
3623 nor produce any more messages nor consume any more postponed messages.
\r
3624 </summary><remarks>
\r
3625 After Complete has been called on a dataflow block, that block will complete
\r
3626 (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
\r
3627 available data. Complete will not block waiting for completion to occur, but rather will initiaite
\r
3628 the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
\r
3631 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.NopLinkPropagator.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
\r
3633 Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a
\r
3634 <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
\r
3635 </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
\r
3636 The <paramref name="exception"/> is null (Nothing in Visual Basic).
\r
3637 </exception><remarks>
\r
3638 After Fault has been called on a dataflow block, that block will complete
\r
3639 (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes
\r
3640 buffered messages (uprocessed input messages as well as unoffered output messages) to be lost.
\r
3643 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.NopLinkPropagator.System#Threading#Tasks#Dataflow#ISourceBlock{T}#LinkTo(System.Threading.Tasks.Dataflow.ITargetBlock{`0},System.Boolean)">
\r
3645 Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.
\r
3646 </summary><param name="target">
\r
3647 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect this source.
\r
3648 </param><param name="unlinkAfterOne">
\r
3649 true if the source should unlink from the target after successfully propagating a single message;
\r
3650 otherwise, false to remain connected even after a single message has been propagated.
\r
3651 </param><returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns><exception cref="T:System.ArgumentNullException">
\r
3652 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
3655 <member name="P:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.NopLinkPropagator.System#Threading#Tasks#Dataflow#IDataflowBlock#Completion">
\r
3657 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
3658 </summary><remarks>
\r
3659 A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
\r
3660 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
3661 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
3662 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
3663 the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
\r
3664 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
3665 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
3666 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
3669 <member name="P:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.NopLinkPropagator.DebuggerDisplayContent">
\r
3670 <summary>The data to display in the debugger display attribute.</summary>
\r
3672 <member name="P:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.NopLinkPropagator.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
\r
3673 <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
\r
3675 <member name="T:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.NopLinkPropagator.DebugView">
\r
3676 <summary>Provides a debugger type proxy for a passthrough.</summary>
\r
3678 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.NopLinkPropagator.DebugView.m_passthrough">
\r
3679 <summary>The passthrough.</summary>
\r
3681 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.NopLinkPropagator.DebugView.#ctor(System.Threading.Tasks.Dataflow.Internal.TargetRegistry{`0}.NopLinkPropagator)">
\r
3682 <summary>Initializes the debug view.</summary>
\r
3683 <param name="passthrough">The passthrough to view.</param>
\r
3685 <member name="P:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.NopLinkPropagator.DebugView.LinkedTarget">
\r
3686 <summary>The linked target for this block.</summary>
\r
3688 <member name="T:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.DebugView">
\r
3689 <summary>Provides a debugger type proxy for the target registry.</summary>
\r
3691 <member name="F:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.DebugView.m_registry">
\r
3692 <summary>The registry being debugged.</summary>
\r
3694 <member name="M:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.DebugView.#ctor(System.Threading.Tasks.Dataflow.Internal.TargetRegistry{`0})">
\r
3695 <summary>Initializes the type proxy.</summary>
\r
3696 <param name="registry">The target registry.</param>
\r
3698 <member name="P:System.Threading.Tasks.Dataflow.Internal.TargetRegistry`1.DebugView.Targets">
\r
3699 <summary>Gets a list of all targets to show in the debugger.</summary>
\r
3701 <member name="T:System.Threading.Tasks.Dataflow.Internal.Common">
\r
3702 <summary>Internal helper utilities.</summary>
\r
3704 <member name="F:System.Threading.Tasks.Dataflow.Internal.Common.INVALID_REORDERING_ID">
\r
3706 An invalid ID to assign for reordering purposes. This value is chosen to be the last of the 64-bit integers that
\r
3707 could ever be assigned as a reordering ID.
\r
3710 <member name="F:System.Threading.Tasks.Dataflow.Internal.Common.SINGLE_MESSAGE_ID">
\r
3711 <summary>A well-known message ID for code that will send exactly one message or
\r
3712 where the exact message ID is not important.</summary>
\r
3714 <member name="F:System.Threading.Tasks.Dataflow.Internal.Common.EXCEPTIONDATAKEY_DATAFLOWMESSAGEVALUE">
\r
3715 <summary>The name of the key in an Exception's Data collection used to store information on a dataflow message.</summary>
\r
3717 <member name="F:System.Threading.Tasks.Dataflow.Internal.Common.SingleMessageHeader">
\r
3718 <summary>A perf optimization for caching a well-known message header instead of
\r
3719 constructing one every time it is needed.</summary>
\r
3721 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.ContractAssertMonitorStatus(System.Object,System.Boolean)">
\r
3722 <summary>Asserts that a given synchronization object is either held or not held.</summary>
\r
3723 <param name="syncObj">The monitor to check.</param>
\r
3724 <param name="held">Whether we want to assert that it's currently held or not held.</param>
\r
3726 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.GetBlockId(System.Threading.Tasks.Dataflow.IDataflowBlock)">
\r
3727 <summary>Gets an ID for the dataflow block.</summary>
\r
3728 <param name="block">The dataflow block.</param>
\r
3729 <returns>An ID for the dataflow block.</returns>
\r
3731 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.GetNameForDebugger(System.Object)">
\r
3732 <summary>Gets the name for the specified object, suitable to be rendered in a debugger window.</summary>
\r
3733 <param name="obj">The object for which a name is needed.</param>
\r
3734 <returns>The name of the object.</returns>
\r
3735 <remarks>This is used from DebuggerDisplay attributes.</remarks>
\r
3737 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.IsCooperativeCancellation(System.Exception)">
\r
3739 Gets whether the exception represents a cooperative cancellation acknowledgement.
\r
3741 <param name="exception">The exception to check.</param>
\r
3742 <returns>true if this exception represents a cooperative cancellation acknowledgement; otherwise, false.</returns>
\r
3744 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.WireCancellationToComplete(System.Threading.CancellationToken,System.Threading.Tasks.Task,System.Action{System.Object},System.Object)">
\r
3745 <summary>Registers a block for cancellation by completing when cancellation is requested.</summary>
\r
3746 <param name="cancellationToken">The block's cancellation token.</param>
\r
3747 <param name="completionTask">The task that will complete when the block is completely done processing.</param>
\r
3748 <param name="completeAction">An action that will decline permanently on the state passed to it.</param>
\r
3749 <param name="completeState">The block on which to decline permanently.</param>
\r
3751 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.PollForTaskCompletionAsync(System.Threading.Tasks.Task,System.Action,System.Threading.CancellationToken)">
\r
3752 <summary>Asynchronously polls for a task's completion.</summary>
\r
3753 <param name="task">The task to poll for completion.</param>
\r
3754 <param name="callback">The callback to invoke when the source completes.</param>
\r
3755 <param name="cancellationToken">A cancellation token used to cancel polling.</param>
\r
3757 Post-.NET4, passing a CTS to ContinueWith causes the continuation to be removed. But in .NET 4 it does not,
\r
3758 which can lead to memory leaks when used this way. We need to know when a long-lived task completes, so
\r
3759 our best option for .NET 4 is just to poll, and cancel the polling when everything completes sucessfully.
\r
3762 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.InitializeStackTrace(System.Exception)">
\r
3763 <summary>Initializes the stack trace and watson bucket of an inactive exception.</summary>
\r
3764 <param name="exception">The exception to initialize.</param>
\r
3765 <returns>The initialized exception.</returns>
\r
3767 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.StoreDataflowMessageValueIntoExceptionData``1(System.Exception,``0,System.Boolean)">
\r
3768 <summary>Stores details on a dataflow message into an Exception's Data collection.</summary>
\r
3769 <typeparam name="T">Specifies the type of data stored in the message.</typeparam>
\r
3770 <param name="exc">The Exception whose Data collection should store message information.</param>
\r
3771 <param name="messageValue">The message information to be stored.</param>
\r
3772 <param name="targetInnerExceptions">Whether to store the data into the exception's inner exception(s) in addition to the exception itself.</param>
\r
3774 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.StoreStringIntoExceptionData(System.Exception,System.String,System.String)">
\r
3775 <summary>Stores the specified string value into the specified key slot of the specified exception's data dictionary.</summary>
\r
3776 <param name="exception">The exception into which the key/value should be stored.</param>
\r
3777 <param name="key">The key.</param>
\r
3778 <param name="value">The value to be serialized as a string and stored.</param>
\r
3779 <remarks>If the key is already present in the exception's data dictionary, the value is not overwritten.</remarks>
\r
3781 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.ThrowAsync(System.Exception)">
\r
3782 <summary>Throws an exception asynchronously on the thread pool.</summary>
\r
3783 <param name="error">The exception to throw.</param>
\r
3785 This function is used when an exception needs to be propagated from a thread
\r
3786 other than the current context. This could happen, for example, if the exception
\r
3787 should cause the standard CLR exception escalation behavior, but we're inside
\r
3788 of a task that will squirrel the exception away.
\r
3791 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.AddException(System.Collections.Generic.List{System.Exception}@,System.Exception,System.Boolean)">
\r
3792 <summary>Adds the exception to the list, first initializing the list if the list is null.</summary>
\r
3793 <param name="list">The list to add the exception to, and initialize if null.</param>
\r
3794 <param name="exception">The exception to add or whose inner exception(s) should be added.</param>
\r
3795 <param name="unwrapInnerExceptions">Unwrap and add the inner exception(s) rather than the specified exception directly.</param>
\r
3797 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.CreateTaskFromResult``1(``0)">
\r
3798 <summary>Creates a task completed with the specified result.</summary>
\r
3799 <typeparam name="TResult">Specifies the type of the result for this task.</typeparam>
\r
3800 <param name="result">The result with which to complete the task.</param>
\r
3801 <returns>The completed task.</returns>
\r
3803 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.CreateTaskFromException``1(System.Exception)">
\r
3804 <summary>Creates a task faulted with the specified exception.</summary>
\r
3805 <typeparam name="TResult">Specifies the type of the result for this task.</typeparam>
\r
3806 <param name="exception">The exception with which to complete the task.</param>
\r
3807 <returns>The faulted task.</returns>
\r
3809 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.CreateTaskFromCancellation``1(System.Threading.CancellationToken)">
\r
3810 <summary>Creates a task canceled with the specified cancellation token.</summary>
\r
3811 <typeparam name="TResult">Specifies the type of the result for this task.</typeparam>
\r
3812 <returns>The canceled task.</returns>
\r
3814 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.GetPotentiallyNotSupportedCompletionTask(System.Threading.Tasks.Dataflow.IDataflowBlock)">
\r
3815 <summary>Gets the completion task of a block, and protects against common cases of the completion task not being implemented or supported.</summary>
\r
3816 <param name="block">The block.</param>
\r
3817 <returns>The completion task, or null if the block's completion task is not implemented or supported.</returns>
\r
3819 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.CreateUnlinker``1(System.Object,System.Threading.Tasks.Dataflow.Internal.TargetRegistry{``0},System.Threading.Tasks.Dataflow.ITargetBlock{``0})">
\r
3821 Creates an IDisposable that, when disposed, will acquire the outgoing lock while removing
\r
3822 the target block from the target registry.
\r
3824 <typeparam name="TOutput">Specifies the type of data in the block.</typeparam>
\r
3825 <param name="outgoingLock">The outgoing lock used to protect the target registry.</param>
\r
3826 <param name="targetRegistry">The target registry from which the target should be removed.</param>
\r
3827 <param name="targetBlock">The target to remove from the registry.</param>
\r
3828 <returns>An IDisposable that will unregister the target block from the registry while holding the outgoing lock.</returns>
\r
3830 <member name="F:System.Threading.Tasks.Dataflow.Internal.Common.InfiniteTimeSpan">
\r
3831 <summary>An infinite TimeSpan.</summary>
\r
3833 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.IsValidTimeout(System.TimeSpan)">
\r
3834 <summary>Validates that a timeout either is -1 or is non-negative and within the range of an Int32.</summary>
\r
3835 <param name="timeout">The timeout to validate.</param>
\r
3836 <returns>true if the timeout is valid; otherwise, false.</returns>
\r
3838 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.GetCreationOptionsForTask(System.Boolean)">
\r
3839 <summary>Gets the options to use for tasks.</summary>
\r
3840 <param name="isReplacementReplica">If this task is being created to replace another.</param>
\r
3842 These options should be used for all tasks that have the potential to run user code or
\r
3843 that are repeatedly spawned and thus need a modicum of fair treatment.
\r
3846 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.CreateCopyAndRun(System.Threading.ExecutionContext,System.Threading.ContextCallback,System.Object)">
\r
3847 <summary>Runs the provided callback under a copy of the specified, non-null context.</summary>
\r
3848 <param name="executionContext">The context to copy and utilize to run the callback.</param>
\r
3849 <param name="callback">The callback to execute.</param>
\r
3850 <param name="state">The state to pass to the callback.</param>
\r
3852 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.InvokeCallbackWithContext(System.Threading.ExecutionContext,System.Threading.ContextCallback,System.Object)">
\r
3853 <summary>Executes a callback delegate in the specified execution context.</summary>
\r
3854 <param name="executionContext">The context in which to execute. If null, the delegate will be invoked directly.</param>
\r
3855 <param name="callback">The delegate to execute.</param>
\r
3856 <param name="state">The data to pass to the callback delegate.</param>
\r
3858 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.InvokeCloningFunctionWithContext``1(System.Threading.ExecutionContext,System.Func{``0,``0},``0)">
\r
3859 <summary>Executes a cloning function in the specified execution context.</summary>
\r
3860 <param name="executionContext">The context in which to execute. If null, the delegate will be invoked directly.</param>
\r
3861 <param name="cloningFunction">The delegate to execute to clone the item.</param>
\r
3862 <param name="item">The item to be cloned.</param>
\r
3864 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.StartTaskSafe(System.Threading.Tasks.Task@,System.Threading.Tasks.TaskScheduler)">
\r
3865 <summary>Starts an already constructed task with handling and observing exceptions that may come from the scheduling process.</summary>
\r
3866 <param name="task">Task to be started.</param>
\r
3867 <param name="scheduler">TaskScheduler to schedule the task on.</param>
\r
3868 <returns>null on success, an exception reference on scheduling error. In the latter case, the task reference is nulled out.</returns>
\r
3870 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.StartTaskSafeCore(System.Threading.Tasks.Task@,System.Threading.Tasks.TaskScheduler)">
\r
3871 <summary>Starts an already constructed task with handling and observing exceptions that may come from the scheduling process.</summary>
\r
3872 <param name="task">Task to be started.</param>
\r
3873 <param name="scheduler">TaskScheduler to schedule the task on.</param>
\r
3874 <returns>null on success, an exception reference on scheduling error. In the latter case, the task reference is nulled out.</returns>
\r
3876 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.ReleaseAllPostponedMessages``1(System.Threading.Tasks.Dataflow.ITargetBlock{``0},System.Threading.Tasks.Dataflow.Internal.StackedMap{System.Threading.Tasks.Dataflow.ISourceBlock{``0},System.Threading.Tasks.Dataflow.DataflowMessageHeader},System.Collections.Generic.List{System.Exception}@)">
\r
3877 <summary>Pops and explicitly releases postponed messages after the block is done with processing.</summary>
\r
3878 <remarks>No locks should be held at this time. Unfortunately we cannot assert that.</remarks>
\r
3880 <member name="T:System.Threading.Tasks.Dataflow.Internal.Common.CloningFunctionContextState`1">
\r
3882 Provides a wrapper for use with CloneContextAndRun, alleviating the need for both
\r
3883 a closure and a delegate to that closure to be allocated.
\r
3885 <typeparam name="T">Specifies the type of the input and output data.</typeparam>
\r
3887 <member name="F:System.Threading.Tasks.Dataflow.Internal.Common.CloningFunctionContextState`1.Input">
\r
3888 <summary>The input to be cloned.</summary>
\r
3890 <member name="F:System.Threading.Tasks.Dataflow.Internal.Common.CloningFunctionContextState`1.CloningFunction">
\r
3891 <summary>The cloning function.</summary>
\r
3893 <member name="F:System.Threading.Tasks.Dataflow.Internal.Common.CloningFunctionContextState`1.Output">
\r
3894 <summary>The result of the cloning operation.</summary>
\r
3896 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.CloningFunctionContextState`1.#ctor(`0,System.Func{`0,`0})">
\r
3897 <summary>Initializes the cloning state.</summary>
\r
3898 <param name="input">The input to be cloned.</param>
\r
3899 <param name="cloningFunction">The cloning function.</param>
\r
3901 <member name="M:System.Threading.Tasks.Dataflow.Internal.Common.CloningFunctionContextState`1.Run">
\r
3902 <summary>Runs the cloning function over the input and stores the result into the output.</summary>
\r
3904 <member name="T:System.Threading.Tasks.Dataflow.Internal.Common.CachedGenericDelegates`1">
\r
3905 <summary>Static class used to cache generic delegates the C# compiler doesn't cache by default.</summary>
\r
3906 <remarks>Without this, we end up allocating the generic delegate each time the operation is used.</remarks>
\r
3908 <member name="F:System.Threading.Tasks.Dataflow.Internal.Common.CachedGenericDelegates`1.DefaultTResultFunc">
\r
3909 <summary>A function that returns the default value of T.</summary>
\r
3911 <member name="F:System.Threading.Tasks.Dataflow.Internal.Common.CachedGenericDelegates`1.RunCloningFunctionContextState">
\r
3912 <summary>A function that calls Run on the CloningFunctionContextState provided as the state parameter.</summary>
\r
3914 <member name="F:System.Threading.Tasks.Dataflow.Internal.Common.CachedGenericDelegates`1.CreateUnlinkerShimAction">
\r
3916 A function to use as the body of ActionOnDispose in CreateUnlinkerShim.
\r
3917 Passed a tuple of the sync obj, the target registry, and the target block as the state parameter.
\r
3920 <member name="T:System.Threading.Tasks.Dataflow.Internal.BoundingState">
\r
3921 <summary>State used only when bounding.</summary>
\r
3923 <member name="F:System.Threading.Tasks.Dataflow.Internal.BoundingState.BoundedCapacity">
\r
3924 <summary>The maximum number of messages allowed to be buffered.</summary>
\r
3926 <member name="F:System.Threading.Tasks.Dataflow.Internal.BoundingState.CurrentCount">
\r
3927 <summary>The number of messages currently stored.</summary>
\r
3929 This value may temporarily be higher than the actual number stored.
\r
3930 That's ok, we just can't accept any new messages if CurrentCount >= BoundedCapacity.
\r
3931 Worst case is that we may temporarily have fewer items in the block than our maximum allows,
\r
3932 but we'll never have more.
\r
3935 <member name="M:System.Threading.Tasks.Dataflow.Internal.BoundingState.#ctor(System.Int32)">
\r
3936 <summary>Initializes the BoundingState.</summary>
\r
3937 <param name="boundedCapacity">The positive bounded capacity.</param>
\r
3939 <member name="P:System.Threading.Tasks.Dataflow.Internal.BoundingState.CountIsLessThanBound">
\r
3940 <summary>Gets whether there's room available to add another message.</summary>
\r
3942 <member name="T:System.Threading.Tasks.Dataflow.Internal.BoundingStateWithPostponed`1">
\r
3943 <summary>Stated used only when bounding and when postponed messages are stored.</summary>
\r
3944 <typeparam name="TInput">Specifies the type of input messages.</typeparam>
\r
3946 <member name="M:System.Threading.Tasks.Dataflow.Internal.BoundingStateWithPostponed`1.#ctor(System.Int32)">
\r
3947 <summary>Initializes the BoundingState.</summary>
\r
3948 <param name="boundedCapacity">The positive bounded capacity.</param>
\r
3950 <member name="P:System.Threading.Tasks.Dataflow.Internal.BoundingStateWithPostponed`1.PostponedMessagesCountForDebugger">
\r
3951 <summary>Gets the number of postponed messages for the debugger.</summary>
\r
3953 <member name="T:System.Threading.Tasks.Dataflow.Internal.BoundingStateWithPostponedAndTask`1">
\r
3954 <summary>Stated used only when bounding and when postponed messages and a task are stored.</summary>
\r
3955 <typeparam name="TInput">Specifies the type of input messages.</typeparam>
\r
3957 <member name="F:System.Threading.Tasks.Dataflow.Internal.BoundingStateWithPostponedAndTask`1.TaskForInputProcessing">
\r
3958 <summary>The task used to process messages.</summary>
\r
3960 <member name="M:System.Threading.Tasks.Dataflow.Internal.BoundingStateWithPostponedAndTask`1.#ctor(System.Int32)">
\r
3961 <summary>Initializes the BoundingState.</summary>
\r
3962 <param name="boundedCapacity">The positive bounded capacity.</param>
\r
3964 <member name="T:System.Threading.Tasks.Dataflow.Internal.VoidResult">
\r
3966 Type used with TaskCompletionSource(Of TResult) as the TResult
\r
3967 to ensure that the resulting task can't be upcast to something
\r
3968 that in the future could lead to compat problems.
\r
3971 <member name="T:System.Threading.Tasks.Dataflow.SR">
\r
3973 String resources for .NET 4 builds of System.Threading.Tasks.Dataflow.dll.
\r
3976 <member name="M:System.Threading.Tasks.Dataflow.SR.GetString(System.String)">
\r
3977 <summary>Gets the text string for the specified ID.</summary>
\r
3978 <param name="id">The ID for which to retrieve the string resource.</param>
\r
3979 <returns>The string resource for the specified ID.</returns>
\r
3980 <remarks>This implementation merely returns the provided ID.</remarks>
\r
3982 <member name="T:System.Threading.Tasks.Dataflow.Internal.StackedMap`2">
\r
3984 Provides a data structure that supports pushing and popping key/value pairs.
\r
3985 Pushing a key/value pair for which the key already exists results in overwriting
\r
3986 the existing key entry's value.
\r
3988 <typeparam name="TKey">Specifies the type of keys in the map.</typeparam>
\r
3989 <typeparam name="TValue">Specifies the type of values in the map.</typeparam>
\r
3991 <member name="F:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.m_queue">
\r
3992 <summary>The queue of elements.</summary>
\r
3994 <member name="F:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.m_mapKeyToIndex">
\r
3995 <summary>A map from key to index into the list.</summary>
\r
3996 <remarks>The correctness of this map relies on the list only having elements removed from its end.</remarks>
\r
3998 <member name="M:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.#ctor">
\r
3999 <summary>Initializes the StackedMap.</summary>
\r
4001 <member name="M:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.#ctor(System.Int32)">
\r
4002 <summary>Initializes the StackedMap.</summary>
\r
4003 <param name="capacity">The initial capacity of the data structure.</param>
\r
4005 <member name="M:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.Push(`0,`1)">
\r
4006 <summary>Pushes a key/value pair into the data structure.</summary>
\r
4007 <param name="key">The key for the pair.</param>
\r
4008 <param name="value">The value for the pair.</param>
\r
4010 <member name="M:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.TryPop(System.Collections.Generic.KeyValuePair{`0,`1}@)">
\r
4011 <summary>Try to pop the next element from the data structure.</summary>
\r
4012 <param name="item">The popped pair.</param>
\r
4013 <returns>true if an item could be popped; otherwise, false.</returns>
\r
4015 <member name="M:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.PopRange(System.Collections.Generic.KeyValuePair{`0,`1}[],System.Int32,System.Int32)">
\r
4016 <summary>Tries to pop one or more elements from the data structure.</summary>
\r
4017 <param name="items">The items array into which the popped elements should be stored.</param>
\r
4018 <param name="arrayOffset">The offset into the array at which to start storing popped items.</param>
\r
4019 <param name="count">The number of items to be popped.</param>
\r
4020 <returns>The number of items popped, which may be less than the requested number if fewer existed in the data structure.</returns>
\r
4022 <member name="M:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.Clear">
\r
4023 <summary>Removes all elements from the data structure.</summary>
\r
4025 <member name="P:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.Count">
\r
4026 <summary>Gets the number of items in the data structure.</summary>
\r
4028 <member name="T:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.EfficientQueue`1">
\r
4030 A queue structure that uses an array-based list to store its items
\r
4031 and thus to avoid heap allocations.
\r
4033 <typeparam name="T">The type of the items storedin the queue</typeparam>
\r
4035 <member name="F:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.EfficientQueue`1.TERMINATOR_INDEX">
\r
4036 <summary>Terminator index.</summary>
\r
4038 <member name="F:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.EfficientQueue`1.m_storage">
\r
4039 <summary>The stack-like structure where the items will be stored.</summary>
\r
4041 <member name="F:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.EfficientQueue`1.m_headIndex">
\r
4042 <summary>Index of the first queue item.</summary>
\r
4044 <member name="F:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.EfficientQueue`1.m_tailIndex">
\r
4045 <summary>Index of the last queue item.</summary>
\r
4047 <member name="F:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.EfficientQueue`1.m_freeIndex">
\r
4048 <summary>Index of the first free slot.</summary>
\r
4050 <member name="M:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.EfficientQueue`1.#ctor">
\r
4051 <summary>Initializes the Queue instance.</summary>
\r
4053 <member name="M:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.EfficientQueue`1.#ctor(System.Int32)">
\r
4054 <summary>Initializes the Queue instance.</summary>
\r
4055 <param name="capacity">The capacity of the internal storage.</param>
\r
4057 <member name="M:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.EfficientQueue`1.Enqueue(`2)">
\r
4058 <summary>Enqueues an item.</summary>
\r
4059 <param name="item">The item to be enqueued.</param>
\r
4060 <returns>The index of the slot where item was stored.</returns>
\r
4062 <member name="M:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.EfficientQueue`1.TryDequeue(`2@)">
\r
4063 <summary>Tries to dequeue an item.</summary>
\r
4064 <param name="item">The item that is dequeued.</param>
\r
4066 <member name="M:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.EfficientQueue`1.Replace(System.Int32,`2)">
\r
4067 <summary>Replaces the item of a given slot.</summary>
\r
4068 <param name="index">The index of the slot where the value should be replaced.</param>
\r
4069 <param name="item">The item to be places.</param>
\r
4071 <member name="T:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.DebugView">
\r
4072 <summary>Debugger type proxy for StackedMap.</summary>
\r
4074 <member name="F:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.DebugView.m_map">
\r
4075 <summary>The map being visualized.</summary>
\r
4077 <member name="M:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.DebugView.#ctor(System.Threading.Tasks.Dataflow.Internal.StackedMap{`0,`1})">
\r
4078 <summary>Initializes the debug view.</summary>
\r
4079 <param name="map">The map being debugged.</param>
\r
4081 <member name="P:System.Threading.Tasks.Dataflow.Internal.StackedMap`2.DebugView.Items">
\r
4082 <summary>Gets the contents of the map.</summary>
\r
4084 <member name="T:System.Threading.Tasks.Dataflow.Internal.DataflowEtwProvider">
\r
4085 <summary>Provides an event source for tracing Dataflow information.</summary>
\r
4087 <member name="F:System.Threading.Tasks.Dataflow.Internal.DataflowEtwProvider.DATAFLOWBLOCKCREATED_EVENTID">
\r
4088 <summary>The event ID for when we encounter a new dataflow block object that hasn't had its name traced to the trace file.</summary>
\r
4090 <member name="F:System.Threading.Tasks.Dataflow.Internal.DataflowEtwProvider.TASKLAUNCHED_EVENTID">
\r
4091 <summary>The event ID for the task launched event.</summary>
\r
4093 <member name="F:System.Threading.Tasks.Dataflow.Internal.DataflowEtwProvider.BLOCKCOMPLETED_EVENTID">
\r
4094 <summary>The event ID for the block completed event.</summary>
\r
4096 <member name="F:System.Threading.Tasks.Dataflow.Internal.DataflowEtwProvider.BLOCKLINKED_EVENTID">
\r
4097 <summary>The event ID for the block linked event.</summary>
\r
4099 <member name="F:System.Threading.Tasks.Dataflow.Internal.DataflowEtwProvider.BLOCKUNLINKED_EVENTID">
\r
4100 <summary>The event ID for the block unlinked event.</summary>
\r
4102 <member name="F:System.Threading.Tasks.Dataflow.Internal.DataflowEtwProvider.Log">
\r
4104 Defines the singleton instance for the dataflow ETW provider.
\r
4105 The dataflow provider GUID is {16F53577-E41D-43D4-B47E-C17025BF4025}.
\r
4108 <member name="M:System.Threading.Tasks.Dataflow.Internal.DataflowEtwProvider.#ctor">
\r
4109 <summary>Prevent external instantiation. All logging should go through the Log instance.</summary>
\r
4111 <member name="M:System.Threading.Tasks.Dataflow.Internal.DataflowEtwProvider.DataflowBlockCreated(System.Threading.Tasks.Dataflow.IDataflowBlock)">
\r
4112 <summary>Trace an event for when a new block is instantiated.</summary>
\r
4113 <param name="block">The dataflow block that was created.</param>
\r
4115 <member name="M:System.Threading.Tasks.Dataflow.Internal.DataflowEtwProvider.TaskLaunchedForMessageHandling(System.Threading.Tasks.Dataflow.IDataflowBlock,System.Threading.Tasks.Dataflow.Internal.DataflowEtwProvider.TaskLaunchedReason,System.Int32)">
\r
4116 <summary>Trace an event for a block launching a task to handle messages.</summary>
\r
4117 <param name="block">The owner block launching a task.</param>
\r
4118 <param name="reason">The reason the task is being launched.</param>
\r
4119 <param name="availableMessages">The number of messages available to be handled by the task.</param>
\r
4121 <member name="M:System.Threading.Tasks.Dataflow.Internal.DataflowEtwProvider.DataflowBlockCompleted(System.Threading.Tasks.Dataflow.IDataflowBlock)">
\r
4122 <summary>Trace an event for a block completing.</summary>
\r
4123 <param name="block">The block that's completing.</param>
\r
4125 <member name="M:System.Threading.Tasks.Dataflow.Internal.DataflowEtwProvider.DataflowBlockLinking``1(System.Threading.Tasks.Dataflow.ISourceBlock{``0},System.Threading.Tasks.Dataflow.ITargetBlock{``0})">
\r
4126 <summary>Trace an event for a block linking.</summary>
\r
4127 <param name="source">The source block linking to a target.</param>
\r
4128 <param name="target">The target block being linked from a source.</param>
\r
4130 <member name="M:System.Threading.Tasks.Dataflow.Internal.DataflowEtwProvider.DataflowBlockUnlinking``1(System.Threading.Tasks.Dataflow.ISourceBlock{``0},System.Threading.Tasks.Dataflow.ITargetBlock{``0})">
\r
4131 <summary>Trace an event for a block unlinking.</summary>
\r
4132 <param name="source">The source block unlinking from a target.</param>
\r
4133 <param name="target">The target block being unlinked from a source.</param>
\r
4135 <member name="T:System.Threading.Tasks.Dataflow.Internal.DataflowEtwProvider.TaskLaunchedReason">
\r
4136 <summary>Describes the reason a task is being launched.</summary>
\r
4138 <member name="F:System.Threading.Tasks.Dataflow.Internal.DataflowEtwProvider.TaskLaunchedReason.ProcessingInputMessages">
\r
4139 <summary>A task is being launched to process incoming messages.</summary>
\r
4141 <member name="F:System.Threading.Tasks.Dataflow.Internal.DataflowEtwProvider.TaskLaunchedReason.OfferingOutputMessages">
\r
4142 <summary>A task is being launched to offer outgoing messages to linked targets.</summary>
\r
4144 <member name="T:System.Threading.Tasks.Dataflow.Internal.DataflowEtwProvider.BlockCompletionReason">
\r
4145 <summary>Describes the reason a block completed.</summary>
\r
4147 <member name="F:System.Threading.Tasks.Dataflow.Internal.DataflowEtwProvider.BlockCompletionReason.RanToCompletion">
\r
4148 <summary>The block completed successfully.</summary>
\r
4150 <member name="F:System.Threading.Tasks.Dataflow.Internal.DataflowEtwProvider.BlockCompletionReason.Faulted">
\r
4151 <summary>The block completed due to an error.</summary>
\r
4153 <member name="F:System.Threading.Tasks.Dataflow.Internal.DataflowEtwProvider.BlockCompletionReason.Canceled">
\r
4154 <summary>The block completed due to cancelation.</summary>
\r
4156 <member name="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader">
\r
4157 <summary>Provides a container of data attributes for passing between dataflow blocks.</summary>
\r
4159 <member name="F:System.Threading.Tasks.Dataflow.DataflowMessageHeader.m_id">
\r
4160 <summary>The message ID. Needs to be unique within the source.</summary>
\r
4162 <member name="M:System.Threading.Tasks.Dataflow.DataflowMessageHeader.#ctor(System.Int64)">
\r
4163 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> with the specified attributes.</summary>
\r
4164 <param name="id">The ID of the message. Must be unique within the originating source block. Need not be globally unique.</param>
\r
4166 <member name="M:System.Threading.Tasks.Dataflow.DataflowMessageHeader.Equals(System.Threading.Tasks.Dataflow.DataflowMessageHeader)">
\r
4167 <summary>Checks two <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances for equality by ID without boxing.</summary>
\r
4168 <param name="other">Another <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance.</param>
\r
4169 <returns>True if the instances are equal. False otherwise.</returns>
\r
4171 <member name="M:System.Threading.Tasks.Dataflow.DataflowMessageHeader.Equals(System.Object)">
\r
4172 <summary>Checks boxed <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances for equality by ID.</summary>
\r
4173 <param name="obj">A boxed <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance.</param>
\r
4174 <returns>True if the instances are equal. False otherwise.</returns>
\r
4176 <member name="M:System.Threading.Tasks.Dataflow.DataflowMessageHeader.GetHashCode">
\r
4177 <summary>Generates a hash code for the <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance.</summary>
\r
4178 <returns>Hash code.</returns>
\r
4180 <member name="M:System.Threading.Tasks.Dataflow.DataflowMessageHeader.op_Equality(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.DataflowMessageHeader)">
\r
4181 <summary>Checks two <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances for equality by ID.</summary>
\r
4182 <param name="left">A <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance.</param>
\r
4183 <param name="right">A <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance.</param>
\r
4184 <returns>True if the instances are equal. False otherwise.</returns>
\r
4186 <member name="M:System.Threading.Tasks.Dataflow.DataflowMessageHeader.op_Inequality(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.DataflowMessageHeader)">
\r
4187 <summary>Checks two <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances for non-equality by ID.</summary>
\r
4188 <param name="left">A <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance.</param>
\r
4189 <param name="right">A <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance.</param>
\r
4190 <returns>True if the instances are not equal. False otherwise.</returns>
\r
4192 <member name="P:System.Threading.Tasks.Dataflow.DataflowMessageHeader.IsValid">
\r
4193 <summary>Gets the validity of the message.</summary>
\r
4194 <returns>True if the ID of the message is different from 0. False if the ID of the message is 0</returns>
\r
4196 <member name="P:System.Threading.Tasks.Dataflow.DataflowMessageHeader.Id">
\r
4197 <summary>Gets the ID of the message within the source.</summary>
\r
4198 <returns>The ID contained in the <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance.</returns>
\r
4200 <member name="T:System.Threading.Tasks.Dataflow.DataflowBlockOptions">
\r
4202 Provides options used to configure the processing performed by dataflow blocks.
\r
4205 <see cref="T:System.Threading.Tasks.Dataflow.DataflowBlockOptions"/> is mutable and can be configured through its properties.
\r
4206 When specific configuration options are not set, the following defaults are used:
\r
4207 <list type="table">
\r
4209 <term>Options</term>
\r
4210 <description>Default</description>
\r
4213 <term>TaskScheduler</term>
\r
4214 <description><see cref="P:System.Threading.Tasks.TaskScheduler.Default"/></description>
\r
4217 <term>MaxMessagesPerTask</term>
\r
4218 <description>DataflowBlockOptions.Unbounded (-1)</description>
\r
4221 <term>CancellationToken</term>
\r
4222 <description><see cref="P:System.Threading.CancellationToken.None"/></description>
\r
4225 <term>BoundedCapacity</term>
\r
4226 <description>DataflowBlockOptions.Unbounded (-1)</description>
\r
4229 Dataflow blocks capture the state of the options at their construction. Subsequent changes
\r
4230 to the provided <see cref="T:System.Threading.Tasks.Dataflow.DataflowBlockOptions"/> instance should not affect the behavior
\r
4231 of a dataflow block.
\r
4234 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlockOptions.Unbounded">
\r
4236 A constant used to specify an unlimited quanity for <see cref="T:System.Threading.Tasks.Dataflow.DataflowBlockOptions"/> members
\r
4237 that provide an upper bound. This field is constant.
\r
4240 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlockOptions.m_taskScheduler">
\r
4241 <summary>The scheduler to use for scheduling tasks to process messages.</summary>
\r
4243 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlockOptions.m_cancellationToken">
\r
4244 <summary>The cancellation token to monitor for cancellation requests.</summary>
\r
4246 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlockOptions.m_maxMessagesPerTask">
\r
4247 <summary>The maximum number of messages that may be processed per task.</summary>
\r
4249 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlockOptions.m_boundedCapacity">
\r
4250 <summary>The maximum number of messages that may be buffered by the block.</summary>
\r
4252 <member name="F:System.Threading.Tasks.Dataflow.DataflowBlockOptions.Default">
\r
4253 <summary>A default instance of <see cref="T:System.Threading.Tasks.Dataflow.DataflowBlockOptions"/>.</summary>
\r
4255 Do not change the values of this instance. It is shared by all of our blocks when no options are provided by the user.
\r
4258 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlockOptions.DefaultOrClone">
\r
4259 <summary>Returns this <see cref="T:System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions"/> instance if it's the default instance or else a cloned instance.</summary>
\r
4260 <returns>An instance of the options that may be cached by the block.</returns>
\r
4262 <member name="M:System.Threading.Tasks.Dataflow.DataflowBlockOptions.#ctor">
\r
4263 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.DataflowBlockOptions"/>.</summary>
\r
4265 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlockOptions.TaskScheduler">
\r
4266 <summary>Gets or sets the <see cref="T:System.Threading.Tasks.TaskScheduler"/> to use for scheduling tasks.</summary>
\r
4268 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlockOptions.CancellationToken">
\r
4269 <summary>Gets or sets the <see cref="T:System.Threading.CancellationToken"/> to monitor for cancellation requests.</summary>
\r
4271 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlockOptions.MaxMessagesPerTask">
\r
4272 <summary>Gets or sets the maximum number of messages that may be processed per task.</summary>
\r
4274 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlockOptions.ActualMaxMessagesPerTask">
\r
4275 <summary>Gets a MaxMessagesPerTask value that may be used for comparison purposes.</summary>
\r
4276 <returns>The maximum value, usable for comparison purposes.</returns>
\r
4277 <remarks>Unlinke MaxMessagesPerTask, this property will always return a positive value.</remarks>
\r
4279 <member name="P:System.Threading.Tasks.Dataflow.DataflowBlockOptions.BoundedCapacity">
\r
4280 <summary>Gets or sets the maximum number of messages that may be buffered by the block.</summary>
\r
4282 <member name="T:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions">
\r
4284 Provides options used to configure the processing performed by dataflow blocks that
\r
4285 process each message through the invocation of a user-provided delegate, blocks such
\r
4286 as <see cref="T:System.Threading.Tasks.Dataflow.ActionBlock`1"/> and <see cref="T:System.Threading.Tasks.Dataflow.TransformBlock`2"/>.
\r
4289 <see cref="T:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions"/> is mutable and can be configured through its properties.
\r
4290 When specific configuration options are not set, the following defaults are used:
\r
4291 <list type="table">
\r
4293 <term>Options</term>
\r
4294 <description>Default</description>
\r
4297 <term>TaskScheduler</term>
\r
4298 <description><see cref="P:System.Threading.Tasks.TaskScheduler.Default"/></description>
\r
4301 <term>CancellationToken</term>
\r
4302 <description><see cref="P:System.Threading.CancellationToken.None"/></description>
\r
4305 <term>MaxMessagesPerTask</term>
\r
4306 <description>DataflowBlockOptions.Unbounded (-1)</description>
\r
4309 <term>BoundedCapacity</term>
\r
4310 <description>DataflowBlockOptions.Unbounded (-1)</description>
\r
4313 <term>MaxDegreeOfParallelism</term>
\r
4314 <description>1</description>
\r
4317 Dataflow block capture the state of the options at their construction. Subsequent changes
\r
4318 to the provided <see cref="T:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions"/> instance should not affect the behavior
\r
4319 of a dataflow block.
\r
4322 <member name="F:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions.Default">
\r
4323 <summary>A default instance of <see cref="T:System.Threading.Tasks.Dataflow.DataflowBlockOptions"/>.</summary>
\r
4325 Do not change the values of this instance. It is shared by all of our blocks when no options are provided by the user.
\r
4328 <member name="M:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions.DefaultOrClone">
\r
4329 <summary>Returns this <see cref="T:System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions"/> instance if it's the default instance or else a cloned instance.</summary>
\r
4330 <returns>An instance of the options that may be cached by the block.</returns>
\r
4332 <member name="F:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions.m_maxDegreeOfParallelism">
\r
4333 <summary>The maximum number of tasks that may be used concurrently to process messages.</summary>
\r
4335 <member name="M:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions.#ctor">
\r
4336 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions"/>.</summary>
\r
4338 <member name="P:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions.MaxDegreeOfParallelism">
\r
4339 <summary>Gets the maximum number of messages that may be processed by the block concurrently.</summary>
\r
4341 <member name="P:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions.ActualMaxDegreeOfParallelism">
\r
4342 <summary>Gets a MaxDegreeOfParallelism value that may be used for comparison purposes.</summary>
\r
4343 <returns>The maximum value, usable for comparison purposes.</returns>
\r
4344 <remarks>Unlinke MaxDegreeOfParallelism, this property will always return a positive value.</remarks>
\r
4346 <member name="P:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions.SupportsParallelExecution">
\r
4347 <summary>Gets whether these dataflow block options allow for parallel execution.</summary>
\r
4349 <member name="T:System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions">
\r
4351 Provides options used to configure the processing performed by dataflow blocks that
\r
4352 group together multiple messages, blocks such as <see cref="T:System.Threading.Tasks.Dataflow.JoinBlock`2"/> and
\r
4353 <see cref="T:System.Threading.Tasks.Dataflow.BatchBlock`1"/>.
\r
4356 <see cref="T:System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions"/> is mutable and can be configured through its properties.
\r
4357 When specific configuration options are not set, the following defaults are used:
\r
4358 <list type="table">
\r
4360 <term>Options</term>
\r
4361 <description>Default</description>
\r
4364 <term>TaskScheduler</term>
\r
4365 <description><see cref="P:System.Threading.Tasks.TaskScheduler.Default"/></description>
\r
4368 <term>CancellationToken</term>
\r
4369 <description><see cref="P:System.Threading.CancellationToken.None"/></description>
\r
4372 <term>MaxMessagesPerTask</term>
\r
4373 <description>DataflowBlockOptions.Unbounded (-1)</description>
\r
4376 <term>BoundedCapacity</term>
\r
4377 <description>DataflowBlockOptions.Unbounded (-1)</description>
\r
4380 <term>MaxNumberOfGroups</term>
\r
4381 <description>GroupingDataflowBlockOptions.Unbounded (-1)</description>
\r
4384 <term>Greedy</term>
\r
4385 <description>true</description>
\r
4388 Dataflow block capture the state of the options at their construction. Subsequent changes
\r
4389 to the provided <see cref="T:System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions"/> instance should not affect the behavior
\r
4390 of a dataflow block.
\r
4393 <member name="F:System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions.Default">
\r
4394 <summary>A default instance of <see cref="T:System.Threading.Tasks.Dataflow.DataflowBlockOptions"/>.</summary>
\r
4396 Do not change the values of this instance. It is shared by all of our blocks when no options are provided by the user.
\r
4399 <member name="M:System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions.DefaultOrClone">
\r
4400 <summary>Returns this <see cref="T:System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions"/> instance if it's the default instance or else a cloned instance.</summary>
\r
4401 <returns>An instance of the options that may be cached by the block.</returns>
\r
4403 <member name="F:System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions.m_greedy">
\r
4404 <summary>Whether the block should greedily consume offered messages.</summary>
\r
4406 <member name="F:System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions.m_maxNumberOfGroups">
\r
4407 <summary>The maximum number of groups that should be generated by the block.</summary>
\r
4409 <member name="M:System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions.#ctor">
\r
4410 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions"/>.</summary>
\r
4412 <member name="P:System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions.Greedy">
\r
4413 <summary>Gets or sets the Boolean value to use to determine whether to greedily consume offered messages.</summary>
\r
4415 <member name="P:System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions.MaxNumberOfGroups">
\r
4416 <summary>Gets or sets the maximum number of groups that should be generated by the block.</summary>
\r
4418 <member name="P:System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions.ActualMaxNumberOfGroups">
\r
4419 <summary>Gets a MaxDegreeOfParallelism value that may be used for comparison purposes.</summary>
\r
4420 <returns>The maximum value, usable for comparison purposes.</returns>
\r
4421 <remarks>Unlinke MaxDegreeOfParallelism, this property will always return a positive value.</remarks>
\r
4423 <member name="T:System.Threading.Tasks.Dataflow.DataflowMessageStatus">
\r
4424 <summary>Represents the status of a <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> when passed between dataflow blocks.</summary>
\r
4426 <member name="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Accepted">
\r
4428 Indicates that the <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> accepted the message. Once a target has accepted a message,
\r
4429 it is wholly owned by the target.
\r
4432 <member name="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined">
\r
4434 Indicates that the <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> declined the message. The <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> still owns the message.
\r
4437 <member name="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Postponed">
\r
4439 Indicates that the <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> postponed the message for potential consumption at a later time.
\r
4440 The <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> still owns the message.
\r
4443 <member name="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.NotAvailable">
\r
4445 Indicates that the <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> tried to accept the message from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>, but the
\r
4446 message was no longer available.
\r
4449 <member name="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.DecliningPermanently">
\r
4451 Indicates that the <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> declined the message. The <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> still owns the message.
\r
4452 Additionally, the <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> will decline all future messages sent by the source.
\r
4455 <member name="T:System.Threading.Tasks.Dataflow.TransformManyBlock`2">
\r
4456 <summary>Provides a dataflow block that invokes a provided <see cref="T:System.Func`2"/> delegate for every data element received.</summary>
\r
4457 <typeparam name="TInput">Specifies the type of data received and operated on by this <see cref="T:System.Threading.Tasks.Dataflow.TransformManyBlock`2"/>.</typeparam>
\r
4458 <typeparam name="TOutput">Specifies the type of data output by this <see cref="T:System.Threading.Tasks.Dataflow.TransformManyBlock`2"/>.</typeparam>
\r
4460 <member name="F:System.Threading.Tasks.Dataflow.TransformManyBlock`2.m_target">
\r
4461 <summary>The target side.</summary>
\r
4463 <member name="F:System.Threading.Tasks.Dataflow.TransformManyBlock`2.m_reorderingBuffer">
\r
4464 <summary>Buffer used to reorder outputs that may have completed out-of-order between the target half and the source half.</summary>
\r
4466 <member name="F:System.Threading.Tasks.Dataflow.TransformManyBlock`2.m_source">
\r
4467 <summary>The source side.</summary>
\r
4469 <member name="M:System.Threading.Tasks.Dataflow.TransformManyBlock`2.#ctor(System.Func{`0,System.Collections.Generic.IEnumerable{`1}})">
\r
4470 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.TransformManyBlock`2"/> with the specified function.</summary>
\r
4471 <param name="transform">
\r
4472 The function to invoke with each data element received. All of the data from the returned <see cref="T:System.Collections.Generic.IEnumerable`1"/>
\r
4473 will be made available as output from this <see cref="T:System.Threading.Tasks.Dataflow.TransformManyBlock`2"/>.
\r
4475 <exception cref="T:System.ArgumentNullException">The <paramref name="transform"/> is null (Nothing in Visual Basic).</exception>
\r
4477 <member name="M:System.Threading.Tasks.Dataflow.TransformManyBlock`2.#ctor(System.Func{`0,System.Collections.Generic.IEnumerable{`1}},System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions)">
\r
4478 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.TransformManyBlock`2"/> with the specified function and <see cref="T:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions"/>.</summary>
\r
4479 <param name="transform">
\r
4480 The function to invoke with each data element received. All of the data from the returned in the <see cref="T:System.Collections.Generic.IEnumerable`1"/>
\r
4481 will be made available as output from this <see cref="T:System.Threading.Tasks.Dataflow.TransformManyBlock`2"/>.
\r
4483 <param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.TransformManyBlock`2"/>.</param>
\r
4484 <exception cref="T:System.ArgumentNullException">The <paramref name="transform"/> is null (Nothing in Visual Basic).</exception>
\r
4485 <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
\r
4487 <member name="M:System.Threading.Tasks.Dataflow.TransformManyBlock`2.#ctor(System.Func{`0,System.Threading.Tasks.Task{System.Collections.Generic.IEnumerable{`1}}})">
\r
4488 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.TransformManyBlock`2"/> with the specified function.</summary>
\r
4489 <param name="transform">
\r
4490 The function to invoke with each data element received. All of the data asynchronously returned in the <see cref="T:System.Collections.Generic.IEnumerable`1"/>
\r
4491 will be made available as output from this <see cref="T:System.Threading.Tasks.Dataflow.TransformManyBlock`2"/>.
\r
4493 <exception cref="T:System.ArgumentNullException">The <paramref name="transform"/> is null (Nothing in Visual Basic).</exception>
\r
4495 <member name="M:System.Threading.Tasks.Dataflow.TransformManyBlock`2.#ctor(System.Func{`0,System.Threading.Tasks.Task{System.Collections.Generic.IEnumerable{`1}}},System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions)">
\r
4496 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.TransformManyBlock`2"/> with the specified function and <see cref="T:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions"/>.</summary>
\r
4497 <param name="transform">
\r
4498 The function to invoke with each data element received. All of the data asynchronously returned in the <see cref="T:System.Collections.Generic.IEnumerable`1"/>
\r
4499 will be made available as output from this <see cref="T:System.Threading.Tasks.Dataflow.TransformManyBlock`2"/>.
\r
4501 <param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.TransformManyBlock`2"/>.</param>
\r
4502 <exception cref="T:System.ArgumentNullException">The <paramref name="transform"/> is null (Nothing in Visual Basic).</exception>
\r
4503 <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
\r
4505 <member name="M:System.Threading.Tasks.Dataflow.TransformManyBlock`2.#ctor(System.Delegate,System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions)">
\r
4506 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.TransformManyBlock`2"/> with the specified function and <see cref="T:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions"/>.</summary>
\r
4507 <param name="transform">The function to invoke with each data element received.</param>
\r
4508 <param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.TransformManyBlock`2"/>.</param>
\r
4509 <exception cref="T:System.ArgumentNullException">The <paramref name="transform"/> is null (Nothing in Visual Basic).</exception>
\r
4510 <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
\r
4512 <member name="M:System.Threading.Tasks.Dataflow.TransformManyBlock`2.ProcessMessage(System.Func{`0,System.Collections.Generic.IEnumerable{`1}},System.Collections.Generic.KeyValuePair{`0,System.Int64})">
\r
4513 <summary>Processes the message with a user-provided transform function that returns an enumerable.</summary>
\r
4514 <param name="transformFunction">The transform function to use to process the message.</param>
\r
4515 <param name="messageWithId">The message to be processed.</param>
\r
4517 <member name="M:System.Threading.Tasks.Dataflow.TransformManyBlock`2.ProcessMessageWithTask(System.Func{`0,System.Threading.Tasks.Task{System.Collections.Generic.IEnumerable{`1}}},System.Collections.Generic.KeyValuePair{`0,System.Int64})">
\r
4518 <summary>Processes the message with a user-provided transform function that returns an observable.</summary>
\r
4519 <param name="function">The transform function to use to process the message.</param>
\r
4520 <param name="messageWithId">The message to be processed.</param>
\r
4522 <member name="M:System.Threading.Tasks.Dataflow.TransformManyBlock`2.AsyncCompleteProcessMessageWithTask(System.Threading.Tasks.Task{System.Collections.Generic.IEnumerable{`1}},System.Collections.Generic.KeyValuePair{`0,System.Int64})">
\r
4523 <summary>Completes the processing of an asynchronous message.</summary>
\r
4524 <param name="completed">The completed task storing the output data generated for an input message.</param>
\r
4525 <param name="messageWithId">The originating message</param>
\r
4527 <member name="M:System.Threading.Tasks.Dataflow.TransformManyBlock`2.MaterializeAndCountOutputItems(System.Collections.Generic.IEnumerable{`1}@)">
\r
4529 Ensures that the output items enumerable is a type that can be enumerated
\r
4530 without causing exceptions. If it's not such a type, it's enumerated
\r
4531 and turned into one.
\r
4533 <param name="outputItems">The output items.</param>
\r
4534 <returns>The number of items in the enumerable.</returns>
\r
4536 <member name="M:System.Threading.Tasks.Dataflow.TransformManyBlock`2.UpdateBoundingCountWithOutputCount(System.Int32)">
\r
4538 Updates the bounding count based on the number of output items
\r
4539 generated for a single input.
\r
4541 <param name="count">The number of output items.</param>
\r
4543 <member name="M:System.Threading.Tasks.Dataflow.TransformManyBlock`2.Complete">
\r
4545 Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
\r
4546 nor produce any more messages nor consume any more postponed messages.
\r
4547 </summary><remarks>
\r
4548 After Complete has been called on a dataflow block, that block will complete
\r
4549 (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
\r
4550 available data. Complete will not block waiting for completion to occur, but rather will initiaite
\r
4551 the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
\r
4554 <member name="M:System.Threading.Tasks.Dataflow.TransformManyBlock`2.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
\r
4556 Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a
\r
4557 <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
\r
4558 </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
\r
4559 The <paramref name="exception"/> is null (Nothing in Visual Basic).
\r
4560 </exception><remarks>
\r
4561 After Fault has been called on a dataflow block, that block will complete
\r
4562 (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes
\r
4563 buffered messages (uprocessed input messages as well as unoffered output messages) to be lost.
\r
4566 <member name="M:System.Threading.Tasks.Dataflow.TransformManyBlock`2.LinkTo(System.Threading.Tasks.Dataflow.ITargetBlock{`1},System.Boolean)">
\r
4568 Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.
\r
4569 </summary><param name="target">
\r
4570 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect this source.
\r
4571 </param><param name="unlinkAfterOne">
\r
4572 true if the source should unlink from the target after successfully propagating a single message;
\r
4573 otherwise, false to remain connected even after a single message has been propagated.
\r
4574 </param><returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns><exception cref="T:System.ArgumentNullException">
\r
4575 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
4578 <member name="M:System.Threading.Tasks.Dataflow.TransformManyBlock`2.TryReceive(System.Predicate{`1},`1@)">
\r
4580 Attempts to synchronously receive an available output item from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
4581 </summary><param name="filter">
\r
4582 The predicate a value must successfully pass in order for it to be received.
\r
4583 <paramref name="filter"/> may be null (Nothing in Visual Basic), in which case all items will pass.
\r
4584 </param><param name="item">The item received from the source.</param><returns>true if an item could be received; otherwise, false.</returns><remarks>
\r
4585 This method does not block waiting for the source to provide an item.
\r
4586 It will return after checking for an element, whether or not an element was available.
\r
4589 <member name="M:System.Threading.Tasks.Dataflow.TransformManyBlock`2.TryReceiveAll(System.Collections.Generic.IList{`1}@)">
\r
4591 Attempts to synchronously receive all available items from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
4592 </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>
\r
4593 This method does not block waiting for the source to provide an item.
\r
4594 It will return after checking for elements, whether or not an element was available.
\r
4597 <member name="M:System.Threading.Tasks.Dataflow.TransformManyBlock`2.System#Threading#Tasks#Dataflow#ITargetBlock{TInput}#OfferMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,`0,System.Threading.Tasks.Dataflow.ISourceBlock{`0},System.Boolean)">
\r
4599 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.
\r
4600 </summary><param name="messageHeader">
\r
4601 A <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance that represents the header of the message being offered.
\r
4602 </param><param name="messageValue">
\r
4603 The value of the message being offered.
\r
4604 </param><param name="source">
\r
4605 The <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> offering the message. This may be null (Nothing in Visual Basic).
\r
4606 </param><param name="consumeToAccept">
\r
4607 true if the target must call ConsumeMessage synchronously during the call to OfferMessage, prior to returning
\r
4608 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Accepted"/>, in order to consume the message.
\r
4609 false if the target wanting to accept the message should not call ConsumeMessage, and should isntead simply return DataflowMessageStatus.Accepted.
\r
4611 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
\r
4612 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
\r
4613 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.
\r
4614 If the target would have otherwise postponed but source was null, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is instead returned.
\r
4615 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,
\r
4616 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.NotAvailable"/> is returned.
\r
4617 If the target chose not to accept the message, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is returned. If the target
\r
4618 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.
\r
4619 </returns><exception cref="T:System.ArgumentException">
\r
4620 The <paramref name="messageHeader"/> is not valid.
\r
4621 </exception><exception cref="T:System.ArgumentException">
\r
4622 <paramref name="consumeToAccept"/> may only be true if provided with a non-null <paramref name="source"/>.
\r
4625 <member name="M:System.Threading.Tasks.Dataflow.TransformManyBlock`2.System#Threading#Tasks#Dataflow#ISourceBlock{TOutput}#ConsumeMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`1},System.Boolean@)">
\r
4627 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to accept and consume a
\r
4628 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> previously offered by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
4629 </summary><param name="messageHeader">The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being consumed.</param><param name="target">
\r
4630 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> consuming the message.
\r
4631 </param><param name="messageConsumed">
\r
4632 True if the message was successfully consumed. False otherwise.
\r
4635 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
\r
4636 passed as the <paramref name="messageHeader"/> to <see cref="M:ConsumeMessage"/>. The consuming <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must
\r
4637 use the returned value instead of the value passed as messageValue through <see cref="M:OfferMessage"/>.
\r
4640 If the message requested is not available, the return value will be null (Nothing in Visual Basic).
\r
4642 </returns><exception cref="T:System.ArgumentException">
\r
4643 The <paramref name="messageHeader"/> is not valid.
\r
4644 </exception><exception cref="T:System.ArgumentNullException">
\r
4645 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
4646 </exception><remarks>
\r
4648 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
4649 instance may use <see cref="M:ConsumeMessage"/>, and it must only be used
\r
4650 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
4651 offered by this source to the target.
\r
4655 <member name="M:System.Threading.Tasks.Dataflow.TransformManyBlock`2.System#Threading#Tasks#Dataflow#ISourceBlock{TOutput}#ReserveMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`1})">
\r
4657 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"/>
\r
4658 by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
4659 </summary><param name="messageHeader">
\r
4660 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being reserved.
\r
4661 </param><param name="target">
\r
4662 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> reserving the message.
\r
4663 </param><returns>true if the message was successfully reserved; otherwise, false.</returns><exception cref="T:System.ArgumentException">
\r
4664 The <paramref name="messageHeader"/> is not valid.
\r
4665 </exception><exception cref="T:System.ArgumentNullException">
\r
4666 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
4667 </exception><remarks>
\r
4669 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> instance
\r
4670 may use <see cref="M:ReserveMessage"/>, and it must only be used
\r
4671 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
4672 offered by this source to the target.
\r
4675 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.
\r
4676 Failure to do so may result in the source being unable to propagate any further messages to this or other targets.
\r
4679 <see cref="M:ReserveMessage"/> must not be called while the target is holding any internal locks. Doing so will violate the lock hierarchy
\r
4680 necessary to avoid deadlocks in a dataflow network.
\r
4684 <member name="M:System.Threading.Tasks.Dataflow.TransformManyBlock`2.System#Threading#Tasks#Dataflow#ISourceBlock{TOutput}#ReleaseReservation(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`1})">
\r
4686 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to release a previously reserved
\r
4687 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
4688 </summary><param name="messageHeader">
\r
4689 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the reserved message being released.
\r
4690 </param><param name="target">
\r
4691 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> releasing the message it previously reserved.
\r
4692 </param><exception cref="T:System.ArgumentException">
\r
4693 The <paramref name="messageHeader"/> is not valid.
\r
4694 </exception><exception cref="T:System.ArgumentNullException">
\r
4695 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
4696 </exception><exception cref="T:System.InvalidOperationException">
\r
4697 The <paramref name="target"/> did not have the message reserved.
\r
4698 </exception><remarks>
\r
4700 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
4701 instance may use <see cref="M:ReleaseMessage"/>, and it must only be used
\r
4702 to release <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
4703 and successfully reserved by the target.
\r
4707 <member name="P:System.Threading.Tasks.Dataflow.TransformManyBlock`2.Completion">
\r
4709 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
4710 </summary><remarks>
\r
4711 A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
\r
4712 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
4713 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
4714 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
4715 the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
\r
4716 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
4717 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
4718 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
4721 <member name="P:System.Threading.Tasks.Dataflow.TransformManyBlock`2.InputCount">
\r
4723 Gets the number of input items waiting to be processed by this block.
\r
4724 </summary><remarks>
\r
4725 The InputCount does not include any items currently being processed by the block or any items that
\r
4726 have already been processed by the block.
\r
4729 <member name="P:System.Threading.Tasks.Dataflow.TransformManyBlock`2.OutputCount">
\r
4731 Gets the number of output items available to be received from this block.
\r
4734 <member name="P:System.Threading.Tasks.Dataflow.TransformManyBlock`2.InputCountForDebugger">
\r
4735 <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>
\r
4737 <member name="P:System.Threading.Tasks.Dataflow.TransformManyBlock`2.OutputCountForDebugger">
\r
4738 <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>
\r
4740 <member name="P:System.Threading.Tasks.Dataflow.TransformManyBlock`2.DebuggerDisplayContent">
\r
4741 <summary>The data to display in the debugger display attribute.</summary>
\r
4743 <member name="P:System.Threading.Tasks.Dataflow.TransformManyBlock`2.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
\r
4744 <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
\r
4746 <member name="T:System.Threading.Tasks.Dataflow.TransformManyBlock`2.DebugView">
\r
4747 <summary>Provides a debugger type proxy for the TransformManyBlock.</summary>
\r
4749 <member name="F:System.Threading.Tasks.Dataflow.TransformManyBlock`2.DebugView.m_transformManyBlock">
\r
4750 <summary>The transform many block being viewed.</summary>
\r
4752 <member name="F:System.Threading.Tasks.Dataflow.TransformManyBlock`2.DebugView.m_targetDebuggingInformation">
\r
4753 <summary>The target half of the block being viewed.</summary>
\r
4755 <member name="F:System.Threading.Tasks.Dataflow.TransformManyBlock`2.DebugView.m_sourceDebuggingInformation">
\r
4756 <summary>The source half of the block being viewed.</summary>
\r
4758 <member name="M:System.Threading.Tasks.Dataflow.TransformManyBlock`2.DebugView.#ctor(System.Threading.Tasks.Dataflow.TransformManyBlock{`0,`1})">
\r
4759 <summary>Initializes the debug view.</summary>
\r
4760 <param name="transformManyBlock">The transform being viewed.</param>
\r
4762 <member name="P:System.Threading.Tasks.Dataflow.TransformManyBlock`2.DebugView.InputQueue">
\r
4763 <summary>Gets the messages waiting to be processed.</summary>
\r
4765 <member name="P:System.Threading.Tasks.Dataflow.TransformManyBlock`2.DebugView.PostponedMessages">
\r
4766 <summary>Gets any postponed messages.</summary>
\r
4768 <member name="P:System.Threading.Tasks.Dataflow.TransformManyBlock`2.DebugView.OutputQueue">
\r
4769 <summary>Gets the messages waiting to be received.</summary>
\r
4771 <member name="P:System.Threading.Tasks.Dataflow.TransformManyBlock`2.DebugView.CurrentDegreeOfParallelism">
\r
4772 <summary>Gets the number of input operations currently in flight.</summary>
\r
4774 <member name="P:System.Threading.Tasks.Dataflow.TransformManyBlock`2.DebugView.TaskForOutputProcessing">
\r
4775 <summary>Gets the task being used for output processing.</summary>
\r
4777 <member name="P:System.Threading.Tasks.Dataflow.TransformManyBlock`2.DebugView.DataflowBlockOptions">
\r
4778 <summary>Gets the DataflowBlockOptions used to configure this block.</summary>
\r
4780 <member name="P:System.Threading.Tasks.Dataflow.TransformManyBlock`2.DebugView.IsDecliningPermanently">
\r
4781 <summary>Gets whether the block is declining further messages.</summary>
\r
4783 <member name="P:System.Threading.Tasks.Dataflow.TransformManyBlock`2.DebugView.IsCompleted">
\r
4784 <summary>Gets whether the block is completed.</summary>
\r
4786 <member name="P:System.Threading.Tasks.Dataflow.TransformManyBlock`2.DebugView.Id">
\r
4787 <summary>Gets the block's Id.</summary>
\r
4789 <member name="P:System.Threading.Tasks.Dataflow.TransformManyBlock`2.DebugView.LinkedTargets">
\r
4790 <summary>Gets the set of all targets linked from this block.</summary>
\r
4792 <member name="P:System.Threading.Tasks.Dataflow.TransformManyBlock`2.DebugView.NextMessageReservedFor">
\r
4793 <summary>Gets the set of all targets linked from this block.</summary>
\r
4795 <member name="T:System.Threading.Tasks.Dataflow.JoinBlock`2">
\r
4797 Provides a dataflow block that joins across multiple dataflow sources, not necessarily of the same type,
\r
4798 waiting for one item to arrive for each type before they’re all released together as a tuple of one item per type.
\r
4800 <typeparam name="T1">Specifies the type of data accepted by the block's first target.</typeparam>
\r
4801 <typeparam name="T2">Specifies the type of data accepted by the block's second target.</typeparam>
\r
4803 <member name="F:System.Threading.Tasks.Dataflow.JoinBlock`2.m_sharedResources">
\r
4804 <summary>Resources shared by all targets for this join block.</summary>
\r
4806 <member name="F:System.Threading.Tasks.Dataflow.JoinBlock`2.m_source">
\r
4807 <summary>The source half of this join.</summary>
\r
4809 <member name="F:System.Threading.Tasks.Dataflow.JoinBlock`2.m_target1">
\r
4810 <summary>The first target.</summary>
\r
4812 <member name="F:System.Threading.Tasks.Dataflow.JoinBlock`2.m_target2">
\r
4813 <summary>The second target.</summary>
\r
4815 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`2.#ctor">
\r
4816 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.JoinBlock`2"/>.</summary>
\r
4818 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`2.#ctor(System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions)">
\r
4819 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.JoinBlock`2"/>.</summary>
\r
4820 <param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.JoinBlock`2"/>.</param>
\r
4821 <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
\r
4823 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`2.LinkTo(System.Threading.Tasks.Dataflow.ITargetBlock{System.Tuple{`0,`1}},System.Boolean)">
\r
4825 Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.
\r
4826 </summary><param name="target">
\r
4827 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect this source.
\r
4828 </param><param name="unlinkAfterOne">
\r
4829 true if the source should unlink from the target after successfully propagating a single message;
\r
4830 otherwise, false to remain connected even after a single message has been propagated.
\r
4831 </param><returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns><exception cref="T:System.ArgumentNullException">
\r
4832 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
4835 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`2.TryReceive(System.Predicate{System.Tuple{`0,`1}},System.Tuple{`0,`1}@)">
\r
4837 Attempts to synchronously receive an available output item from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
4838 </summary><param name="filter">
\r
4839 The predicate a value must successfully pass in order for it to be received.
\r
4840 <paramref name="filter"/> may be null (Nothing in Visual Basic), in which case all items will pass.
\r
4841 </param><param name="item">The item received from the source.</param><returns>true if an item could be received; otherwise, false.</returns><remarks>
\r
4842 This method does not block waiting for the source to provide an item.
\r
4843 It will return after checking for an element, whether or not an element was available.
\r
4846 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`2.TryReceiveAll(System.Collections.Generic.IList{System.Tuple{`0,`1}}@)">
\r
4848 Attempts to synchronously receive all available items from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
4849 </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>
\r
4850 This method does not block waiting for the source to provide an item.
\r
4851 It will return after checking for elements, whether or not an element was available.
\r
4854 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`2.Complete">
\r
4856 Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
\r
4857 nor produce any more messages nor consume any more postponed messages.
\r
4858 </summary><remarks>
\r
4859 After Complete has been called on a dataflow block, that block will complete
\r
4860 (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
\r
4861 available data. Complete will not block waiting for completion to occur, but rather will initiaite
\r
4862 the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
\r
4865 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`2.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
\r
4867 Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a
\r
4868 <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
\r
4869 </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
\r
4870 The <paramref name="exception"/> is null (Nothing in Visual Basic).
\r
4871 </exception><remarks>
\r
4872 After Fault has been called on a dataflow block, that block will complete
\r
4873 (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes
\r
4874 buffered messages (uprocessed input messages as well as unoffered output messages) to be lost.
\r
4877 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`2.System#Threading#Tasks#Dataflow#ISourceBlock{System#Tuple{T1@T2}}#ConsumeMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{System.Tuple{`0,`1}},System.Boolean@)">
\r
4879 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to accept and consume a
\r
4880 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> previously offered by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
4881 </summary><param name="messageHeader">The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being consumed.</param><param name="target">
\r
4882 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> consuming the message.
\r
4883 </param><param name="messageConsumed">
\r
4884 True if the message was successfully consumed. False otherwise.
\r
4887 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
\r
4888 passed as the <paramref name="messageHeader"/> to <see cref="M:ConsumeMessage"/>. The consuming <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must
\r
4889 use the returned value instead of the value passed as messageValue through <see cref="M:OfferMessage"/>.
\r
4892 If the message requested is not available, the return value will be null (Nothing in Visual Basic).
\r
4894 </returns><exception cref="T:System.ArgumentException">
\r
4895 The <paramref name="messageHeader"/> is not valid.
\r
4896 </exception><exception cref="T:System.ArgumentNullException">
\r
4897 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
4898 </exception><remarks>
\r
4900 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
4901 instance may use <see cref="M:ConsumeMessage"/>, and it must only be used
\r
4902 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
4903 offered by this source to the target.
\r
4907 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`2.System#Threading#Tasks#Dataflow#ISourceBlock{System#Tuple{T1@T2}}#ReserveMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{System.Tuple{`0,`1}})">
\r
4909 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"/>
\r
4910 by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
4911 </summary><param name="messageHeader">
\r
4912 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being reserved.
\r
4913 </param><param name="target">
\r
4914 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> reserving the message.
\r
4915 </param><returns>true if the message was successfully reserved; otherwise, false.</returns><exception cref="T:System.ArgumentException">
\r
4916 The <paramref name="messageHeader"/> is not valid.
\r
4917 </exception><exception cref="T:System.ArgumentNullException">
\r
4918 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
4919 </exception><remarks>
\r
4921 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> instance
\r
4922 may use <see cref="M:ReserveMessage"/>, and it must only be used
\r
4923 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
4924 offered by this source to the target.
\r
4927 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.
\r
4928 Failure to do so may result in the source being unable to propagate any further messages to this or other targets.
\r
4931 <see cref="M:ReserveMessage"/> must not be called while the target is holding any internal locks. Doing so will violate the lock hierarchy
\r
4932 necessary to avoid deadlocks in a dataflow network.
\r
4936 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`2.System#Threading#Tasks#Dataflow#ISourceBlock{System#Tuple{T1@T2}}#ReleaseReservation(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{System.Tuple{`0,`1}})">
\r
4938 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to release a previously reserved
\r
4939 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
4940 </summary><param name="messageHeader">
\r
4941 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the reserved message being released.
\r
4942 </param><param name="target">
\r
4943 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> releasing the message it previously reserved.
\r
4944 </param><exception cref="T:System.ArgumentException">
\r
4945 The <paramref name="messageHeader"/> is not valid.
\r
4946 </exception><exception cref="T:System.ArgumentNullException">
\r
4947 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
4948 </exception><exception cref="T:System.InvalidOperationException">
\r
4949 The <paramref name="target"/> did not have the message reserved.
\r
4950 </exception><remarks>
\r
4952 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
4953 instance may use <see cref="M:ReleaseMessage"/>, and it must only be used
\r
4954 to release <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
4955 and successfully reserved by the target.
\r
4959 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`2.CompleteEachTarget">
\r
4961 Invokes Complete on each target with dropping buffered messages
\r
4964 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`2.OutputCount">
\r
4966 Gets the number of output items available to be received from this block.
\r
4969 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`2.Completion">
\r
4971 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
4972 </summary><remarks>
\r
4973 A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
\r
4974 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
4975 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
4976 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
4977 the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
\r
4978 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
4979 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
4980 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
4983 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`2.Target1">
\r
4984 <summary>Gets a target that may be used to offer messages of the first type.</summary>
\r
4986 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`2.Target2">
\r
4987 <summary>Gets a target that may be used to offer messages of the second type.</summary>
\r
4989 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`2.OutputCountForDebugger">
\r
4990 <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>
\r
4992 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`2.DebuggerDisplayContent">
\r
4993 <summary>The data to display in the debugger display attribute.</summary>
\r
4995 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`2.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
\r
4996 <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
\r
4998 <member name="T:System.Threading.Tasks.Dataflow.JoinBlock`2.DebugView">
\r
4999 <summary>Provides a debugger type proxy for the JoinBlock.</summary>
\r
5001 <member name="F:System.Threading.Tasks.Dataflow.JoinBlock`2.DebugView.m_joinBlock">
\r
5002 <summary>The JoinBlock being viewed.</summary>
\r
5004 <member name="F:System.Threading.Tasks.Dataflow.JoinBlock`2.DebugView.m_sourceDebuggingInformation">
\r
5005 <summary>The source half of the block being viewed.</summary>
\r
5007 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`2.DebugView.#ctor(System.Threading.Tasks.Dataflow.JoinBlock{`0,`1})">
\r
5008 <summary>Initializes the debug view.</summary>
\r
5009 <param name="joinBlock">The JoinBlock being viewed.</param>
\r
5011 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`2.DebugView.OutputQueue">
\r
5012 <summary>Gets the messages waiting to be received.</summary>
\r
5014 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`2.DebugView.JoinsCreated">
\r
5015 <summary>Gets the number of joins created thus far.</summary>
\r
5017 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`2.DebugView.TaskForInputProcessing">
\r
5018 <summary>Gets the task being used for input processing.</summary>
\r
5020 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`2.DebugView.TaskForOutputProcessing">
\r
5021 <summary>Gets the task being used for output processing.</summary>
\r
5023 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`2.DebugView.DataflowBlockOptions">
\r
5024 <summary>Gets the GroupingDataflowBlockOptions used to configure this block.</summary>
\r
5026 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`2.DebugView.IsDecliningPermanently">
\r
5027 <summary>Gets whether the block is declining further messages.</summary>
\r
5029 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`2.DebugView.IsCompleted">
\r
5030 <summary>Gets whether the block is completed.</summary>
\r
5032 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`2.DebugView.Id">
\r
5033 <summary>Gets the block's Id.</summary>
\r
5035 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`2.DebugView.Target1">
\r
5036 <summary>Gets the first target.</summary>
\r
5038 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`2.DebugView.Target2">
\r
5039 <summary>Gets the second target.</summary>
\r
5041 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`2.DebugView.LinkedTargets">
\r
5042 <summary>Gets the set of all targets linked from this block.</summary>
\r
5044 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`2.DebugView.NextMessageReservedFor">
\r
5045 <summary>Gets the set of all targets linked from this block.</summary>
\r
5047 <member name="T:System.Threading.Tasks.Dataflow.JoinBlock`3">
\r
5049 Provides a dataflow block that joins across multiple dataflow sources, not necessarily of the same type,
\r
5050 waiting for one item to arrive for each type before they’re all released together as a tuple of one item per type.
\r
5052 <typeparam name="T1">Specifies the type of data accepted by the block's first target.</typeparam>
\r
5053 <typeparam name="T2">Specifies the type of data accepted by the block's second target.</typeparam>
\r
5054 <typeparam name="T3">Specifies the type of data accepted by the block's third target.</typeparam>
\r
5056 <member name="F:System.Threading.Tasks.Dataflow.JoinBlock`3.m_sharedResources">
\r
5057 <summary>Resources shared by all targets for this join block.</summary>
\r
5059 <member name="F:System.Threading.Tasks.Dataflow.JoinBlock`3.m_source">
\r
5060 <summary>The source half of this join.</summary>
\r
5062 <member name="F:System.Threading.Tasks.Dataflow.JoinBlock`3.m_target1">
\r
5063 <summary>The first target.</summary>
\r
5065 <member name="F:System.Threading.Tasks.Dataflow.JoinBlock`3.m_target2">
\r
5066 <summary>The second target.</summary>
\r
5068 <member name="F:System.Threading.Tasks.Dataflow.JoinBlock`3.m_target3">
\r
5069 <summary>The third target.</summary>
\r
5071 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`3.#ctor">
\r
5072 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.JoinBlock`3"/>.</summary>
\r
5074 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`3.#ctor(System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions)">
\r
5075 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.JoinBlock`3"/>.</summary>
\r
5076 <param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.JoinBlock`2"/>.</param>
\r
5077 <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
\r
5079 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`3.LinkTo(System.Threading.Tasks.Dataflow.ITargetBlock{System.Tuple{`0,`1,`2}},System.Boolean)">
\r
5081 Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.
\r
5082 </summary><param name="target">
\r
5083 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect this source.
\r
5084 </param><param name="unlinkAfterOne">
\r
5085 true if the source should unlink from the target after successfully propagating a single message;
\r
5086 otherwise, false to remain connected even after a single message has been propagated.
\r
5087 </param><returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns><exception cref="T:System.ArgumentNullException">
\r
5088 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
5091 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`3.TryReceive(System.Predicate{System.Tuple{`0,`1,`2}},System.Tuple{`0,`1,`2}@)">
\r
5093 Attempts to synchronously receive an available output item from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
5094 </summary><param name="filter">
\r
5095 The predicate a value must successfully pass in order for it to be received.
\r
5096 <paramref name="filter"/> may be null (Nothing in Visual Basic), in which case all items will pass.
\r
5097 </param><param name="item">The item received from the source.</param><returns>true if an item could be received; otherwise, false.</returns><remarks>
\r
5098 This method does not block waiting for the source to provide an item.
\r
5099 It will return after checking for an element, whether or not an element was available.
\r
5102 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`3.TryReceiveAll(System.Collections.Generic.IList{System.Tuple{`0,`1,`2}}@)">
\r
5104 Attempts to synchronously receive all available items from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
5105 </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>
\r
5106 This method does not block waiting for the source to provide an item.
\r
5107 It will return after checking for elements, whether or not an element was available.
\r
5110 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`3.Complete">
\r
5112 Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
\r
5113 nor produce any more messages nor consume any more postponed messages.
\r
5114 </summary><remarks>
\r
5115 After Complete has been called on a dataflow block, that block will complete
\r
5116 (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
\r
5117 available data. Complete will not block waiting for completion to occur, but rather will initiaite
\r
5118 the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
\r
5121 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`3.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
\r
5123 Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a
\r
5124 <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
\r
5125 </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
\r
5126 The <paramref name="exception"/> is null (Nothing in Visual Basic).
\r
5127 </exception><remarks>
\r
5128 After Fault has been called on a dataflow block, that block will complete
\r
5129 (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes
\r
5130 buffered messages (uprocessed input messages as well as unoffered output messages) to be lost.
\r
5133 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`3.System#Threading#Tasks#Dataflow#ISourceBlock{System#Tuple{T1@T2@T3}}#ConsumeMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{System.Tuple{`0,`1,`2}},System.Boolean@)">
\r
5135 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to accept and consume a
\r
5136 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> previously offered by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
5137 </summary><param name="messageHeader">The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being consumed.</param><param name="target">
\r
5138 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> consuming the message.
\r
5139 </param><param name="messageConsumed">
\r
5140 True if the message was successfully consumed. False otherwise.
\r
5143 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
\r
5144 passed as the <paramref name="messageHeader"/> to <see cref="M:ConsumeMessage"/>. The consuming <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must
\r
5145 use the returned value instead of the value passed as messageValue through <see cref="M:OfferMessage"/>.
\r
5148 If the message requested is not available, the return value will be null (Nothing in Visual Basic).
\r
5150 </returns><exception cref="T:System.ArgumentException">
\r
5151 The <paramref name="messageHeader"/> is not valid.
\r
5152 </exception><exception cref="T:System.ArgumentNullException">
\r
5153 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
5154 </exception><remarks>
\r
5156 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
5157 instance may use <see cref="M:ConsumeMessage"/>, and it must only be used
\r
5158 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
5159 offered by this source to the target.
\r
5163 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`3.System#Threading#Tasks#Dataflow#ISourceBlock{System#Tuple{T1@T2@T3}}#ReserveMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{System.Tuple{`0,`1,`2}})">
\r
5165 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"/>
\r
5166 by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
5167 </summary><param name="messageHeader">
\r
5168 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being reserved.
\r
5169 </param><param name="target">
\r
5170 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> reserving the message.
\r
5171 </param><returns>true if the message was successfully reserved; otherwise, false.</returns><exception cref="T:System.ArgumentException">
\r
5172 The <paramref name="messageHeader"/> is not valid.
\r
5173 </exception><exception cref="T:System.ArgumentNullException">
\r
5174 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
5175 </exception><remarks>
\r
5177 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> instance
\r
5178 may use <see cref="M:ReserveMessage"/>, and it must only be used
\r
5179 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
5180 offered by this source to the target.
\r
5183 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.
\r
5184 Failure to do so may result in the source being unable to propagate any further messages to this or other targets.
\r
5187 <see cref="M:ReserveMessage"/> must not be called while the target is holding any internal locks. Doing so will violate the lock hierarchy
\r
5188 necessary to avoid deadlocks in a dataflow network.
\r
5192 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`3.System#Threading#Tasks#Dataflow#ISourceBlock{System#Tuple{T1@T2@T3}}#ReleaseReservation(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{System.Tuple{`0,`1,`2}})">
\r
5194 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to release a previously reserved
\r
5195 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
5196 </summary><param name="messageHeader">
\r
5197 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the reserved message being released.
\r
5198 </param><param name="target">
\r
5199 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> releasing the message it previously reserved.
\r
5200 </param><exception cref="T:System.ArgumentException">
\r
5201 The <paramref name="messageHeader"/> is not valid.
\r
5202 </exception><exception cref="T:System.ArgumentNullException">
\r
5203 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
5204 </exception><exception cref="T:System.InvalidOperationException">
\r
5205 The <paramref name="target"/> did not have the message reserved.
\r
5206 </exception><remarks>
\r
5208 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
5209 instance may use <see cref="M:ReleaseMessage"/>, and it must only be used
\r
5210 to release <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
5211 and successfully reserved by the target.
\r
5215 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`3.CompleteEachTarget">
\r
5217 Invokes Complete on each target with dropping buffered messages.
\r
5220 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`3.OutputCount">
\r
5222 Gets the number of output items available to be received from this block.
\r
5225 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`3.Completion">
\r
5227 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
5228 </summary><remarks>
\r
5229 A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
\r
5230 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
5231 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
5232 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
5233 the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
\r
5234 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
5235 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
5236 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
5239 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`3.Target1">
\r
5240 <summary>Gets a target that may be used to offer messages of the first type.</summary>
\r
5242 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`3.Target2">
\r
5243 <summary>Gets a target that may be used to offer messages of the second type.</summary>
\r
5245 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`3.Target3">
\r
5246 <summary>Gets a target that may be used to offer messages of the third type.</summary>
\r
5248 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`3.OutputCountForDebugger">
\r
5249 <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>
\r
5251 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`3.DebuggerDisplayContent">
\r
5252 <summary>The data to display in the debugger display attribute.</summary>
\r
5254 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`3.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
\r
5255 <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
\r
5257 <member name="T:System.Threading.Tasks.Dataflow.JoinBlock`3.DebugView">
\r
5258 <summary>Provides a debugger type proxy for the Batch.</summary>
\r
5260 <member name="F:System.Threading.Tasks.Dataflow.JoinBlock`3.DebugView.m_joinBlock">
\r
5261 <summary>The JoinBlock being viewed.</summary>
\r
5263 <member name="F:System.Threading.Tasks.Dataflow.JoinBlock`3.DebugView.m_sourceDebuggingInformation">
\r
5264 <summary>The source half of the block being viewed.</summary>
\r
5266 <member name="M:System.Threading.Tasks.Dataflow.JoinBlock`3.DebugView.#ctor(System.Threading.Tasks.Dataflow.JoinBlock{`0,`1,`2})">
\r
5267 <summary>Initializes the debug view.</summary>
\r
5268 <param name="joinBlock">The JoinBlock being viewed.</param>
\r
5270 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`3.DebugView.OutputQueue">
\r
5271 <summary>Gets the messages waiting to be received.</summary>
\r
5273 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`3.DebugView.JoinsCreated">
\r
5274 <summary>Gets the number of joins created thus far.</summary>
\r
5276 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`3.DebugView.TaskForInputProcessing">
\r
5277 <summary>Gets the task being used for input processing.</summary>
\r
5279 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`3.DebugView.TaskForOutputProcessing">
\r
5280 <summary>Gets the task being used for output processing.</summary>
\r
5282 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`3.DebugView.DataflowBlockOptions">
\r
5283 <summary>Gets the GroupingDataflowBlockOptions used to configure this block.</summary>
\r
5285 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`3.DebugView.IsDecliningPermanently">
\r
5286 <summary>Gets whether the block is declining further messages.</summary>
\r
5288 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`3.DebugView.IsCompleted">
\r
5289 <summary>Gets whether the block is completed.</summary>
\r
5291 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`3.DebugView.Id">
\r
5292 <summary>Gets the block's Id.</summary>
\r
5294 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`3.DebugView.Target1">
\r
5295 <summary>Gets the first target.</summary>
\r
5297 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`3.DebugView.Target2">
\r
5298 <summary>Gets the second target.</summary>
\r
5300 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`3.DebugView.Target3">
\r
5301 <summary>Gets the third target.</summary>
\r
5303 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`3.DebugView.LinkedTargets">
\r
5304 <summary>Gets the set of all targets linked from this block.</summary>
\r
5306 <member name="P:System.Threading.Tasks.Dataflow.JoinBlock`3.DebugView.NextMessageReservedFor">
\r
5307 <summary>Gets the set of all targets linked from this block.</summary>
\r
5309 <member name="T:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1">
\r
5310 <summary>Provides the target used in a Join.</summary>
\r
5311 <typeparam name="T">Specifies the type of data accepted by this target.</typeparam>
\r
5313 <member name="T:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetBase">
\r
5314 <summary>Provides a non-generic base type for all join targets.</summary>
\r
5316 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetBase.ReserveOneMessage">
\r
5317 <summary>Reserves a single message.</summary>
\r
5318 <returns>Whether a message could be reserved.</returns>
\r
5320 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetBase.ConsumeReservedMessage">
\r
5321 <summary>Consumes any previously reserved message.</summary>
\r
5323 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetBase.ConsumeOnePostponedMessage">
\r
5324 <summary>Consumes up to one postponed message in greedy bounded mode.</summary>
\r
5326 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetBase.ReleaseReservedMessage">
\r
5327 <summary>Releases any previously reserved message.</summary>
\r
5329 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetBase.ClearReservation">
\r
5330 <summary>Unconditionally clears a reserved message. This is only invoked in case of an exception.</summary>
\r
5332 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetBase.Complete">
\r
5333 <summary>Access point to the corresponding API method.</summary>
\r
5335 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetBase.CompleteCore(System.Exception,System.Boolean,System.Boolean)">
\r
5336 <summary>Internal implementation of the corresponding API method.</summary>
\r
5338 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetBase.CompleteOncePossible">
\r
5339 <summary>Completes the target.</summary>
\r
5341 <member name="P:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetBase.IsDecliningPermanently">
\r
5342 <summary>Whether the target is postponing messages.</summary>
\r
5344 <member name="P:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetBase.HasAtLeastOneMessageAvailable">
\r
5345 <summary>Whether the target has at least one message available.</summary>
\r
5347 <member name="P:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetBase.HasAtLeastOnePostponedMessage">
\r
5348 <summary>Whether the target has at least one message postponed.</summary>
\r
5350 <member name="P:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetBase.NumberOfMessagesAvailableOrPostponed">
\r
5351 <summary>Gets the number of messages available or postponed.</summary>
\r
5353 <member name="P:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetBase.HasTheHighestNumberOfMessagesAvailable">
\r
5354 <summary>Gets whether the target has the highest number of messages available. (A tie yields true.)</summary>
\r
5356 <member name="F:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.m_sharedResources">
\r
5357 <summary>The shared resources used by all targets associated with the same join instance.</summary>
\r
5359 <member name="F:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.m_completionTask">
\r
5360 <summary>A task representing the completion of the block.</summary>
\r
5362 <member name="F:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.m_messages">
\r
5363 <summary>Input messages for the next batch.</summary>
\r
5365 <member name="F:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.m_nonGreedy">
\r
5366 <summary>State used when in non-greedy mode.</summary>
\r
5368 <member name="F:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.m_decliningPermanently">
\r
5369 <summary>Whether this target is declining future messages.</summary>
\r
5371 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.#ctor(System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources)">
\r
5372 <summary>Initializes the target.</summary>
\r
5373 <param name="sharedResources">The shared resources used by all targets associated with this join.</param>
\r
5375 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.GetOneMessage">
\r
5376 <summary>Gets a message buffered by this target.</summary>
\r
5377 <remarks>This must be called while holding the shared resource's incoming lock.</remarks>
\r
5379 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.ReserveOneMessage">
\r
5380 <summary>Reserves one of the postponed messages.</summary>
\r
5381 <returns>true if a message could be reserved; otherwise, false.</returns>
\r
5383 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.ConsumeReservedMessage">
\r
5384 <summary>Consumes a reserved message.</summary>
\r
5386 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.ConsumeOnePostponedMessage">
\r
5387 <summary>Consumes up to one postponed message in greedy bounded mode.</summary>
\r
5389 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.CompleteIfLastJoinIsFeasible">
\r
5391 Start declining if the number of joins we've already made plus the number we can
\r
5392 make from data already enqueued meets our quota.
\r
5395 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.ReleaseReservedMessage">
\r
5396 <summary>Releases the reservation on a reserved message.</summary>
\r
5398 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.ClearReservation">
\r
5399 <summary>Unconditionally clears a reserved message.</summary>
\r
5401 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.CompleteOncePossible">
\r
5402 <summary>Completes the target.</summary>
\r
5404 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.System#Threading#Tasks#Dataflow#ITargetBlock{T}#OfferMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,`0,System.Threading.Tasks.Dataflow.ISourceBlock{`0},System.Boolean)">
\r
5406 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.
\r
5407 </summary><param name="messageHeader">
\r
5408 A <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance that represents the header of the message being offered.
\r
5409 </param><param name="messageValue">
\r
5410 The value of the message being offered.
\r
5411 </param><param name="source">
\r
5412 The <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> offering the message. This may be null (Nothing in Visual Basic).
\r
5413 </param><param name="consumeToAccept">
\r
5414 true if the target must call ConsumeMessage synchronously during the call to OfferMessage, prior to returning
\r
5415 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Accepted"/>, in order to consume the message.
\r
5416 false if the target wanting to accept the message should not call ConsumeMessage, and should isntead simply return DataflowMessageStatus.Accepted.
\r
5418 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
\r
5419 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
\r
5420 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.
\r
5421 If the target would have otherwise postponed but source was null, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is instead returned.
\r
5422 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,
\r
5423 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.NotAvailable"/> is returned.
\r
5424 If the target chose not to accept the message, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is returned. If the target
\r
5425 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.
\r
5426 </returns><exception cref="T:System.ArgumentException">
\r
5427 The <paramref name="messageHeader"/> is not valid.
\r
5428 </exception><exception cref="T:System.ArgumentException">
\r
5429 <paramref name="consumeToAccept"/> may only be true if provided with a non-null <paramref name="source"/>.
\r
5432 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.CompleteCore(System.Exception,System.Boolean,System.Boolean)">
\r
5433 <summary>Completes/faults the block.
\r
5434 In general, it is not safe to pass releaseReservedMessages:true, because releasing of reserved messages
\r
5435 is done without taking a lock. We pass releaseReservedMessages:true only when an exception has been
\r
5436 caught inside the message processing loop which is a single instance at any given moment.</summary>
\r
5438 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
\r
5440 Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a
\r
5441 <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
\r
5442 </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
\r
5443 The <paramref name="exception"/> is null (Nothing in Visual Basic).
\r
5444 </exception><remarks>
\r
5445 After Fault has been called on a dataflow block, that block will complete
\r
5446 (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes
\r
5447 buffered messages (uprocessed input messages as well as unoffered output messages) to be lost.
\r
5450 <member name="P:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.IsDecliningPermanently">
\r
5451 <summary>Gets whether the target is declining messages.</summary>
\r
5453 <member name="P:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.HasAtLeastOneMessageAvailable">
\r
5454 <summary>Gets whether the target has at least one message available.</summary>
\r
5456 <member name="P:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.HasAtLeastOnePostponedMessage">
\r
5457 <summary>Gets whether the target has at least one postponed message.</summary>
\r
5459 <member name="P:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.NumberOfMessagesAvailableOrPostponed">
\r
5460 <summary>Gets the number of messages available or postponed.</summary>
\r
5462 <member name="P:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.HasTheHighestNumberOfMessagesAvailable">
\r
5463 <summary>Gets whether this target has the highest number of available/buffered messages. This is only valid in greedy mode.</summary>
\r
5465 <member name="P:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.Completion">
\r
5467 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
5468 </summary><remarks>
\r
5469 A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
\r
5470 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
5471 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
5472 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
5473 the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
\r
5474 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
5475 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
5476 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
5479 <member name="P:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.CompletionTaskInternal">
\r
5480 <summary>The completion task on Join targets is only hidden from the public. It still exists for internal purposes.</summary>
\r
5482 <member name="P:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.InputCountForDebugger">
\r
5483 <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>
\r
5485 <member name="P:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.DebuggerDisplayContent">
\r
5486 <summary>The data to display in the debugger display attribute.</summary>
\r
5488 <member name="P:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
\r
5489 <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
\r
5491 <member name="T:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.NonGreedyState">
\r
5492 <summary>State used only when in non-greedy mode.</summary>
\r
5494 <member name="F:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.NonGreedyState.PostponedMessages">
\r
5495 <summary>Collection of the last postponed message per source.</summary>
\r
5497 <member name="F:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.NonGreedyState.ReservedMessage">
\r
5498 <summary>The currently reserved message.</summary>
\r
5500 <member name="F:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.NonGreedyState.ConsumedMessage">
\r
5501 <summary>The currently consumed message.</summary>
\r
5503 <member name="T:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.DebugView">
\r
5504 <summary>Provides a debugger type proxy for the Transform.</summary>
\r
5506 <member name="F:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.DebugView.m_joinBlockTarget">
\r
5507 <summary>The join block target being viewed.</summary>
\r
5509 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.DebugView.#ctor(System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget{`0})">
\r
5510 <summary>Initializes the debug view.</summary>
\r
5511 <param name="joinBlockTarget">The join being viewed.</param>
\r
5513 <member name="P:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.DebugView.InputQueue">
\r
5514 <summary>Gets the messages waiting to be processed.</summary>
\r
5516 <member name="P:System.Threading.Tasks.Dataflow.Internal.JoinBlockTarget`1.DebugView.IsDecliningPermanently">
\r
5517 <summary>Gets whether the block is declining further messages.</summary>
\r
5519 <member name="T:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources">
\r
5520 <summary>Provides a container for resources shared across all targets used by the same BatchedJoin instance.</summary>
\r
5522 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources.#ctor(System.Threading.Tasks.Dataflow.IDataflowBlock,System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetBase[],System.Action,System.Action{System.Exception},System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions)">
\r
5523 <summary>Initializes the shared resources.</summary>
\r
5524 <param name="ownerJoin">
\r
5525 The join block that owns these shared resources.
\r
5527 <param name="targets">
\r
5528 The array of targets associated with the join. Also doubles as the sync object used to synchronize targets.
\r
5530 <param name="joinFilledAction">The delegate to invoke when enough messages have been consumed to fulfill the join.</param>
\r
5531 <param name="exceptionAction">The delegate to invoke when a target encounters an error.</param>
\r
5532 <param name="dataflowBlockOptions">The options for the join.</param>
\r
5534 <member name="F:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources.m_targets">
\r
5535 <summary>All of the targets associated with the join.</summary>
\r
5537 <member name="F:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources.m_exceptionAction">
\r
5538 <summary>The delegate to invoke when a target encounters an error.</summary>
\r
5540 <member name="F:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources.m_joinFilledAction">
\r
5541 <summary>The delegate to invoke when enough messages have been consumed to fulfill the join.</summary>
\r
5543 <member name="F:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources.m_dataflowBlockOptions">
\r
5544 <summary>The options for the join.</summary>
\r
5546 <member name="F:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources.m_boundingState">
\r
5547 <summary>Bounding state for when the block is executing in bounded mode.</summary>
\r
5549 <member name="F:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources.m_decliningPermanently">
\r
5550 <summary>Whether all targets should decline all further messages.</summary>
\r
5552 <member name="F:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources.m_taskForInputProcessing">
\r
5553 <summary>The task used to process messages.</summary>
\r
5555 <member name="F:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources.m_hasExceptions">
\r
5556 <summary>Whether any exceptions have been generated and stored into the source core.</summary>
\r
5558 <member name="F:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources.m_joinsCreated">
\r
5559 <summary>The number of joins this block has created.</summary>
\r
5561 <member name="F:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources.m_completionReserved">
\r
5562 <summary>A task has reserved the right to run the completion routine.</summary>
\r
5564 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources.RetrievePostponedItemsNonGreedy">
\r
5565 <summary>Retrieves postponed items if we have enough to make a batch.</summary>
\r
5567 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources.ProcessAsyncIfNecessary(System.Boolean)">
\r
5568 <summary>Called when new messages are available to be processed.</summary>
\r
5569 <param name="isReplacementReplica">Whether this call is the continuation of a previous message loop.</param>
\r
5571 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources.CompleteBlockIfPossible">
\r
5572 <summary>Completes the join block if possible.</summary>
\r
5574 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources.ProcessMessagesLoop">
\r
5575 <summary>Task body used to process messages.</summary>
\r
5577 <member name="M:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources.OnItemsRemoved(System.Int32)">
\r
5578 <summary>Notifies the block that one or more items was removed from the queue.</summary>
\r
5579 <param name="numItemsRemoved">The number of items removed.</param>
\r
5581 <member name="P:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources.IncomingLock">
\r
5582 <summary>Gets the lock used to synchronize all incoming messages on all targets.</summary>
\r
5584 <member name="P:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources.AllTargetsHaveAtLeastOneMessage">
\r
5585 <summary>Gets whether all of the targets have at least one message in their queues.</summary>
\r
5587 <member name="P:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources.TargetsHaveAtLeastOneMessageQueuedOrPostponed">
\r
5588 <summary>Gets whether all of the targets have at least one message in their queues or have at least one postponed message.</summary>
\r
5590 <member name="P:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources.CanceledOrFaulted">
\r
5591 <summary>Gets whether the target has had cancellation requested or an exception has occurred.</summary>
\r
5593 <member name="P:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources.JoinNeedsProcessing">
\r
5595 Gets whether the join is in a state where processing can be done, meaning there's data
\r
5596 to be processed and the block is in a state where such processing is allowed.
\r
5599 <member name="P:System.Threading.Tasks.Dataflow.Internal.JoinBlockTargetSharedResources.DebuggerDisplayContent">
\r
5600 <summary>Gets the object to display in the debugger display attribute.</summary>
\r
5602 <member name="T:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair">
\r
5604 Provides concurrent and exclusive task schedulers that coordinate to execute
\r
5605 tasks while ensuring that concurrent tasks may run concurrently and exclusive tasks never do.
\r
5608 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.UNLIMITED_PROCESSING">
\r
5609 <summary>A constant value used to signal unlimited processing.</summary>
\r
5611 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.EXCLUSIVE_PROCESSING_SENTINEL">
\r
5612 <summary>Constant used for m_processingCount to indicate that an exclusive task is being processed.</summary>
\r
5614 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.DEFAULT_MAXITEMSPERTASK">
\r
5615 <summary>Default MaxItemsPerTask to use for processing if none is specified.</summary>
\r
5617 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.m_threadProcessingMapping">
\r
5618 <summary>A dictionary mapping thread ID to a processing mode to denote what kinds of tasks are currently being processed on this thread.</summary>
\r
5620 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.m_concurrentTaskScheduler">
\r
5621 <summary>The scheduler used to queue and execute "concurrent" tasks that may run concurrently with other concurrent tasks.</summary>
\r
5623 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.m_exclusiveTaskScheduler">
\r
5624 <summary>The scheduler used to queue and execute "exclusive" tasks that must run exclusively while no other tasks for this pair are running.</summary>
\r
5626 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.m_underlyingTaskScheduler">
\r
5627 <summary>The underlying task scheduler to which all work should be scheduled.</summary>
\r
5629 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.m_maxConcurrencyLevel">
\r
5631 The maximum number of tasks allowed to run concurrently. This only applies to concurrent tasks,
\r
5632 since exlusive tasks are inherently limited to 1.
\r
5635 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.m_maxItemsPerTask">
\r
5636 <summary>The maximum number of tasks we can process before recyling our runner tasks.</summary>
\r
5638 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.m_processingCount">
\r
5640 If positive, it represents the number of concurrently running concurrent tasks.
\r
5641 If negative, it means an exclusive task has been scheduled.
\r
5642 If 0, nothing has been scheduled.
\r
5645 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.m_completionState">
\r
5646 <summary>Completion state for a task representing the completion of this pair.</summary>
\r
5647 <remarks>Lazily-initialized only if the scheduler pair is shutting down or if the Completion is requested.</remarks>
\r
5649 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.#ctor">
\r
5651 Initializes the ConcurrentExclusiveSchedulerPair.
\r
5654 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.#ctor(System.Threading.Tasks.TaskScheduler)">
\r
5656 Initializes the ConcurrentExclusiveSchedulerPair to target the specified scheduler.
\r
5658 <param name="taskScheduler">The target scheduler on which this pair should execute.</param>
\r
5660 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.#ctor(System.Threading.Tasks.TaskScheduler,System.Int32)">
\r
5662 Initializes the ConcurrentExclusiveSchedulerPair to target the specified scheduler with a maximum concurrency level.
\r
5664 <param name="taskScheduler">The target scheduler on which this pair should execute.</param>
\r
5665 <param name="maxConcurrencyLevel">The maximum number of tasks to run concurrently.</param>
\r
5667 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.#ctor(System.Threading.Tasks.TaskScheduler,System.Int32,System.Int32)">
\r
5669 Initializes the ConcurrentExclusiveSchedulerPair to target the specified scheduler with a maximum
\r
5670 concurrency level and a maximum number of scheduled tasks that may be processed as a unit.
\r
5672 <param name="taskScheduler">The target scheduler on which this pair should execute.</param>
\r
5673 <param name="maxConcurrencyLevel">The maximum number of tasks to run concurrently.</param>
\r
5674 <param name="maxItemsPerTask">The maximum number of tasks to process for each underlying scheduled task used by the pair.</param>
\r
5676 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.Complete">
\r
5677 <summary>Informs the scheduler pair that it should not accept any more tasks.</summary>
\r
5679 Calling <see cref="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.Complete"/> is optional, and it's only necessary if the <see cref="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.Completion"/>
\r
5680 will be relied on for notification of all processing being completed.
\r
5683 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.EnsureCompletionStateInitialized">
\r
5684 <summary>Gets the lazily-initialized completion state.</summary>
\r
5686 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.RequestCompletion">
\r
5687 <summary>Sets that completion has been requested.</summary>
\r
5689 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.CleanupStateIfCompletingAndQuiesced">
\r
5691 Cleans up state if and only if there's no processing currently happening
\r
5692 and no more to be done later.
\r
5695 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.CompleteTaskAsync">
\r
5696 <summary>Completes the completion task asynchronously.</summary>
\r
5698 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.CompleteTask(System.Object)">
\r
5699 <summary>Completes a completion state.</summary>
\r
5700 <param name="state">The completion state to complete.</param>
\r
5702 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.FaultWithTask(System.Threading.Tasks.Task)">
\r
5703 <summary>Initiatites scheduler shutdown due to a worker task faulting..</summary>
\r
5704 <param name="faultedTask">The faulted worker task that's initiating the shutdown.</param>
\r
5706 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ProcessAsyncIfNecessary(System.Boolean)">
\r
5707 <summary>Notifies the pair that new work has arrived to be processed.</summary>
\r
5708 <param name="fairly">Whether tasks should be scheduled fairly with regards to other tasks.</param>
\r
5709 <remarks>Must only be called while holding the lock.</remarks>
\r
5711 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ProcessExclusiveTasks">
\r
5713 Processes exclusive tasks serially until either there are no more to process
\r
5714 or we've reached our user-specified maximum limit.
\r
5717 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ProcessConcurrentTasks">
\r
5719 Processes concurrent tasks serially until either there are no more to process,
\r
5720 we've reached our user-specified maximum limit, or exclusive tasks have arrived.
\r
5723 <member name="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.DefaultMaxConcurrencyLevel">
\r
5724 <summary>Default MaxConcurrencyLevel is the processor count if not otherwise specified.</summary>
\r
5726 <member name="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ValueLock">
\r
5727 <summary>Gets the sync obj used to protect all state on this instance.</summary>
\r
5729 <member name="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.Completion">
\r
5730 <summary>Gets a <see cref="T:System.Threading.Tasks.Task"/> that will complete when the scheduler has completed processing.</summary>
\r
5732 <member name="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.CompletionRequested">
\r
5733 <summary>Gets whether completion has been requested.</summary>
\r
5735 <member name="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ReadyToComplete">
\r
5736 <summary>Gets whether the pair is ready to complete.</summary>
\r
5738 <member name="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentScheduler">
\r
5740 Gets a TaskScheduler that can be used to schedule tasks to this pair
\r
5741 that may run concurrently with other tasks on this pair.
\r
5744 <member name="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ExclusiveScheduler">
\r
5746 Gets a TaskScheduler that can be used to schedule tasks to this pair
\r
5747 that must run exclusively with regards to other tasks on this pair.
\r
5750 <member name="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentTaskCountForDebugger">
\r
5751 <summary>Gets the number of tasks waiting to run concurrently.</summary>
\r
5752 <remarks>This does not take the necessary lock, as it's only called from under the debugger.</remarks>
\r
5754 <member name="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ExclusiveTaskCountForDebugger">
\r
5755 <summary>Gets the number of tasks waiting to run exclusively.</summary>
\r
5756 <remarks>This does not take the necessary lock, as it's only called from under the debugger.</remarks>
\r
5758 <member name="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ModeForDebugger">
\r
5759 <summary>Gets an enumeration for debugging that represents the current state of the scheduler pair.</summary>
\r
5760 <remarks>This is only for debugging. It does not take the necessary locks to be useful for runtime usage.</remarks>
\r
5762 <member name="T:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.CompletionState">
\r
5764 Holder for lazily-initialized state about the completion of a scheduler pair.
\r
5765 Completion is only triggered either by rare exceptional conditions or by
\r
5766 the user calling Complete, and as such we only lazily initialize this
\r
5767 state in one of those conditions or if the user explicitly asks for
\r
5771 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.CompletionState.m_completionRequested">
\r
5772 <summary>Whether the scheduler has had completion requested.</summary>
\r
5773 <remarks>volatile due to unprotected reads in TryExecuteTaskInline.</remarks>
\r
5775 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.CompletionState.m_completionQueued">
\r
5776 <summary>Whether completion processing has been queued.</summary>
\r
5778 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.CompletionState.m_exceptions">
\r
5779 <summary>Unrecoverable exceptions incurred while processing.</summary>
\r
5781 <member name="T:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentExclusiveTaskScheduler">
\r
5783 A scheduler shim used to queue tasks to the pair and execute those tasks on request of the pair.
\r
5786 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentExclusiveTaskScheduler.m_pair">
\r
5787 <summary>The parent pair.</summary>
\r
5789 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentExclusiveTaskScheduler.m_maxConcurrencyLevel">
\r
5790 <summary>The maximum concurrency level for the scheduler.</summary>
\r
5792 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentExclusiveTaskScheduler.m_processingMode">
\r
5793 <summary>The processing mode of this scheduler, exclusive or concurrent.</summary>
\r
5795 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentExclusiveTaskScheduler.m_tasks">
\r
5796 <summary>Gets the queue of tasks for this scheduler.</summary>
\r
5798 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentExclusiveTaskScheduler.#ctor(System.Threading.Tasks.ConcurrentExclusiveSchedulerPair,System.Int32,System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ProcessingMode)">
\r
5799 <summary>Initializes the scheduler.</summary>
\r
5800 <param name="pair">The parent pair.</param>
\r
5801 <param name="maxConcurrencyLevel">The maximum degree of concurrency this scheduler may use.</param>
\r
5802 <param name="processingMode">The processing mode of this scheduler.</param>
\r
5804 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentExclusiveTaskScheduler.QueueTask(System.Threading.Tasks.Task)">
\r
5805 <summary>Queues a task to the scheduler.</summary>
\r
5806 <param name="task">The task to be queued.</param>
\r
5808 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentExclusiveTaskScheduler.ExecuteTask(System.Threading.Tasks.Task)">
\r
5809 <summary>Executes a task on this scheduler.</summary>
\r
5810 <param name="task">The task to be executed.</param>
\r
5812 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentExclusiveTaskScheduler.TryExecuteTaskInline(System.Threading.Tasks.Task,System.Boolean)">
\r
5813 <summary>Tries to execute the task synchronously on this scheduler.</summary>
\r
5814 <param name="task">The task to execute.</param>
\r
5815 <param name="taskWasPreviouslyQueued">Whether the task was previously queued to the scheduler.</param>
\r
5816 <returns>true if the task could be executed; otherwise, false.</returns>
\r
5818 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentExclusiveTaskScheduler.TryExecuteTaskInlineOnTargetScheduler(System.Threading.Tasks.Task)">
\r
5820 Implements a reasonable approximation for TryExecuteTaskInline on the underlying scheduler,
\r
5821 which we can't call directly on the underlying scheduler.
\r
5823 <param name="task">The task to execute inline if possible.</param>
\r
5824 <returns>true if the task was inlined successfully; otherwise, false.</returns>
\r
5826 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentExclusiveTaskScheduler.TryExecuteTaskShim(System.Object)">
\r
5827 <summary>Shim used to invoke this.TryExecuteTask(task).</summary>
\r
5828 <param name="state">A tuple of the ConcurrentExclusiveTaskScheduler and the task to execute.</param>
\r
5829 <returns>true if the task was successfully inlined; otherwise, false.</returns>
\r
5831 This method is separated out not because of performance reasons but so that
\r
5832 the SecuritySafeCritical attribute may be employed.
\r
5835 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentExclusiveTaskScheduler.GetScheduledTasks">
\r
5836 <summary>Gets for debugging purposes the tasks scheduled to this scheduler.</summary>
\r
5837 <returns>An enumerable of the tasks queued.</returns>
\r
5839 <member name="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentExclusiveTaskScheduler.MaximumConcurrencyLevel">
\r
5840 <summary>Gets the maximum concurrency level this scheduler is able to support.</summary>
\r
5842 <member name="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentExclusiveTaskScheduler.CountForDebugger">
\r
5843 <summary>Gets the number of tasks queued to this scheduler.</summary>
\r
5845 <member name="T:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentExclusiveTaskScheduler.DebugView">
\r
5846 <summary>Provides a debug view for ConcurrentExclusiveTaskScheduler.</summary>
\r
5848 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentExclusiveTaskScheduler.DebugView.m_taskScheduler">
\r
5849 <summary>The scheduler being debugged.</summary>
\r
5851 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentExclusiveTaskScheduler.DebugView.#ctor(System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentExclusiveTaskScheduler)">
\r
5852 <summary>Initializes the debug view.</summary>
\r
5853 <param name="scheduler">The scheduler being debugged.</param>
\r
5855 <member name="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentExclusiveTaskScheduler.DebugView.MaximumConcurrencyLevel">
\r
5856 <summary>Gets this pair's maximum allowed concurrency level.</summary>
\r
5858 <member name="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentExclusiveTaskScheduler.DebugView.ScheduledTasks">
\r
5859 <summary>Gets the tasks scheduled to this scheduler.</summary>
\r
5861 <member name="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentExclusiveTaskScheduler.DebugView.SchedulerPair">
\r
5862 <summary>Gets the scheduler pair with which this scheduler is associated.</summary>
\r
5864 <member name="T:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.DebugView">
\r
5865 <summary>Provides a debug view for ConcurrentExclusiveSchedulerPair.</summary>
\r
5867 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.DebugView.m_pair">
\r
5868 <summary>The pair being debugged.</summary>
\r
5870 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.DebugView.#ctor(System.Threading.Tasks.ConcurrentExclusiveSchedulerPair)">
\r
5871 <summary>Initializes the debug view.</summary>
\r
5872 <param name="pair">The pair being debugged.</param>
\r
5874 <member name="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.DebugView.Mode">
\r
5875 <summary>Gets a representation of the execution state of the pair.</summary>
\r
5877 <member name="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.DebugView.ScheduledExclusive">
\r
5878 <summary>Gets the number of tasks waiting to run exclusively.</summary>
\r
5880 <member name="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.DebugView.ScheduledConcurrent">
\r
5881 <summary>Gets the number of tasks waiting to run concurrently.</summary>
\r
5883 <member name="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.DebugView.CurrentlyExecutingTaskCount">
\r
5884 <summary>Gets the number of tasks currently being executed.</summary>
\r
5886 <member name="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.DebugView.TargetScheduler">
\r
5887 <summary>Gets the underlying task scheduler that actually executes the tasks.</summary>
\r
5889 <member name="T:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ProcessingMode">
\r
5890 <summary>Provides an enumeration that represents the current state of the scheduler pair.</summary>
\r
5892 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ProcessingMode.NotCurrentlyProcessing">
\r
5893 <summary>The scheduler pair is currently dormant, with no work scheduled.</summary>
\r
5895 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ProcessingMode.ProcessingExclusiveTask">
\r
5896 <summary>The scheduler pair has queued processing for exclusive tasks.</summary>
\r
5898 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ProcessingMode.ProcessingConcurrentTasks">
\r
5899 <summary>The scheduler pair has queued processing for concurrent tasks.</summary>
\r
5901 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ProcessingMode.Completing">
\r
5902 <summary>Completion has been requested.</summary>
\r
5904 <member name="F:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ProcessingMode.Completed">
\r
5905 <summary>The scheduler pair is finished processing.</summary>
\r
5907 <member name="T:System.Threading.Tasks.Dataflow.BatchBlock`1">
\r
5908 <summary>Provides a dataflow block that batches inputs into arrays.</summary>
\r
5909 <typeparam name="T">Specifies the type of data put into batches.</typeparam>
\r
5911 <member name="F:System.Threading.Tasks.Dataflow.BatchBlock`1.m_target">
\r
5912 <summary>The target half of this batch.</summary>
\r
5914 <member name="F:System.Threading.Tasks.Dataflow.BatchBlock`1.m_source">
\r
5915 <summary>The source half of this batch.</summary>
\r
5917 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.#ctor(System.Int32)">
\r
5918 <summary>Initializes this <see cref="T:System.Threading.Tasks.Dataflow.BatchBlock`1"/> with the specified batch size.</summary>
\r
5919 <param name="batchSize">The number of items to group into a batch.</param>
\r
5920 <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="batchSize"/> must be positive.</exception>
\r
5922 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.#ctor(System.Int32,System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions)">
\r
5923 <summary>Initializes this <see cref="T:System.Threading.Tasks.Dataflow.BatchBlock`1"/> with the specified batch size, declining option, and block options.</summary>
\r
5924 <param name="batchSize">The number of items to group into a batch.</param>
\r
5925 <param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.BatchBlock`1"/>.</param>
\r
5926 <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="batchSize"/> must be positive.</exception>
\r
5927 <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="batchSize"/> must be smaller than the value of the BoundedCapacity option if a non-default value has been set.</exception>
\r
5928 <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
\r
5930 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.Complete">
\r
5932 Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
\r
5933 nor produce any more messages nor consume any more postponed messages.
\r
5934 </summary><remarks>
\r
5935 After Complete has been called on a dataflow block, that block will complete
\r
5936 (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
\r
5937 available data. Complete will not block waiting for completion to occur, but rather will initiaite
\r
5938 the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
\r
5941 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
\r
5943 Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a
\r
5944 <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
\r
5945 </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
\r
5946 The <paramref name="exception"/> is null (Nothing in Visual Basic).
\r
5947 </exception><remarks>
\r
5948 After Fault has been called on a dataflow block, that block will complete
\r
5949 (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes
\r
5950 buffered messages (uprocessed input messages as well as unoffered output messages) to be lost.
\r
5953 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.TriggerBatch">
\r
5955 Triggers the <see cref="T:System.Threading.Tasks.Dataflow.BatchBlock`1"/> to initiate a batching operation even if the number
\r
5956 of currently queued or postponed items is less than the <see cref="P:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchSize"/>.
\r
5959 In greedy mode, a batch will be generated from queued items even if fewer exist than the batch size.
\r
5960 In non-greedy mode, a batch will be generated asynchronously from postponed items even if
\r
5961 fewer than the batch size can be consumed.
\r
5964 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.LinkTo(System.Threading.Tasks.Dataflow.ITargetBlock{`0[]},System.Boolean)">
\r
5966 Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.
\r
5967 </summary><param name="target">
\r
5968 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect this source.
\r
5969 </param><param name="unlinkAfterOne">
\r
5970 true if the source should unlink from the target after successfully propagating a single message;
\r
5971 otherwise, false to remain connected even after a single message has been propagated.
\r
5972 </param><returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns><exception cref="T:System.ArgumentNullException">
\r
5973 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
5976 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.TryReceive(System.Predicate{`0[]},`0[]@)">
\r
5978 Attempts to synchronously receive an available output item from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
5979 </summary><param name="filter">
\r
5980 The predicate a value must successfully pass in order for it to be received.
\r
5981 <paramref name="filter"/> may be null (Nothing in Visual Basic), in which case all items will pass.
\r
5982 </param><param name="item">The item received from the source.</param><returns>true if an item could be received; otherwise, false.</returns><remarks>
\r
5983 This method does not block waiting for the source to provide an item.
\r
5984 It will return after checking for an element, whether or not an element was available.
\r
5987 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.TryReceiveAll(System.Collections.Generic.IList{`0[]}@)">
\r
5989 Attempts to synchronously receive all available items from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
5990 </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>
\r
5991 This method does not block waiting for the source to provide an item.
\r
5992 It will return after checking for elements, whether or not an element was available.
\r
5995 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.System#Threading#Tasks#Dataflow#ITargetBlock{T}#OfferMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,`0,System.Threading.Tasks.Dataflow.ISourceBlock{`0},System.Boolean)">
\r
5997 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.
\r
5998 </summary><param name="messageHeader">
\r
5999 A <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance that represents the header of the message being offered.
\r
6000 </param><param name="messageValue">
\r
6001 The value of the message being offered.
\r
6002 </param><param name="source">
\r
6003 The <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> offering the message. This may be null (Nothing in Visual Basic).
\r
6004 </param><param name="consumeToAccept">
\r
6005 true if the target must call ConsumeMessage synchronously during the call to OfferMessage, prior to returning
\r
6006 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Accepted"/>, in order to consume the message.
\r
6007 false if the target wanting to accept the message should not call ConsumeMessage, and should isntead simply return DataflowMessageStatus.Accepted.
\r
6009 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
\r
6010 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
\r
6011 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.
\r
6012 If the target would have otherwise postponed but source was null, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is instead returned.
\r
6013 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,
\r
6014 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.NotAvailable"/> is returned.
\r
6015 If the target chose not to accept the message, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is returned. If the target
\r
6016 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.
\r
6017 </returns><exception cref="T:System.ArgumentException">
\r
6018 The <paramref name="messageHeader"/> is not valid.
\r
6019 </exception><exception cref="T:System.ArgumentException">
\r
6020 <paramref name="consumeToAccept"/> may only be true if provided with a non-null <paramref name="source"/>.
\r
6023 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.System#Threading#Tasks#Dataflow#ISourceBlock{T[]}#ConsumeMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0[]},System.Boolean@)">
\r
6025 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to accept and consume a
\r
6026 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> previously offered by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
6027 </summary><param name="messageHeader">The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being consumed.</param><param name="target">
\r
6028 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> consuming the message.
\r
6029 </param><param name="messageConsumed">
\r
6030 True if the message was successfully consumed. False otherwise.
\r
6033 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
\r
6034 passed as the <paramref name="messageHeader"/> to <see cref="M:ConsumeMessage"/>. The consuming <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must
\r
6035 use the returned value instead of the value passed as messageValue through <see cref="M:OfferMessage"/>.
\r
6038 If the message requested is not available, the return value will be null (Nothing in Visual Basic).
\r
6040 </returns><exception cref="T:System.ArgumentException">
\r
6041 The <paramref name="messageHeader"/> is not valid.
\r
6042 </exception><exception cref="T:System.ArgumentNullException">
\r
6043 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
6044 </exception><remarks>
\r
6046 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
6047 instance may use <see cref="M:ConsumeMessage"/>, and it must only be used
\r
6048 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
6049 offered by this source to the target.
\r
6053 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.System#Threading#Tasks#Dataflow#ISourceBlock{T[]}#ReserveMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0[]})">
\r
6055 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"/>
\r
6056 by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
6057 </summary><param name="messageHeader">
\r
6058 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being reserved.
\r
6059 </param><param name="target">
\r
6060 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> reserving the message.
\r
6061 </param><returns>true if the message was successfully reserved; otherwise, false.</returns><exception cref="T:System.ArgumentException">
\r
6062 The <paramref name="messageHeader"/> is not valid.
\r
6063 </exception><exception cref="T:System.ArgumentNullException">
\r
6064 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
6065 </exception><remarks>
\r
6067 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> instance
\r
6068 may use <see cref="M:ReserveMessage"/>, and it must only be used
\r
6069 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
6070 offered by this source to the target.
\r
6073 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.
\r
6074 Failure to do so may result in the source being unable to propagate any further messages to this or other targets.
\r
6077 <see cref="M:ReserveMessage"/> must not be called while the target is holding any internal locks. Doing so will violate the lock hierarchy
\r
6078 necessary to avoid deadlocks in a dataflow network.
\r
6082 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.System#Threading#Tasks#Dataflow#ISourceBlock{T[]}#ReleaseReservation(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0[]})">
\r
6084 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to release a previously reserved
\r
6085 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
6086 </summary><param name="messageHeader">
\r
6087 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the reserved message being released.
\r
6088 </param><param name="target">
\r
6089 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> releasing the message it previously reserved.
\r
6090 </param><exception cref="T:System.ArgumentException">
\r
6091 The <paramref name="messageHeader"/> is not valid.
\r
6092 </exception><exception cref="T:System.ArgumentNullException">
\r
6093 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
6094 </exception><exception cref="T:System.InvalidOperationException">
\r
6095 The <paramref name="target"/> did not have the message reserved.
\r
6096 </exception><remarks>
\r
6098 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
6099 instance may use <see cref="M:ReleaseMessage"/>, and it must only be used
\r
6100 to release <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
6101 and successfully reserved by the target.
\r
6105 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.OutputCount">
\r
6107 Gets the number of output items available to be received from this block.
\r
6110 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.Completion">
\r
6112 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
6113 </summary><remarks>
\r
6114 A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
\r
6115 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
6116 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
6117 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
6118 the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
\r
6119 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
6120 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
6121 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
6124 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchSize">
\r
6125 <summary>Gets the size of the batches generated by this <see cref="T:System.Threading.Tasks.Dataflow.BatchBlock`1"/>.</summary>
\r
6127 If the number of items provided to the block is not evenly divisible by the batch size provided
\r
6128 to the block's constructor, the block's final batch may contain fewer than the requested number of items.
\r
6131 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.OutputCountForDebugger">
\r
6132 <summary>Gets the number of messages waiting to be offered. This must only be used from the debugger as it avoids taking necessary locks.</summary>
\r
6134 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.DebuggerDisplayContent">
\r
6135 <summary>The data to display in the debugger display attribute.</summary>
\r
6137 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
\r
6138 <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
\r
6140 <member name="T:System.Threading.Tasks.Dataflow.BatchBlock`1.DebugView">
\r
6141 <summary>Provides a debugger type proxy for the Batch.</summary>
\r
6143 <member name="F:System.Threading.Tasks.Dataflow.BatchBlock`1.DebugView.m_batchBlock">
\r
6144 <summary>The batch block being viewed.</summary>
\r
6146 <member name="F:System.Threading.Tasks.Dataflow.BatchBlock`1.DebugView.m_targetDebuggingInformation">
\r
6147 <summary>The target half being viewed.</summary>
\r
6149 <member name="F:System.Threading.Tasks.Dataflow.BatchBlock`1.DebugView.m_sourceDebuggingInformation">
\r
6150 <summary>The source half of the block being viewed.</summary>
\r
6152 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.DebugView.#ctor(System.Threading.Tasks.Dataflow.BatchBlock{`0})">
\r
6153 <summary>Initializes the debug view.</summary>
\r
6154 <param name="batchBlock">The batch being viewed.</param>
\r
6156 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.DebugView.InputQueue">
\r
6157 <summary>Gets the messages waiting to be processed.</summary>
\r
6159 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.DebugView.OutputQueue">
\r
6160 <summary>Gets the messages waiting to be received.</summary>
\r
6162 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.DebugView.BatchesCompleted">
\r
6163 <summary>Gets the number of batches that have been completed.</summary>
\r
6165 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.DebugView.TaskForInputProcessing">
\r
6166 <summary>Gets the task being used for input processing.</summary>
\r
6168 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.DebugView.TaskForOutputProcessing">
\r
6169 <summary>Gets the task being used for output processing.</summary>
\r
6171 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.DebugView.DataflowBlockOptions">
\r
6172 <summary>Gets the DataflowBlockOptions used to configure this block.</summary>
\r
6174 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.DebugView.BatchSize">
\r
6175 <summary>Gets the size of batches generated by the block.</summary>
\r
6177 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.DebugView.IsDecliningPermanently">
\r
6178 <summary>Gets whether the block is declining further messages.</summary>
\r
6180 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.DebugView.IsCompleted">
\r
6181 <summary>Gets whether the block is completed.</summary>
\r
6183 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.DebugView.Id">
\r
6184 <summary>Gets the block's Id.</summary>
\r
6186 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.DebugView.PostponedMessages">
\r
6187 <summary>Gets the messages postponed by this batch.</summary>
\r
6189 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.DebugView.LinkedTargets">
\r
6190 <summary>Gets the set of all targets linked from this block.</summary>
\r
6192 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.DebugView.NextMessageReservedFor">
\r
6193 <summary>Gets the set of all targets linked from this block.</summary>
\r
6195 <member name="T:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore">
\r
6196 <summary>Provides the core target implementation for a Batch.</summary>
\r
6198 <member name="F:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.m_messages">
\r
6199 <summary>The messages in this target.</summary>
\r
6201 <member name="F:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.m_completionTask">
\r
6202 <summary>A task representing the completion of the block.</summary>
\r
6204 <member name="F:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.m_owningBatch">
\r
6205 <summary>The target that owns this target core.</summary>
\r
6207 <member name="F:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.m_batchSize">
\r
6208 <summary>The batch size.</summary>
\r
6210 <member name="F:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.m_nonGreedyState">
\r
6211 <summary>State used when in non-greedy mode.</summary>
\r
6213 <member name="F:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.m_boundingState">
\r
6214 <summary>Bounding state for when the block is executing in bounded mode.</summary>
\r
6216 <member name="F:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.m_dataflowBlockOptions">
\r
6217 <summary>The options associated with this block.</summary>
\r
6219 <member name="F:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.m_batchCompletedAction">
\r
6220 <summary>The action invoked with a completed batch.</summary>
\r
6222 <member name="F:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.m_decliningPermanently">
\r
6223 <summary>Whether to stop accepting new messages.</summary>
\r
6225 <member name="F:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.m_batchesCompleted">
\r
6226 <summary>Whether we've completed at least one batch.</summary>
\r
6228 <member name="F:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.m_completionReserved">
\r
6229 <summary>Whether someone has reserved the right to call CompleteBlockOncePossible.</summary>
\r
6231 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.#ctor(System.Threading.Tasks.Dataflow.BatchBlock{`0},System.Int32,System.Action{`0[]},System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions)">
\r
6232 <summary>Initializes this target core with the specified configuration.</summary>
\r
6233 <param name="owningBatch">The owning batch target.</param>
\r
6234 <param name="batchSize">The number of items to group into a batch.</param>
\r
6235 <param name="batchCompletedAction">The delegate to invoke when a batch is completed.</param>
\r
6236 <param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.BatchBlock`1"/>. Assumed to be immutable.</param>
\r
6237 <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="batchSize"/> must be positive.</exception>
\r
6238 <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
\r
6240 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.TriggerBatch">
\r
6242 Triggers a batching operation even if the number of currently queued or postponed items is less than the <see cref="P:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.BatchSize"/>.
\r
6245 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.OfferMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,`0,System.Threading.Tasks.Dataflow.ISourceBlock{`0},System.Boolean)">
\r
6247 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.
\r
6248 </summary><param name="messageHeader">
\r
6249 A <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance that represents the header of the message being offered.
\r
6250 </param><param name="messageValue">
\r
6251 The value of the message being offered.
\r
6252 </param><param name="source">
\r
6253 The <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> offering the message. This may be null (Nothing in Visual Basic).
\r
6254 </param><param name="consumeToAccept">
\r
6255 true if the target must call ConsumeMessage synchronously during the call to OfferMessage, prior to returning
\r
6256 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Accepted"/>, in order to consume the message.
\r
6257 false if the target wanting to accept the message should not call ConsumeMessage, and should isntead simply return DataflowMessageStatus.Accepted.
\r
6259 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
\r
6260 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
\r
6261 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.
\r
6262 If the target would have otherwise postponed but source was null, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is instead returned.
\r
6263 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,
\r
6264 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.NotAvailable"/> is returned.
\r
6265 If the target chose not to accept the message, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is returned. If the target
\r
6266 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.
\r
6267 </returns><exception cref="T:System.ArgumentException">
\r
6268 The <paramref name="messageHeader"/> is not valid.
\r
6269 </exception><exception cref="T:System.ArgumentException">
\r
6270 <paramref name="consumeToAccept"/> may only be true if provided with a non-null <paramref name="source"/>.
\r
6273 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.Complete(System.Exception,System.Boolean,System.Boolean)">
\r
6274 <summary>Completes/faults the block.
\r
6275 In general, it is not safe to pass releaseReservedMessages:true, because releasing of reserved messages
\r
6276 is done without taking a lock. We pass releaseReservedMessages:true only when an exception has been
\r
6277 caught inside the message processing loop which is a single instance at any given moment.</summary>
\r
6279 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.CompleteBlockIfPossible">
\r
6280 <summary>Completes the block once all completion conditions are met.</summary>
\r
6282 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.ProcessAsyncIfNecessary(System.Boolean)">
\r
6283 <summary>Called when new messages are available to be processed.</summary>
\r
6284 <param name="isReplacementReplica">Whether this call is the continuation of a previous message loop.</param>
\r
6286 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.ProcessMessagesLoop">
\r
6287 <summary>Task body used to process messages.</summary>
\r
6289 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.MakeBatchIfPossible(System.Boolean)">
\r
6290 <summary>Create a batch from the available items.</summary>
\r
6291 <param name="evenIfFewerThanBatchSize">
\r
6292 Whether to make a batch even if there are fewer than BatchSize items available.
\r
6294 <returns>true if a batch was created and published; otherwise, false.</returns>
\r
6296 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.RetrievePostponedItemsNonGreedy(System.Boolean)">
\r
6297 <summary>Retrieves postponed items in non-greedy mode if we have enough to make a batch.</summary>
\r
6298 <remarks>Whether we'll accept consuming fewer elements than the defined batch size.</remarks>
\r
6300 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.RetrievePostponedItemsGreedyBounded(System.Boolean)">
\r
6301 <summary>Retrieves postponed items in greedy bounded mode.</summary>
\r
6302 <remarks>Whether we'll accept consuming fewer elements than the defined batch size.</remarks>
\r
6304 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.ConsumeReservedMessagesNonGreedy">
\r
6306 Consumes all of the reserved messages stored in the non-greedy state's temporary reserved source list.
\r
6309 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.ConsumeReservedMessagesGreedyBounded">
\r
6311 Consumes all of the reserved messages stored in the non-greedy state's temporary reserved source list.
\r
6314 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.ReleaseReservedMessages(System.Boolean)">
\r
6316 Releases all of the reserved messages stored in the non-greedy state's temporary reserved source list.
\r
6318 <param name="throwOnFirstException">
\r
6319 Whether to allow an exception from a release to propagate immediately,
\r
6320 or to delay propagation until all releases have been attempted.
\r
6323 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.OnItemsRemoved(System.Int32)">
\r
6324 <summary>Notifies the block that one or more items was removed from the queue.</summary>
\r
6325 <param name="numItemsRemoved">The number of items removed.</param>
\r
6327 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.CountItems(`0[],System.Collections.Generic.IList{`0[]})">
\r
6328 <summary>Counts the input items in a single output item or in a list of output items.</summary>
\r
6329 <param name="singleOutputItem">A single outptut item. Only considered if multipleOutputItems == null.</param>
\r
6330 <param name="multipleOutputItems">A list of outptut items. May be null.</param>
\r
6332 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.GetDebuggingInformation">
\r
6333 <summary>Gets information about this helper to be used for display in a debugger.</summary>
\r
6334 <returns>Debugging information about this target.</returns>
\r
6336 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.IncomingLock">
\r
6337 <summary>Gets the object used as the incoming lock.</summary>
\r
6339 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.Completion">
\r
6341 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
6342 </summary><remarks>
\r
6343 A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
\r
6344 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
6345 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
6346 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
6347 the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
\r
6348 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
6349 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
6350 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
6353 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.BatchSize">
\r
6354 <summary>Gets the size of the batches generated by this <see cref="T:System.Threading.Tasks.Dataflow.BatchBlock`1"/>.</summary>
\r
6356 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.CanceledOrFaulted">
\r
6357 <summary>Gets whether the target has had cancellation requested or an exception has occurred.</summary>
\r
6359 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.BoundedCapacityAvailable">
\r
6360 <summary>Returns the available capacity to bring in postponed items. The exact values above m_batchSize don't matter.</summary>
\r
6362 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.BatchesNeedProcessing">
\r
6364 Gets whether we should launch further synchronous or asynchronous processing
\r
6365 to create batches.
\r
6368 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.InputCountForDebugger">
\r
6369 <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>
\r
6371 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.DebuggerDisplayContent">
\r
6372 <summary>Gets the object to display in the debugger display attribute.</summary>
\r
6374 <member name="T:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.NonGreedyState">
\r
6375 <summary>State used only when in non-greedy mode.</summary>
\r
6377 <member name="F:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.NonGreedyState.PostponedMessages">
\r
6378 <summary>Collection of postponed messages.</summary>
\r
6380 <member name="F:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.NonGreedyState.PostponedMessagesTemp">
\r
6381 <summary>A temporary array used to store data retrieved from PostponedMessages.</summary>
\r
6383 <member name="F:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.NonGreedyState.ReservedSourcesTemp">
\r
6384 <summary>A temporary list used in non-greedy mode when consuming postponed messages to store successfully reserved messages.</summary>
\r
6386 <member name="F:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.NonGreedyState.AcceptFewerThanBatchSize">
\r
6387 <summary>Whether the next batching operation should accept fewer than BatchSize items.</summary>
\r
6388 <remarks>This value may be read not under a lock, but it must only be written to protected by the IncomingLock.</remarks>
\r
6390 <member name="F:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.NonGreedyState.TaskForInputProcessing">
\r
6391 <summary>The task used to process messages.</summary>
\r
6393 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.NonGreedyState.#ctor(System.Int32)">
\r
6394 <summary>Initializes the NonGreedyState.</summary>
\r
6395 <param name="batchSize">The batch size used by the BatchBlock.</param>
\r
6397 <member name="T:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.DebuggingInformation">
\r
6398 <summary>Provides a wrapper for commonly needed debugging information.</summary>
\r
6400 <member name="F:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.DebuggingInformation.m_target">
\r
6401 <summary>The target being viewed.</summary>
\r
6403 <member name="M:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.DebuggingInformation.#ctor(System.Threading.Tasks.Dataflow.BatchBlock{`0}.BatchBlockTargetCore)">
\r
6404 <summary>Initializes the debugging helper.</summary>
\r
6405 <param name="target">The target being viewed.</param>
\r
6407 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.DebuggingInformation.InputQueue">
\r
6408 <summary>Gets the messages waiting to be processed.</summary>
\r
6410 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.DebuggingInformation.TaskForInputProcessing">
\r
6411 <summary>Gets the task being used for input processing.</summary>
\r
6413 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.DebuggingInformation.PostponedMessages">
\r
6414 <summary>Gets the collection of postponed messages.</summary>
\r
6416 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.DebuggingInformation.IsDecliningPermanently">
\r
6417 <summary>Gets whether the block is declining further messages.</summary>
\r
6419 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.DebuggingInformation.DataflowBlockOptions">
\r
6420 <summary>Gets the DataflowBlockOptions used to configure this block.</summary>
\r
6422 <member name="P:System.Threading.Tasks.Dataflow.BatchBlock`1.BatchBlockTargetCore.DebuggingInformation.NumberOfBatchesCompleted">
\r
6423 <summary>Gets the number of batches that have been completed.</summary>
\r
6425 <member name="T:System.Threading.Tasks.Dataflow.WriteOnceBlock`1">
\r
6426 <summary>Provides a buffer for receiving and storing at most one element in a network of dataflow blocks.</summary>
\r
6427 <typeparam name="T">Specifies the type of the data buffered by this dataflow block.</typeparam>
\r
6429 <member name="F:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.m_completionTask">
\r
6430 <summary>A TaskCompletionSource that represents the completion of this block.</summary>
\r
6432 <member name="F:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.m_targetRegistry">
\r
6433 <summary>A registry used to store all linked targets and information about them.</summary>
\r
6435 <member name="F:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.m_executionContext">
\r
6436 <summary>The execution context to use when running the cloning function and when propagating.</summary>
\r
6438 <member name="F:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.m_cloningFunction">
\r
6439 <summary>The cloning function.</summary>
\r
6441 <member name="F:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.m_dataflowBlockOptions">
\r
6442 <summary>The options used to configure this block's execution.</summary>
\r
6444 <member name="F:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.m_decliningPermanently">
\r
6445 <summary>Whether all future messages should be declined.</summary>
\r
6447 <member name="F:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.m_completionReserved">
\r
6448 <summary>Whether block completion is disallawed.</summary>
\r
6450 <member name="F:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.m_header">
\r
6451 <summary>The header of the singly-assigned value.</summary>
\r
6453 <member name="F:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.m_value">
\r
6454 <summary>The singly-assigned value.</summary>
\r
6456 <member name="M:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.#ctor(System.Func{`0,`0})">
\r
6457 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.WriteOnceBlock`1"/>.</summary>
\r
6458 <param name="cloningFunction">
\r
6459 The function to use to clone the data when offered to other blocks.
\r
6460 This may be null to indicate that no cloning need be performed.
\r
6463 <member name="M:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.#ctor(System.Func{`0,`0},System.Threading.Tasks.Dataflow.DataflowBlockOptions)">
\r
6464 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.WriteOnceBlock`1"/> with the specified <see cref="T:System.Threading.Tasks.Dataflow.DataflowBlockOptions"/>.</summary>
\r
6465 <param name="cloningFunction">
\r
6466 The function to use to clone the data when offered to other blocks.
\r
6467 This may be null to indicate that no cloning need be performed.
\r
6469 <param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.WriteOnceBlock`1"/>.</param>
\r
6470 <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
\r
6472 <member name="M:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.CompleteBlockAsync(System.Collections.Generic.IList{System.Exception})">
\r
6473 <summary>Asynchronously completes the block on another task.</summary>
\r
6475 This must only be called once all of the completion conditions are met.
\r
6478 <member name="M:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.OfferToTargetsAndCompleteBlock">
\r
6479 <summary>Offers the message and completes the block.</summary>
\r
6481 This is called only once.
\r
6484 <member name="M:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.CompleteBlock(System.Collections.Generic.IList{System.Exception})">
\r
6485 <summary>Completes the block.</summary>
\r
6487 This is called only once.
\r
6490 <member name="M:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
\r
6492 Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a
\r
6493 <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
\r
6494 </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
\r
6495 The <paramref name="exception"/> is null (Nothing in Visual Basic).
\r
6496 </exception><remarks>
\r
6497 After Fault has been called on a dataflow block, that block will complete
\r
6498 (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes
\r
6499 buffered messages (uprocessed input messages as well as unoffered output messages) to be lost.
\r
6502 <member name="M:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.Complete">
\r
6504 Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
\r
6505 nor produce any more messages nor consume any more postponed messages.
\r
6506 </summary><remarks>
\r
6507 After Complete has been called on a dataflow block, that block will complete
\r
6508 (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
\r
6509 available data. Complete will not block waiting for completion to occur, but rather will initiaite
\r
6510 the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
\r
6513 <member name="M:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.TryReceive(System.Predicate{`0},`0@)">
\r
6515 Attempts to synchronously receive an available output item from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
6516 </summary><param name="filter">
\r
6517 The predicate a value must successfully pass in order for it to be received.
\r
6518 <paramref name="filter"/> may be null (Nothing in Visual Basic), in which case all items will pass.
\r
6519 </param><param name="item">The item received from the source.</param><returns>true if an item could be received; otherwise, false.</returns><remarks>
\r
6520 This method does not block waiting for the source to provide an item.
\r
6521 It will return after checking for an element, whether or not an element was available.
\r
6524 <member name="M:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.System#Threading#Tasks#Dataflow#IReceivableSourceBlock{T}#TryReceiveAll(System.Collections.Generic.IList{`0}@)">
\r
6526 Attempts to synchronously receive all available items from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
6527 </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>
\r
6528 This method does not block waiting for the source to provide an item.
\r
6529 It will return after checking for elements, whether or not an element was available.
\r
6532 <member name="M:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.LinkTo(System.Threading.Tasks.Dataflow.ITargetBlock{`0},System.Boolean)">
\r
6534 Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.
\r
6535 </summary><param name="target">
\r
6536 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect this source.
\r
6537 </param><param name="unlinkAfterOne">
\r
6538 true if the source should unlink from the target after successfully propagating a single message;
\r
6539 otherwise, false to remain connected even after a single message has been propagated.
\r
6540 </param><returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns><exception cref="T:System.ArgumentNullException">
\r
6541 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
6544 <member name="M:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.System#Threading#Tasks#Dataflow#ITargetBlock{T}#OfferMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,`0,System.Threading.Tasks.Dataflow.ISourceBlock{`0},System.Boolean)">
\r
6546 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.
\r
6547 </summary><param name="messageHeader">
\r
6548 A <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance that represents the header of the message being offered.
\r
6549 </param><param name="messageValue">
\r
6550 The value of the message being offered.
\r
6551 </param><param name="source">
\r
6552 The <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> offering the message. This may be null (Nothing in Visual Basic).
\r
6553 </param><param name="consumeToAccept">
\r
6554 true if the target must call ConsumeMessage synchronously during the call to OfferMessage, prior to returning
\r
6555 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Accepted"/>, in order to consume the message.
\r
6556 false if the target wanting to accept the message should not call ConsumeMessage, and should isntead simply return DataflowMessageStatus.Accepted.
\r
6558 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
\r
6559 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
\r
6560 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.
\r
6561 If the target would have otherwise postponed but source was null, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is instead returned.
\r
6562 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,
\r
6563 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.NotAvailable"/> is returned.
\r
6564 If the target chose not to accept the message, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is returned. If the target
\r
6565 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.
\r
6566 </returns><exception cref="T:System.ArgumentException">
\r
6567 The <paramref name="messageHeader"/> is not valid.
\r
6568 </exception><exception cref="T:System.ArgumentException">
\r
6569 <paramref name="consumeToAccept"/> may only be true if provided with a non-null <paramref name="source"/>.
\r
6572 <member name="M:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.System#Threading#Tasks#Dataflow#ISourceBlock{T}#ConsumeMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0},System.Boolean@)">
\r
6574 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to accept and consume a
\r
6575 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> previously offered by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
6576 </summary><param name="messageHeader">The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being consumed.</param><param name="target">
\r
6577 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> consuming the message.
\r
6578 </param><param name="messageConsumed">
\r
6579 True if the message was successfully consumed. False otherwise.
\r
6582 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
\r
6583 passed as the <paramref name="messageHeader"/> to <see cref="M:ConsumeMessage"/>. The consuming <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must
\r
6584 use the returned value instead of the value passed as messageValue through <see cref="M:OfferMessage"/>.
\r
6587 If the message requested is not available, the return value will be null (Nothing in Visual Basic).
\r
6589 </returns><exception cref="T:System.ArgumentException">
\r
6590 The <paramref name="messageHeader"/> is not valid.
\r
6591 </exception><exception cref="T:System.ArgumentNullException">
\r
6592 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
6593 </exception><remarks>
\r
6595 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
6596 instance may use <see cref="M:ConsumeMessage"/>, and it must only be used
\r
6597 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
6598 offered by this source to the target.
\r
6602 <member name="M:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.System#Threading#Tasks#Dataflow#ISourceBlock{T}#ReserveMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
\r
6604 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"/>
\r
6605 by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
6606 </summary><param name="messageHeader">
\r
6607 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being reserved.
\r
6608 </param><param name="target">
\r
6609 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> reserving the message.
\r
6610 </param><returns>true if the message was successfully reserved; otherwise, false.</returns><exception cref="T:System.ArgumentException">
\r
6611 The <paramref name="messageHeader"/> is not valid.
\r
6612 </exception><exception cref="T:System.ArgumentNullException">
\r
6613 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
6614 </exception><remarks>
\r
6616 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> instance
\r
6617 may use <see cref="M:ReserveMessage"/>, and it must only be used
\r
6618 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
6619 offered by this source to the target.
\r
6622 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.
\r
6623 Failure to do so may result in the source being unable to propagate any further messages to this or other targets.
\r
6626 <see cref="M:ReserveMessage"/> must not be called while the target is holding any internal locks. Doing so will violate the lock hierarchy
\r
6627 necessary to avoid deadlocks in a dataflow network.
\r
6631 <member name="M:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.System#Threading#Tasks#Dataflow#ISourceBlock{T}#ReleaseReservation(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
\r
6633 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to release a previously reserved
\r
6634 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
6635 </summary><param name="messageHeader">
\r
6636 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the reserved message being released.
\r
6637 </param><param name="target">
\r
6638 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> releasing the message it previously reserved.
\r
6639 </param><exception cref="T:System.ArgumentException">
\r
6640 The <paramref name="messageHeader"/> is not valid.
\r
6641 </exception><exception cref="T:System.ArgumentNullException">
\r
6642 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
6643 </exception><exception cref="T:System.InvalidOperationException">
\r
6644 The <paramref name="target"/> did not have the message reserved.
\r
6645 </exception><remarks>
\r
6647 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
6648 instance may use <see cref="M:ReleaseMessage"/>, and it must only be used
\r
6649 to release <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
6650 and successfully reserved by the target.
\r
6654 <member name="M:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.CloneItem(`0)">
\r
6655 <summary>Clones the item.</summary>
\r
6656 <param name="item">The item to clone.</param>
\r
6657 <returns>The cloned item.</returns>
\r
6659 <member name="M:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.OfferToTargets">
\r
6660 <summary>Offers the WriteOnceBlock's message to all targets.</summary>
\r
6662 <member name="P:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.ValueLock">
\r
6663 <summary>Gets the object used as the value lock.</summary>
\r
6665 <member name="P:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.Completion">
\r
6667 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
6668 </summary><remarks>
\r
6669 A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
\r
6670 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
6671 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
6672 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
6673 the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
\r
6674 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
6675 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
6676 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
6679 <member name="P:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.HasValue">
\r
6680 <summary>Gets whether the block is storing a value.</summary>
\r
6682 <member name="P:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.Value">
\r
6683 <summary>Gets the value being stored by the block.</summary>
\r
6685 <member name="P:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.DebuggerDisplayContent">
\r
6686 <summary>The data to display in the debugger display attribute.</summary>
\r
6688 <member name="P:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
\r
6689 <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
\r
6691 <member name="T:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.DebugView">
\r
6692 <summary>Provides a debugger type proxy for WriteOnceBlock.</summary>
\r
6694 <member name="F:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.DebugView.m_writeOnceBlock">
\r
6695 <summary>The WriteOnceBlock being viewed.</summary>
\r
6697 <member name="M:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.DebugView.#ctor(System.Threading.Tasks.Dataflow.WriteOnceBlock{`0})">
\r
6698 <summary>Initializes the debug view.</summary>
\r
6699 <param name="writeOnceBlock">The WriteOnceBlock to view.</param>
\r
6701 <member name="P:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.DebugView.IsCompleted">
\r
6702 <summary>Gets whether the WriteOnceBlock has completed.</summary>
\r
6704 <member name="P:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.DebugView.Id">
\r
6705 <summary>Gets the block's Id.</summary>
\r
6707 <member name="P:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.DebugView.HasValue">
\r
6708 <summary>Gets whether the WriteOnceBlock has a value.</summary>
\r
6710 <member name="P:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.DebugView.Value">
\r
6711 <summary>Gets the WriteOnceBlock's value if it has one, or default(T) if it doesn't.</summary>
\r
6713 <member name="P:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.DebugView.DataflowBlockOptions">
\r
6714 <summary>Gets the DataflowBlockOptions used to configure this block.</summary>
\r
6716 <member name="P:System.Threading.Tasks.Dataflow.WriteOnceBlock`1.DebugView.LinkedTargets">
\r
6717 <summary>Gets the set of all targets linked from this block.</summary>
\r
6719 <member name="T:System.Threading.Tasks.Dataflow.BroadcastBlock`1">
\r
6721 Provides a buffer for storing at most one element at time, overwriting each message with the next as it arrives.
\r
6722 Messages are broadcast to all linked targets, all of which may consume a clone of the message.
\r
6724 <typeparam name="T">Specifies the type of the data buffered by this dataflow block.</typeparam>
\r
6726 <see cref="T:System.Threading.Tasks.Dataflow.BroadcastBlock`1"/> exposes at most one element at a time. However, unlike
\r
6727 <see cref="T:System.Threading.Tasks.Dataflow.WriteOnceBlock`1"/>, that element will be overwritten as new elements are provided
\r
6728 to the block. <see cref="T:System.Threading.Tasks.Dataflow.BroadcastBlock`1"/> ensures that the current element is broadcast to any
\r
6729 linked targets before allowing the element to be overwritten.
\r
6732 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.m_source">
\r
6733 <summary>The source side.</summary>
\r
6735 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.m_boundingState">
\r
6736 <summary>Bounding state for when the block is executing in bounded mode.</summary>
\r
6738 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.m_decliningPermanently">
\r
6739 <summary>Whether all future messages should be declined.</summary>
\r
6741 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.m_completionReserved">
\r
6742 <summary>A task has reserved the right to run the completion routine.</summary>
\r
6744 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.#ctor(System.Func{`0,`0})">
\r
6745 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.BroadcastBlock`1"/> with the specified cloning function.</summary>
\r
6746 <param name="cloningFunction">
\r
6747 The function to use to clone the data when offered to other blocks.
\r
6748 This may be null to indicate that no cloning need be performed.
\r
6751 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.#ctor(System.Func{`0,`0},System.Threading.Tasks.Dataflow.DataflowBlockOptions)">
\r
6752 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.BroadcastBlock`1"/> with the specified cloning function and <see cref="T:System.Threading.Tasks.Dataflow.DataflowBlockOptions"/>.</summary>
\r
6753 <param name="cloningFunction">
\r
6754 The function to use to clone the data when offered to other blocks.
\r
6755 This may be null to indicate that no cloning need be performed.
\r
6757 <param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.BroadcastBlock`1"/>.</param>
\r
6758 <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
\r
6760 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.Complete">
\r
6762 Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
\r
6763 nor produce any more messages nor consume any more postponed messages.
\r
6764 </summary><remarks>
\r
6765 After Complete has been called on a dataflow block, that block will complete
\r
6766 (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
\r
6767 available data. Complete will not block waiting for completion to occur, but rather will initiaite
\r
6768 the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
\r
6771 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
\r
6773 Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a
\r
6774 <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
\r
6775 </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
\r
6776 The <paramref name="exception"/> is null (Nothing in Visual Basic).
\r
6777 </exception><remarks>
\r
6778 After Fault has been called on a dataflow block, that block will complete
\r
6779 (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes
\r
6780 buffered messages (uprocessed input messages as well as unoffered output messages) to be lost.
\r
6783 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.LinkTo(System.Threading.Tasks.Dataflow.ITargetBlock{`0},System.Boolean)">
\r
6785 Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.
\r
6786 </summary><param name="target">
\r
6787 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect this source.
\r
6788 </param><param name="unlinkAfterOne">
\r
6789 true if the source should unlink from the target after successfully propagating a single message;
\r
6790 otherwise, false to remain connected even after a single message has been propagated.
\r
6791 </param><returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns><exception cref="T:System.ArgumentNullException">
\r
6792 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
6795 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.TryReceive(System.Predicate{`0},`0@)">
\r
6797 Attempts to synchronously receive an available output item from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
6798 </summary><param name="filter">
\r
6799 The predicate a value must successfully pass in order for it to be received.
\r
6800 <paramref name="filter"/> may be null (Nothing in Visual Basic), in which case all items will pass.
\r
6801 </param><param name="item">The item received from the source.</param><returns>true if an item could be received; otherwise, false.</returns><remarks>
\r
6802 This method does not block waiting for the source to provide an item.
\r
6803 It will return after checking for an element, whether or not an element was available.
\r
6806 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.System#Threading#Tasks#Dataflow#IReceivableSourceBlock{T}#TryReceiveAll(System.Collections.Generic.IList{`0}@)">
\r
6808 Attempts to synchronously receive all available items from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
6809 </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>
\r
6810 This method does not block waiting for the source to provide an item.
\r
6811 It will return after checking for elements, whether or not an element was available.
\r
6814 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.System#Threading#Tasks#Dataflow#ITargetBlock{T}#OfferMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,`0,System.Threading.Tasks.Dataflow.ISourceBlock{`0},System.Boolean)">
\r
6816 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.
\r
6817 </summary><param name="messageHeader">
\r
6818 A <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance that represents the header of the message being offered.
\r
6819 </param><param name="messageValue">
\r
6820 The value of the message being offered.
\r
6821 </param><param name="source">
\r
6822 The <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> offering the message. This may be null (Nothing in Visual Basic).
\r
6823 </param><param name="consumeToAccept">
\r
6824 true if the target must call ConsumeMessage synchronously during the call to OfferMessage, prior to returning
\r
6825 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Accepted"/>, in order to consume the message.
\r
6826 false if the target wanting to accept the message should not call ConsumeMessage, and should isntead simply return DataflowMessageStatus.Accepted.
\r
6828 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
\r
6829 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
\r
6830 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.
\r
6831 If the target would have otherwise postponed but source was null, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is instead returned.
\r
6832 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,
\r
6833 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.NotAvailable"/> is returned.
\r
6834 If the target chose not to accept the message, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is returned. If the target
\r
6835 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.
\r
6836 </returns><exception cref="T:System.ArgumentException">
\r
6837 The <paramref name="messageHeader"/> is not valid.
\r
6838 </exception><exception cref="T:System.ArgumentException">
\r
6839 <paramref name="consumeToAccept"/> may only be true if provided with a non-null <paramref name="source"/>.
\r
6842 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.OnItemsRemoved(System.Int32)">
\r
6843 <summary>Notifies the block that one or more items was removed from the queue.</summary>
\r
6844 <param name="numItemsRemoved">The number of items removed.</param>
\r
6846 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.ConsumeAsyncIfNecessary(System.Boolean)">
\r
6847 <summary>Called when postponed messages may need to be consumed.</summary>
\r
6848 <param name="isReplacementReplica">Whether this call is the continuation of a previous message loop.</param>
\r
6850 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.ConsumeMessagesLoopWithExecutionContext">
\r
6851 <summary>Task body used to consume postponed messages under the right execution context.</summary>
\r
6853 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.ConsumeMessagesLoopCore">
\r
6854 <summary>Task body used to consume postponed messages.</summary>
\r
6856 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.ConsumeAndStoreOneMessageIfAvailable">
\r
6858 Retrieves one postponed message if there's room and if we can consume a postoned message.
\r
6859 Stores any consumed message into the source half.
\r
6861 <returns>true if a message could be consumed and stored; otherwise, false.</returns>
\r
6862 <remarks>This must only be called from the asynchronous processing loop.</remarks>
\r
6864 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.CompleteTargetIfPossible">
\r
6865 <summary>Completes the target, notifying the source, once all completion conditions are met.</summary>
\r
6867 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.System#Threading#Tasks#Dataflow#ISourceBlock{T}#ConsumeMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0},System.Boolean@)">
\r
6869 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to accept and consume a
\r
6870 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> previously offered by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
6871 </summary><param name="messageHeader">The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being consumed.</param><param name="target">
\r
6872 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> consuming the message.
\r
6873 </param><param name="messageConsumed">
\r
6874 True if the message was successfully consumed. False otherwise.
\r
6877 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
\r
6878 passed as the <paramref name="messageHeader"/> to <see cref="M:ConsumeMessage"/>. The consuming <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must
\r
6879 use the returned value instead of the value passed as messageValue through <see cref="M:OfferMessage"/>.
\r
6882 If the message requested is not available, the return value will be null (Nothing in Visual Basic).
\r
6884 </returns><exception cref="T:System.ArgumentException">
\r
6885 The <paramref name="messageHeader"/> is not valid.
\r
6886 </exception><exception cref="T:System.ArgumentNullException">
\r
6887 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
6888 </exception><remarks>
\r
6890 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
6891 instance may use <see cref="M:ConsumeMessage"/>, and it must only be used
\r
6892 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
6893 offered by this source to the target.
\r
6897 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.System#Threading#Tasks#Dataflow#ISourceBlock{T}#ReserveMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
\r
6899 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"/>
\r
6900 by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
6901 </summary><param name="messageHeader">
\r
6902 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being reserved.
\r
6903 </param><param name="target">
\r
6904 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> reserving the message.
\r
6905 </param><returns>true if the message was successfully reserved; otherwise, false.</returns><exception cref="T:System.ArgumentException">
\r
6906 The <paramref name="messageHeader"/> is not valid.
\r
6907 </exception><exception cref="T:System.ArgumentNullException">
\r
6908 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
6909 </exception><remarks>
\r
6911 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> instance
\r
6912 may use <see cref="M:ReserveMessage"/>, and it must only be used
\r
6913 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
6914 offered by this source to the target.
\r
6917 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.
\r
6918 Failure to do so may result in the source being unable to propagate any further messages to this or other targets.
\r
6921 <see cref="M:ReserveMessage"/> must not be called while the target is holding any internal locks. Doing so will violate the lock hierarchy
\r
6922 necessary to avoid deadlocks in a dataflow network.
\r
6926 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.System#Threading#Tasks#Dataflow#ISourceBlock{T}#ReleaseReservation(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`0})">
\r
6928 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to release a previously reserved
\r
6929 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
6930 </summary><param name="messageHeader">
\r
6931 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the reserved message being released.
\r
6932 </param><param name="target">
\r
6933 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> releasing the message it previously reserved.
\r
6934 </param><exception cref="T:System.ArgumentException">
\r
6935 The <paramref name="messageHeader"/> is not valid.
\r
6936 </exception><exception cref="T:System.ArgumentNullException">
\r
6937 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
6938 </exception><exception cref="T:System.InvalidOperationException">
\r
6939 The <paramref name="target"/> did not have the message reserved.
\r
6940 </exception><remarks>
\r
6942 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
6943 instance may use <see cref="M:ReleaseMessage"/>, and it must only be used
\r
6944 to release <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
6945 and successfully reserved by the target.
\r
6949 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.IncomingLock">
\r
6950 <summary>Gets the lock used to synchronize incoming requests.</summary>
\r
6952 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.Completion">
\r
6954 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
6955 </summary><remarks>
\r
6956 A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
\r
6957 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
6958 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
6959 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
6960 the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
\r
6961 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
6962 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
6963 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
6966 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.HasValueForDebugger">
\r
6967 <summary>Gets a value to be used for the DebuggerDisplayAttribute. This must not throw even if HasValue is false.</summary>
\r
6969 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.ValueForDebugger">
\r
6970 <summary>Gets a value to be used for the DebuggerDisplayAttribute. This must not throw even if HasValue is false.</summary>
\r
6972 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.DebuggerDisplayContent">
\r
6973 <summary>The data to display in the debugger display attribute.</summary>
\r
6975 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
\r
6976 <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
\r
6978 <member name="T:System.Threading.Tasks.Dataflow.BroadcastBlock`1.DebugView">
\r
6979 <summary>Provides a debugger type proxy for the BroadcastBlock.</summary>
\r
6981 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.DebugView.m_broadcastBlock">
\r
6982 <summary>The BroadcastBlock being debugged.</summary>
\r
6984 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.DebugView.m_sourceDebuggingInformation">
\r
6985 <summary>Debug info about the source side of the broadcast.</summary>
\r
6987 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.DebugView.#ctor(System.Threading.Tasks.Dataflow.BroadcastBlock{`0})">
\r
6988 <summary>Initializes the debug view.</summary>
\r
6989 <param name="broadcastBlock">The BroadcastBlock being debugged.</param>
\r
6991 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.DebugView.InputQueue">
\r
6992 <summary>Gets the messages waiting to be processed.</summary>
\r
6994 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.DebugView.HasValue">
\r
6995 <summary>Gets whether the broadcast has a current value.</summary>
\r
6997 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.DebugView.Value">
\r
6998 <summary>Gets the broadcast's current value.</summary>
\r
7000 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.DebugView.TaskForOutputProcessing">
\r
7001 <summary>Gets the task being used for output processing.</summary>
\r
7003 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.DebugView.DataflowBlockOptions">
\r
7004 <summary>Gets the DataflowBlockOptions used to configure this block.</summary>
\r
7006 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.DebugView.IsDecliningPermanently">
\r
7007 <summary>Gets whether the block is declining further messages.</summary>
\r
7009 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.DebugView.IsCompleted">
\r
7010 <summary>Gets whether the block is completed.</summary>
\r
7012 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.DebugView.Id">
\r
7013 <summary>Gets the block's Id.</summary>
\r
7015 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.DebugView.LinkedTargets">
\r
7016 <summary>Gets the set of all targets linked from this block.</summary>
\r
7018 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.DebugView.NextMessageReservedFor">
\r
7019 <summary>Gets the set of all targets linked from this block.</summary>
\r
7021 <member name="T:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1">
\r
7022 <summary>Provides a core implementation for blocks that implement <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.</summary>
\r
7023 <typeparam name="TOutput">Specifies the type of data supplied by the <see cref="T:System.Threading.Tasks.Dataflow.Internal.SourceCore`1"/>.</typeparam>
\r
7025 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.m_executionContext">
\r
7026 <summary>The execution context captured when this block was instantiated.</summary>
\r
7028 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.m_targetRegistry">
\r
7029 <summary>A registry used to store all linked targets and information about them.</summary>
\r
7031 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.m_messages">
\r
7032 <summary>All of the output messages queued up to be received by consumers/targets.</summary>
\r
7034 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.m_completionTask">
\r
7035 <summary>A TaskCompletionSource that represents the completion of this block.</summary>
\r
7037 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.m_itemsRemovedAction">
\r
7039 An action to be invoked on the owner block when an item is removed.
\r
7040 This may be null if the owner block doesn't need to be notified.
\r
7043 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.m_owningSource">
\r
7044 <summary>The source utilize this helper.</summary>
\r
7046 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.m_dataflowBlockOptions">
\r
7047 <summary>The options used to configure this block's execution.</summary>
\r
7049 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.m_cloningFunction">
\r
7050 <summary>The cloning function to use.</summary>
\r
7052 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.m_currentMessageIsValid">
\r
7053 <summary>An indicator whether m_currentMessage has a value.</summary>
\r
7055 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.m_currentMessage">
\r
7056 <summary>The message currently being broadcast.</summary>
\r
7058 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.m_nextMessageReservedFor">
\r
7059 <summary>The target that the next message is reserved for, or null if nothing is reserved.</summary>
\r
7061 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.m_enableOffering">
\r
7062 <summary>Whether this block should again attempt to offer messages to targets.</summary>
\r
7064 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.m_decliningPermanently">
\r
7065 <summary>Whether all future messages should be declined.</summary>
\r
7067 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.m_taskForOutputProcessing">
\r
7068 <summary>The task used to process the output and offer it to targets.</summary>
\r
7070 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.m_exceptions">
\r
7071 <summary>Exceptions that may have occured and gone unhandled during processing.</summary>
\r
7073 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.m_nextMessageId">
\r
7074 <summary>Counter for message IDs unique within this source block.</summary>
\r
7076 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.m_completionReserved">
\r
7077 <summary>Whether someone has reserved the right to call CompleteBlockOncePossible.</summary>
\r
7079 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.#ctor(System.Threading.Tasks.Dataflow.BroadcastBlock{`1},System.Func{`1,`1},System.Threading.Tasks.Dataflow.DataflowBlockOptions,System.Action{System.Int32})">
\r
7080 <summary>Initializes the source core.</summary>
\r
7081 <param name="owningSource">The source utilizing this core.</param>
\r
7082 <param name="cloningFunction">The function to use to clone the data when offered to other blocks. May be null.</param>
\r
7083 <param name="dataflowBlockOptions">The options to use to configure the block.</param>
\r
7084 <param name="itemsRemovedAction">Action to invoke when an item is removed.</param>
\r
7086 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.TryReceive(System.Predicate{`1},`1@)">
\r
7088 Attempts to synchronously receive an available output item from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
7089 </summary><param name="filter">
\r
7090 The predicate a value must successfully pass in order for it to be received.
\r
7091 <paramref name="filter"/> may be null (Nothing in Visual Basic), in which case all items will pass.
\r
7092 </param><param name="item">The item received from the source.</param><returns>true if an item could be received; otherwise, false.</returns><remarks>
\r
7093 This method does not block waiting for the source to provide an item.
\r
7094 It will return after checking for an element, whether or not an element was available.
\r
7097 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.TryReceiveAll(System.Collections.Generic.IList{`1}@)">
\r
7099 Attempts to synchronously receive all available items from the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
7100 </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>
\r
7101 This method does not block waiting for the source to provide an item.
\r
7102 It will return after checking for elements, whether or not an element was available.
\r
7105 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.AddMessage(`1)">
\r
7106 <summary>Adds a message to the source block for propagation.</summary>
\r
7107 <param name="item">The item to be wrapped in a message to be added.</param>
\r
7109 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.Complete">
\r
7110 <summary>Informs the block that it will not be receiving additional messages.</summary>
\r
7112 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.CloneItem(`1)">
\r
7113 <summary>Clones the item.</summary>
\r
7114 <param name="item">The item to clone.</param>
\r
7115 <returns>The cloned item.</returns>
\r
7117 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.OfferCurrentMessageToNewTarget(System.Threading.Tasks.Dataflow.ITargetBlock{`1})">
\r
7118 <summary>Offers the current message to a specific target.</summary>
\r
7119 <param name="target">The target to which to offer the current message.</param>
\r
7121 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.OfferToTargets">
\r
7122 <summary>Offers messages to targets.</summary>
\r
7124 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.OfferMessageToTarget(System.Threading.Tasks.Dataflow.DataflowMessageHeader,`1,System.Threading.Tasks.Dataflow.ITargetBlock{`1})">
\r
7125 <summary>Offers the specified message to the specified target.</summary>
\r
7126 <param name="header">The header of the message to offer.</param>
\r
7127 <param name="message">The message to offer.</param>
\r
7128 <param name="target">The target to which the message should be offered.</param>
\r
7130 This will remove the target from the target registry if the result of the propagation demands it.
\r
7133 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.OfferAsyncIfNecessary(System.Boolean)">
\r
7134 <summary>Called when we want to enable asynchronously offering message to targets.</summary>
\r
7135 <param name="isReplacementReplica">Whether this call is the continuation of a previous message loop.</param>
\r
7137 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.OfferMessagesLoopWithExecutionContext">
\r
7138 <summary>Task body used to process messages with the right execution context.</summary>
\r
7140 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.OfferMessagesLoopCore">
\r
7141 <summary>Task body used to process messages.</summary>
\r
7143 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.CompleteBlockIfPossible">
\r
7144 <summary>Completes the block's processing if there's nothing left to do and never will be.</summary>
\r
7146 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.CompleteBlockOncePossible">
\r
7148 Completes the block. This must only be called once, and only once all of the completion conditions are met.
\r
7149 As such, it must only be called from CompleteBlockIfPossible.
\r
7152 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.LinkTo(System.Threading.Tasks.Dataflow.ITargetBlock{`1},System.Boolean)">
\r
7154 Links the <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> to the specified <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/>.
\r
7155 </summary><param name="target">
\r
7156 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to which to connect this source.
\r
7157 </param><param name="unlinkAfterOne">
\r
7158 true if the source should unlink from the target after successfully propagating a single message;
\r
7159 otherwise, false to remain connected even after a single message has been propagated.
\r
7160 </param><returns>An IDisposable that, upon calling Dispose, will unlink the source from the target.</returns><exception cref="T:System.ArgumentNullException">
\r
7161 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
7164 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.ConsumeMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`1},System.Boolean@)">
\r
7166 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to accept and consume a
\r
7167 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> previously offered by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
7168 </summary><param name="messageHeader">The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being consumed.</param><param name="target">
\r
7169 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> consuming the message.
\r
7170 </param><param name="messageConsumed">
\r
7171 True if the message was successfully consumed. False otherwise.
\r
7174 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
\r
7175 passed as the <paramref name="messageHeader"/> to <see cref="M:ConsumeMessage"/>. The consuming <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> must
\r
7176 use the returned value instead of the value passed as messageValue through <see cref="M:OfferMessage"/>.
\r
7179 If the message requested is not available, the return value will be null (Nothing in Visual Basic).
\r
7181 </returns><exception cref="T:System.ArgumentException">
\r
7182 The <paramref name="messageHeader"/> is not valid.
\r
7183 </exception><exception cref="T:System.ArgumentNullException">
\r
7184 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
7185 </exception><remarks>
\r
7187 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
7188 instance may use <see cref="M:ConsumeMessage"/>, and it must only be used
\r
7189 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
7190 offered by this source to the target.
\r
7194 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.ReserveMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`1})">
\r
7196 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"/>
\r
7197 by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
7198 </summary><param name="messageHeader">
\r
7199 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the message being reserved.
\r
7200 </param><param name="target">
\r
7201 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> reserving the message.
\r
7202 </param><returns>true if the message was successfully reserved; otherwise, false.</returns><exception cref="T:System.ArgumentException">
\r
7203 The <paramref name="messageHeader"/> is not valid.
\r
7204 </exception><exception cref="T:System.ArgumentNullException">
\r
7205 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
7206 </exception><remarks>
\r
7208 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> instance
\r
7209 may use <see cref="M:ReserveMessage"/>, and it must only be used
\r
7210 to reserve <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
7211 offered by this source to the target.
\r
7214 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.
\r
7215 Failure to do so may result in the source being unable to propagate any further messages to this or other targets.
\r
7218 <see cref="M:ReserveMessage"/> must not be called while the target is holding any internal locks. Doing so will violate the lock hierarchy
\r
7219 necessary to avoid deadlocks in a dataflow network.
\r
7223 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.ReleaseReservation(System.Threading.Tasks.Dataflow.DataflowMessageHeader,System.Threading.Tasks.Dataflow.ITargetBlock{`1})">
\r
7225 Called by a linked <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> to release a previously reserved
\r
7226 <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> by this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>.
\r
7227 </summary><param name="messageHeader">
\r
7228 The <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> of the reserved message being released.
\r
7229 </param><param name="target">
\r
7230 The <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> releasing the message it previously reserved.
\r
7231 </param><exception cref="T:System.ArgumentException">
\r
7232 The <paramref name="messageHeader"/> is not valid.
\r
7233 </exception><exception cref="T:System.ArgumentNullException">
\r
7234 The <paramref name="target"/> is null (Nothing in Visual Basic).
\r
7235 </exception><exception cref="T:System.InvalidOperationException">
\r
7236 The <paramref name="target"/> did not have the message reserved.
\r
7237 </exception><remarks>
\r
7239 Only <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1"/> instances linked to this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/>
\r
7240 instance may use <see cref="M:ReleaseMessage"/>, and it must only be used
\r
7241 to release <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instances previously
\r
7242 and successfully reserved by the target.
\r
7246 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.AddException(System.Exception)">
\r
7247 <summary>Adds an individual exceptionto this source.</summary>
\r
7248 <param name="exception">The exception to add</param>
\r
7250 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.AddExceptions(System.Collections.Generic.List{System.Exception})">
\r
7251 <summary>Adds exceptions to this source.</summary>
\r
7252 <param name="exceptions">The exceptions to add</param>
\r
7254 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.GetDebuggingInformation">
\r
7255 <summary>Gets information about this helper to be used for display in a debugger.</summary>
\r
7256 <returns>Debugging information about this source core.</returns>
\r
7258 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.OutgoingLock">
\r
7259 <summary>Gets the object to use as the outgoing lock.</summary>
\r
7261 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.ValueLock">
\r
7262 <summary>Gets the object to use as the value lock.</summary>
\r
7264 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.CanceledOrFaulted">
\r
7265 <summary>Gets whether the source has had cancellation requested or an exception has occurred.</summary>
\r
7267 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.Completion">
\r
7269 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
7270 </summary><remarks>
\r
7271 A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
\r
7272 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
7273 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
7274 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
7275 the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
\r
7276 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
7277 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
7278 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
7281 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.DataflowBlockOptions">
\r
7282 <summary>Gets the DataflowBlockOptions used to configure this block.</summary>
\r
7284 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.CapturedContext">
\r
7285 <summary>Gets the execution context captured for this source core.</summary>
\r
7287 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.DebuggerDisplayContent">
\r
7288 <summary>Gets the object to display in the debugger display attribute.</summary>
\r
7290 <member name="T:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.DebuggingInformation">
\r
7291 <summary>Provides debugging information about the source core.</summary>
\r
7293 <member name="F:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.DebuggingInformation.m_source">
\r
7294 <summary>The source being viewed.</summary>
\r
7296 <member name="M:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.DebuggingInformation.#ctor(System.Threading.Tasks.Dataflow.BroadcastBlock{`0}.BroadcastingSourceCore{`1})">
\r
7297 <summary>Initializes the type proxy.</summary>
\r
7298 <param name="source">The source being viewed.</param>
\r
7300 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.DebuggingInformation.HasValue">
\r
7301 <summary>Gets whether the source contains a current message.</summary>
\r
7303 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.DebuggingInformation.Value">
\r
7304 <summary>Gets the value of the source's current message.</summary>
\r
7306 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.DebuggingInformation.InputCount">
\r
7307 <summary>Gets the number of messages waiting to be made current.</summary>
\r
7309 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.DebuggingInformation.InputQueue">
\r
7310 <summary>Gets the messages available for receiving.</summary>
\r
7312 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.DebuggingInformation.TaskForOutputProcessing">
\r
7313 <summary>Gets the task being used for output processing.</summary>
\r
7315 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.DebuggingInformation.DataflowBlockOptions">
\r
7316 <summary>Gets the DataflowBlockOptions used to configure this block.</summary>
\r
7318 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.DebuggingInformation.IsDecliningPermanently">
\r
7319 <summary>Gets whether the block is declining further messages.</summary>
\r
7321 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.DebuggingInformation.IsCompleted">
\r
7322 <summary>Gets whether the block is completed.</summary>
\r
7324 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.DebuggingInformation.LinkedTargets">
\r
7325 <summary>Gets the set of all targets linked from this block.</summary>
\r
7327 <member name="P:System.Threading.Tasks.Dataflow.BroadcastBlock`1.BroadcastingSourceCore`1.DebuggingInformation.NextMessageReservedFor">
\r
7328 <summary>Gets the target that holds a reservation on the next message, if any.</summary>
\r
7330 <member name="T:System.Threading.Tasks.Dataflow.Internal.IReorderingBuffer">
\r
7331 <summary>Base interface for reordering buffers.</summary>
\r
7333 <member name="M:System.Threading.Tasks.Dataflow.Internal.IReorderingBuffer.IgnoreItem(System.Int64)">
\r
7334 <summary>Informs the reordering buffer not to expect the message with the specified id.</summary>
\r
7335 <param name="id">The id of the message to be ignored.</param>
\r
7337 <member name="T:System.Threading.Tasks.Dataflow.Internal.ReorderingBuffer`1">
\r
7338 <summary>Provides a buffer that reorders items according to their incoming IDs.</summary>
\r
7339 <typeparam name="TOutput">Specifies the type of data stored in the items being reordered.</typeparam>
\r
7341 This type expects the first item to be ID==0 and for all subsequent items
\r
7342 to increase IDs sequentially.
\r
7345 <member name="F:System.Threading.Tasks.Dataflow.Internal.ReorderingBuffer`1.m_reorderingBuffer">
\r
7346 <summary>A reordering buffer used when parallelism is employed and items may be completed out-of-order.</summary>
\r
7347 <remarks>Also serves as the sync object to protect the contents of this class.</remarks>
\r
7349 <member name="F:System.Threading.Tasks.Dataflow.Internal.ReorderingBuffer`1.m_outputAction">
\r
7350 <summary>Action used to output items in order.</summary>
\r
7352 <member name="F:System.Threading.Tasks.Dataflow.Internal.ReorderingBuffer`1.m_nextReorderedIdToOutput">
\r
7353 <summary>The ID of the next item that should be released from the reordering buffer.</summary>
\r
7355 <member name="M:System.Threading.Tasks.Dataflow.Internal.ReorderingBuffer`1.#ctor(System.Action{`0})">
\r
7356 <summary>Initializes the reordering buffer.</summary>
\r
7357 <param name="outputAction">The action to invoke when the next in-order item is available to be output.</param>
\r
7359 <member name="M:System.Threading.Tasks.Dataflow.Internal.ReorderingBuffer`1.AddItem(System.Int64,`0,System.Boolean)">
\r
7360 <summary>Stores the next item as it completes processing.</summary>
\r
7361 <param name="id">The ID of the item.</param>
\r
7362 <param name="item">The completed item.</param>
\r
7363 <param name="itemIsValid">Specifies whether the item is valid (true) or just a placeholder (false).</param>
\r
7365 <member name="M:System.Threading.Tasks.Dataflow.Internal.ReorderingBuffer`1.IgnoreItem(System.Int64)">
\r
7366 <summary>Informs the reordering buffer not to expect the message with the specified id.</summary>
\r
7367 <param name="id">The id of the message to be ignored.</param>
\r
7369 <member name="P:System.Threading.Tasks.Dataflow.Internal.ReorderingBuffer`1.CountForDebugging">
\r
7370 <summary>Gets a item count for debugging purposes.</summary>
\r
7372 <member name="T:System.Threading.Tasks.Dataflow.Internal.ReorderingBuffer`1.DebugView">
\r
7373 <summary>Provides a debugger type proxy for the buffer.</summary>
\r
7375 <member name="F:System.Threading.Tasks.Dataflow.Internal.ReorderingBuffer`1.DebugView.m_buffer">
\r
7376 <summary>The buffer being debugged.</summary>
\r
7378 <member name="M:System.Threading.Tasks.Dataflow.Internal.ReorderingBuffer`1.DebugView.#ctor(System.Threading.Tasks.Dataflow.Internal.ReorderingBuffer{`0})">
\r
7379 <summary>Initializes the debug view.</summary>
\r
7380 <param name="buffer">The buffer being debugged.</param>
\r
7382 <member name="P:System.Threading.Tasks.Dataflow.Internal.ReorderingBuffer`1.DebugView.ItemsBuffered">
\r
7383 <summary>Gets a dictionary of buffered items and their reordering IDs.</summary>
\r
7385 <member name="P:System.Threading.Tasks.Dataflow.Internal.ReorderingBuffer`1.DebugView.NextIdRequired">
\r
7386 <summary>Gets the next ID required for outputting.</summary>
\r
7388 <member name="T:System.Threading.Tasks.Dataflow.ActionBlock`1">
\r
7389 <summary>Provides a dataflow block that invokes a provided <see cref="T:System.Action`1"/> delegate for every data element received.</summary>
\r
7390 <typeparam name="TInput">Specifies the type of data operated on by this <see cref="T:System.Threading.Tasks.Dataflow.ActionBlock`1"/>.</typeparam>
\r
7392 <member name="F:System.Threading.Tasks.Dataflow.ActionBlock`1.m_target">
\r
7393 <summary>The core implementation of this message block.</summary>
\r
7395 <member name="M:System.Threading.Tasks.Dataflow.ActionBlock`1.#ctor(System.Action{`0})">
\r
7396 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.ActionBlock`1"/> with the specified <see cref="T:System.Action`1"/>.</summary>
\r
7397 <param name="action">The action to invoke with each data element received.</param>
\r
7398 <exception cref="T:System.ArgumentNullException">The <paramref name="action"/> is null (Nothing in Visual Basic).</exception>
\r
7400 <member name="M:System.Threading.Tasks.Dataflow.ActionBlock`1.#ctor(System.Action{`0},System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions)">
\r
7401 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.ActionBlock`1"/> with the specified <see cref="T:System.Action`1"/> and <see cref="T:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions"/>.</summary>
\r
7402 <param name="action">The action to invoke with each data element received.</param>
\r
7403 <param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.ActionBlock`1"/>.</param>
\r
7404 <exception cref="T:System.ArgumentNullException">The <paramref name="action"/> is null (Nothing in Visual Basic).</exception>
\r
7405 <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
\r
7407 <member name="M:System.Threading.Tasks.Dataflow.ActionBlock`1.#ctor(System.Func{`0,System.Threading.Tasks.Task})">
\r
7408 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.ActionBlock`1"/> with the specified <see cref="T:System.Func`2"/>.</summary>
\r
7409 <param name="action">The action to invoke with each data element received.</param>
\r
7410 <exception cref="T:System.ArgumentNullException">The <paramref name="action"/> is null (Nothing in Visual Basic).</exception>
\r
7412 <member name="M:System.Threading.Tasks.Dataflow.ActionBlock`1.#ctor(System.Func{`0,System.Threading.Tasks.Task},System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions)">
\r
7413 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.ActionBlock`1"/> with the specified <see cref="T:System.Func`2"/> and <see cref="T:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions"/>.</summary>
\r
7414 <param name="action">The action to invoke with each data element received.</param>
\r
7415 <param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.ActionBlock`1"/>.</param>
\r
7416 <exception cref="T:System.ArgumentNullException">The <paramref name="action"/> is null (Nothing in Visual Basic).</exception>
\r
7417 <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
\r
7419 <member name="M:System.Threading.Tasks.Dataflow.ActionBlock`1.#ctor(System.Delegate,System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions)">
\r
7420 <summary>Initializes the <see cref="T:System.Threading.Tasks.Dataflow.ActionBlock`1"/> with the specified delegate and options.</summary>
\r
7421 <param name="action">The action to invoke with each data element received.</param>
\r
7422 <param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.ActionBlock`1"/>.</param>
\r
7423 <exception cref="T:System.ArgumentNullException">The <paramref name="action"/> is null (Nothing in Visual Basic).</exception>
\r
7424 <exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions"/> is null (Nothing in Visual Basic).</exception>
\r
7426 <member name="M:System.Threading.Tasks.Dataflow.ActionBlock`1.ProcessMessage(System.Action{`0},System.Collections.Generic.KeyValuePair{`0,System.Int64})">
\r
7427 <summary>Processes the message with a user-provided action.</summary>
\r
7428 <param name="action">The action to use to process the message.</param>
\r
7429 <param name="messageWithId">The message to be processed.</param>
\r
7431 <member name="M:System.Threading.Tasks.Dataflow.ActionBlock`1.ProcessMessageWithTask(System.Func{`0,System.Threading.Tasks.Task},System.Collections.Generic.KeyValuePair{`0,System.Int64})">
\r
7432 <summary>Processes the message with a user-provided action that returns a task.</summary>
\r
7433 <param name="action">The action to use to process the message.</param>
\r
7434 <param name="messageWithId">The message to be processed.</param>
\r
7436 <member name="M:System.Threading.Tasks.Dataflow.ActionBlock`1.AsyncCompleteProcessMessageWithTask(System.Threading.Tasks.Task)">
\r
7437 <summary>Completes the processing of an asynchronous message.</summary>
\r
7438 <param name="completed">The completed task.</param>
\r
7440 <member name="M:System.Threading.Tasks.Dataflow.ActionBlock`1.Complete">
\r
7442 Signals to the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> that it should not accept
\r
7443 nor produce any more messages nor consume any more postponed messages.
\r
7444 </summary><remarks>
\r
7445 After Complete has been called on a dataflow block, that block will complete
\r
7446 (such that its <see cref="M:Completion"/> task will enter a final state) after it's processed all previously
\r
7447 available data. Complete will not block waiting for completion to occur, but rather will initiaite
\r
7448 the request; to wait for completion to occur, the <see cref="M:Completion"/> task may be used.
\r
7451 <member name="M:System.Threading.Tasks.Dataflow.ActionBlock`1.System#Threading#Tasks#Dataflow#IDataflowBlock#Fault(System.Exception)">
\r
7453 Causes the <see cref="T:System.Threading.Tasks.Dataflow.IDataflowBlock"/> to complete in a
\r
7454 <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> state.
\r
7455 </summary><param name="exception">The <see cref="T:System.Exception"/> that caused the faulting.</param><exception cref="T:System.ArgumentNullException">
\r
7456 The <paramref name="exception"/> is null (Nothing in Visual Basic).
\r
7457 </exception><remarks>
\r
7458 After Fault has been called on a dataflow block, that block will complete
\r
7459 (such that its <see cref="M:Completion"/> task will enter a final state). Faulting a block causes
\r
7460 buffered messages (uprocessed input messages as well as unoffered output messages) to be lost.
\r
7463 <member name="M:System.Threading.Tasks.Dataflow.ActionBlock`1.System#Threading#Tasks#Dataflow#ITargetBlock{TInput}#OfferMessage(System.Threading.Tasks.Dataflow.DataflowMessageHeader,`0,System.Threading.Tasks.Dataflow.ISourceBlock{`0},System.Boolean)">
\r
7465 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.
\r
7466 </summary><param name="messageHeader">
\r
7467 A <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader"/> instance that represents the header of the message being offered.
\r
7468 </param><param name="messageValue">
\r
7469 The value of the message being offered.
\r
7470 </param><param name="source">
\r
7471 The <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1"/> offering the message. This may be null (Nothing in Visual Basic).
\r
7472 </param><param name="consumeToAccept">
\r
7473 true if the target must call ConsumeMessage synchronously during the call to OfferMessage, prior to returning
\r
7474 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Accepted"/>, in order to consume the message.
\r
7475 false if the target wanting to accept the message should not call ConsumeMessage, and should isntead simply return DataflowMessageStatus.Accepted.
\r
7477 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
\r
7478 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
\r
7479 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.
\r
7480 If the target would have otherwise postponed but source was null, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is instead returned.
\r
7481 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,
\r
7482 <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.NotAvailable"/> is returned.
\r
7483 If the target chose not to accept the message, <see cref="F:System.Threading.Tasks.Dataflow.DataflowMessageStatus.Declined"/> is returned. If the target
\r
7484 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.
\r
7485 </returns><exception cref="T:System.ArgumentException">
\r
7486 The <paramref name="messageHeader"/> is not valid.
\r
7487 </exception><exception cref="T:System.ArgumentException">
\r
7488 <paramref name="consumeToAccept"/> may only be true if provided with a non-null <paramref name="source"/>.
\r
7491 <member name="P:System.Threading.Tasks.Dataflow.ActionBlock`1.Completion">
\r
7493 Gets a <see cref="T:System.Threading.Tasks.Task">Task</see> that represents the asynchronous operation and completion of the dataflow block.
\r
7494 </summary><remarks>
\r
7495 A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process
\r
7496 any more messages. The returned <see cref="T:System.Threading.Tasks.Task">Task</see> will transition to a completed state when the
\r
7497 associated block has completed. It will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state
\r
7498 when the block completes its processing successfully according to the dataflow block’s defined semantics, it will transition to
\r
7499 the <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state when the dataflow block has completed processing prematurely due to an unhandled exception,
\r
7500 and it will transition to the <see cref="T:System.Threading.Tasks.TaskStatus">Canceled</see> state when the dataflow block has completed processing
\r
7501 prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return
\r
7502 an <see cref="T:System.AggregateException"/> containing the one or more exceptions that caused the block to fail.
\r
7505 <member name="P:System.Threading.Tasks.Dataflow.ActionBlock`1.InputCount">
\r
7507 Gets the number of input items waiting to be processed by this block.
\r
7508 </summary><remarks>
\r
7509 The InputCount does not include any items currently being processed by the block or any items that
\r
7510 have already been processed by the block.
\r
7513 <member name="P:System.Threading.Tasks.Dataflow.ActionBlock`1.InputCountForDebugger">
\r
7514 <summary>Gets the number of messages waiting to be processed. This must only be used from the debugger.</summary>
\r
7516 <member name="P:System.Threading.Tasks.Dataflow.ActionBlock`1.DebuggerDisplayContent">
\r
7517 <summary>The data to display in the debugger display attribute.</summary>
\r
7519 <member name="P:System.Threading.Tasks.Dataflow.ActionBlock`1.System#Threading#Tasks#Dataflow#Internal#IDebuggerDisplay#Content">
\r
7520 <summary>Gets the data to display in the debugger display attribute for this instance.</summary>
\r
7522 <member name="T:System.Threading.Tasks.Dataflow.ActionBlock`1.DebugView">
\r
7523 <summary>Provides a debugger type proxy for the Call.</summary>
\r
7525 <member name="F:System.Threading.Tasks.Dataflow.ActionBlock`1.DebugView.m_actionBlock">
\r
7526 <summary>The action block being viewed.</summary>
\r
7528 <member name="F:System.Threading.Tasks.Dataflow.ActionBlock`1.DebugView.m_debugInfo">
\r
7529 <summary>The actino block's target being viewed.</summary>
\r
7531 <member name="M:System.Threading.Tasks.Dataflow.ActionBlock`1.DebugView.#ctor(System.Threading.Tasks.Dataflow.ActionBlock{`0})">
\r
7532 <summary>Initializes the debug view.</summary>
\r
7533 <param name="actionBlock">The target being debugged.</param>
\r
7535 <member name="P:System.Threading.Tasks.Dataflow.ActionBlock`1.DebugView.InputQueue">
\r
7536 <summary>Gets the messages waiting to be processed.</summary>
\r
7538 <member name="P:System.Threading.Tasks.Dataflow.ActionBlock`1.DebugView.PostponedMessages">
\r
7539 <summary>Gets any postponed messages.</summary>
\r
7541 <member name="P:System.Threading.Tasks.Dataflow.ActionBlock`1.DebugView.CurrentDegreeOfParallelism">
\r
7542 <summary>Gets the number of oustanding input operations.</summary>
\r
7544 <member name="P:System.Threading.Tasks.Dataflow.ActionBlock`1.DebugView.DataflowBlockOptions">
\r
7545 <summary>Gets the ExecutionDataflowBlockOptions used to configure this block.</summary>
\r
7547 <member name="P:System.Threading.Tasks.Dataflow.ActionBlock`1.DebugView.IsDecliningPermanently">
\r
7548 <summary>Gets whether the block is declining further messages.</summary>
\r
7550 <member name="P:System.Threading.Tasks.Dataflow.ActionBlock`1.DebugView.IsCompleted">
\r
7551 <summary>Gets whether the block is completed.</summary>
\r
7553 <member name="P:System.Threading.Tasks.Dataflow.ActionBlock`1.DebugView.Id">
\r
7554 <summary>Gets the block's Id.</summary>
\r
projects / pithos-ms-client / blob