System.Threading.Tasks.Dataflow
Provides a dataflow block that invokes a provided delegate for every data element received.
The type of data that this operates on.
Initializes a new instance of the class with the specified action.
The action to invoke with each data element received.
is .
Initializes a new instance of the class with the specified action and configuration options.
The action to invoke with each data element received.
The options with which to configure this .
is .
-or-
is .
Initializes a new instance of the class with the specified action.
The action to invoke with each data element received.
is .
Initializes a new instance of the class with the specified action and configuration options.
The action to invoke with each data element received.
The options with which to configure this .
is .
-or-
is .
Signals to the dataflow block that it shouldn't accept or produce any more messages and shouldn't consume any more postponed messages.
Posts an item to the target dataflow block.
The item being offered to the target.
if the item is posted to the dataflow block; otherwise, .
Causes the dataflow block to complete in a faulted state.
The exception that caused the faulting.
is .
Offers a message to the dataflow block, and gives it the opportunity to consume or postpone the message.
The header of the message being offered.
The value of the message being offered.
The dataflow block that is offering the message. This may be .
to instruct the target to call synchronously during the call to , prior to returning , in order to consume the message; otherwise, .
is not valid.
-or- may be only if provided with a non-null .
The status of the offered message. If the message was accepted by the target, is returned, and the source should no longer use the offered message, because it is now owned by the target. If the message was postponed by the target, is returned 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.
If the target would have otherwise postponed message, but source was , is returned.
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, is returned.
If the target chose not to accept the message, is returned. If the target chose not to accept the message and will never accept another message from this source, is returned.
Returns a string that represents the formatted name of this instance.
A string that represents the formatted name of this instance.
Gets a object that represents the asynchronous operation and completion of the dataflow block.
The completed task.
Gets the number of input items waiting to be processed by this block.
The number of input items waiting to be processed by this block.
Provides a dataflow block that batches inputs into arrays.
Specifies the type of data put into batches.
Initializes a new with the specified batch size.
The number of items to group into a batch.
The must be positive.
Initializes a new with the specified batch size, declining option, and block options.
The number of items to group into a batch.
The options with which to configure this .
The must be positive.
-or-
The must be smaller than the value of the option if a non-default value has been set.
The is .
Signals to the that it should not accept nor produce any more messages nor consume any more postponed messages.
Links the to the specified .
The to which to connect this source.
A instance that configures the link.
is null (Nothing in Visual Basic) or is null (Nothing in Visual Basic).
An IDisposable that, upon calling Dispose, will unlink the source from the target.
Causes the to complete in a state.
The that caused the faulting.
The is .
Called by a linked to accept and consume a previously offered by this .
The of the message being consumed.
The consuming the message.
if the message was successfully consumed; otherwise, .
The is not valid.
The is .
The value of the consumed message. This may correspond to a different instance than was previously reserved and passed as the to . The consuming must use the returned value instead of the value passed as messageValue through .
If the message requested is not available, the return value will be .
Called by a linked to release a previously reserved by this .
The of the reserved message being released.
The releasing the message it previously reserved.
The is not valid.
The is .
The did not have the message reserved.
Called by a linked to reserve a previously offered by this .
The of the message being reserved.
The reserving the message.
The is not valid.
The is .
if the message was successfully reserved; otherwise, .
Offers a message to the , giving the target the opportunity to consume or postpone the message.
A instance that represents the header of the message being offered.
The value of the message being offered.
The offering the message. This may be null.
Set to to instruct the target to call synchronously during the call to , prior to returning , in order to consume the message.
The is not valid.
-or- may only be true if provided with a non-null .
The status of the offered message. If the message was accepted by the target, is returned, and the source should no longer use the offered message, because it is now owned by the target. If the message was postponed by the target, is returned 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.
If the target would have otherwise postponed message, but was , is instead returned.
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, is returned.
If the target chose not to accept the message, is returned. If the target chose not to accept the message and will never accept another message from this source, is returned.
Returns a string that represents the formatted name of this instance.
A string that represents the formatted name of this instance.
Triggers the to initiate a batching operation even if the number of currently queued or postponed items is less than the .
Attempts to synchronously receive an available output item from the .
The predicate a value must successfully pass in order for it to be received. may be , in which case all items will pass.
The item received from the source.
if an item could be received; otherwise, .
Attempts to synchronously receive all available items from the .
The items received from the source.
if one or more items could be received; otherwise, .
Gets the size of the batches generated by this .
The batch size.
Gets a that represents the asynchronous operation and completion of the dataflow block.
The task.
Gets the number of output items available to be received from this block.
The number of output items.
Provides a dataflow block that batches a specified number of inputs of potentially differing types provided to one or more of its targets.
Specifies the type of data accepted by the block's first target.
Specifies the type of data accepted by the block's second target.
Initializes a new with the specified configuration.
The number of items to group into a batch.
The must be positive.
Initializes a new with the specified configuration.
The number of items to group into a batch.
The options with which to configure this .
is .
is less than one.
Signals to the that it should not accept nor produce any more messages nor consume any more postponed messages.
Links the to the specified .
The to which to connect this source.
A instance that configures the link.
is (Nothing in Visual Basic) or is (Nothing in Visual Basic).
An IDisposable that, upon calling Dispose, will unlink the source from the target.
Causes the to complete in a state.
The that caused the faulting.
The is .
Passes the ownership of the message identified by the from this instance to the .
The of the message that is to be consumed.
The for which the message is to be consumed.
if the message was successfully consumed. otherwise.
The is not valid.
The is (Nothing in Visual Basic).
The value of the consumed message. This may correspond to a different instance than was previously reserved and passed as the to this method. The consuming must use the returned value instead of the value passed as to . If the message requested is not available, the return value is ( in Visual Basic).
Releases the right to pass the ownership of the message identified by the from this to the .
The of the reserved message.
The that currently holds the reservation.
The is not valid.
The is (Nothing in Visual Basic).
The did not have the message reserved.
Reserves the right to pass the ownership of the message identified by the from this to the .
The of the message that is to be reserved.
The for which the message is to be reserved.
The is not valid.
The is ( in Visual Basic).
if the message was successfully reserved; otherwise, .
Returns a string that represents the formatted name of this instance.
A string that represents the formatted name of this instance.
Attempts to synchronously receive an available output item from the .
The predicate a value must successfully pass in order for it to be received. may be , in which case all items will pass.
The item received from the source.
if an item could be received; otherwise, .
Attempts to synchronously receive all available items from the .
The items received from the source.
if one or more items could be received; otherwise, .
Gets the size of the batches generated by this .
The batch size.
Gets a that represents the asynchronous operation and completion of the dataflow block.
The task.
Gets the number of output items available to be received from this block.
The number of output items.
Gets a target that may be used to offer messages of the first type.
The target.
Gets a target that may be used to offer messages of the second type.
The target.
Provides a dataflow block that batches a specified number of inputs of potentially differing types provided to one or more of its targets.
Specifies the type of data accepted by the block's first target.
Specifies the type of data accepted by the block's second target.
Specifies the type of data accepted by the block's third target.
Initializes a new with the specified configuration.
The number of items to group into a batch.
The must be positive.
Initializes a new with the specified configuration.
The number of items to group into a batch.
The options with which to configure this .
The must be positive.
The is .
Signals to the that it should not accept nor produce any more messages nor consume any more postponed messages.
Links the to the specified .
The to which to connect this source.
if the source should unlink from the target after successfully propagating a single message; to remain connected even after a single message has been propagated.
is (Nothing in Visual Basic) or is (Nothing in Visual Basic).
An IDisposable that, upon calling Dispose, will unlink the source from the target.
Causes the to complete in a state.
The that caused the faulting.
The is .
Passes the ownership of the message identified by the from this instance to the .
The of the message that is to be consumed.
The for which the message is to be consumed.
if the message was successfully consumed. otherwise.
The is not valid.
The is (Nothing in Visual Basic).
The value of the consumed message. This may correspond to a different instance than was previously reserved and passed as the to this method. The consuming must use the returned value instead of the value passed as to . If the message requested is not available, the return value is ( in Visual Basic).
Releases the right to pass the ownership of the message identified by the from this to the .
The of the reserved message.
The that currently holds the reservation.
The is not valid.
The is (Nothing in Visual Basic).
The did not have the message reserved.
Reserves the right to pass the ownership of the message identified by the from this to the .
The of the message that is to be reserved.
The for which the message is to be reserved.
The is not valid.
The is ( in Visual Basic).
if the message was successfully reserved; otherwise, .
Returns a string that represents the formatted name of this instance.
A string that represents the formatted name of this instance.
Attempts to synchronously receive an available output item from the .
The predicate a value must successfully pass in order for it to be received. may be in which case all items will pass.
The item received from the source.
if an item could be received; otherwise, .
Attempts to synchronously receive all available items from the .
The items received from the source.
if one or more items could be received; otherwise, .
Gets the size of the batches generated by this .
The batch size.
Gets a that represents the asynchronous operation and completion of the dataflow block.
The task.
Gets the number of output items available to be received from this block.
The number of output items.
Gets a target that may be used to offer messages of the first type.
The target.
Gets a target that may be used to offer messages of the second type.
The target.
Gets a target that may be used to offer messages of the third type.
The target.
Provides a buffer for storing at most one element at time, overwriting each message with the next as it arrives.
Specifies the type of the data buffered by this dataflow block.
Initializes the with the specified cloning function.
The function to use to clone the data when offered to other blocks.
Initializes the with the specified cloning function and .
The function to use to clone the data when offered to other blocks.
The options with which to configure this .
The is .
Signals to the that it should not accept nor produce any more messages nor consume any more postponed messages.
Links the to the specified .
The to which to connect this source.
A instance that configures the link.
is null (Nothing in Visual Basic) or is null (Nothing in Visual Basic).
An IDisposable that, upon calling Dispose, will unlink the source from the target.
Causes the to complete in a state.
The that caused the faulting.
The is .
Attempts to synchronously receive all available items from the .
The items received from the source.
if one or more items could be received; otherwise, .
Called by a linked to accept and consume a previously offered by this .
The of the message being consumed.
The consuming the message.
if the message was successfully consumed; otherwise, .
The is not valid.
The is .
The value of the consumed message. This may correspond to a different instance than was previously reserved and passed as the to . The consuming must use the returned value instead of the value passed as through .
If the message requested is not available, the return value will be .
Called by a linked to release a previously reserved by this .
The of the reserved message being released.
The releasing the message it previously reserved.
The is not valid.
The is .
The did not have the message reserved.
Called by a linked to reserve a previously offered by this .
The of the message being reserved.
The reserving the message.
The is not valid.
The is .
if the message was successfully reserved; otherwise, .
Offers a message to the , giving the target the opportunity to consume or postpone the message.
A instance that represents the header of the message being offered.
The value of the message being offered.
The offering the message. This may be null.
Set to to instruct the target to call synchronously during the call to , prior to returning , in order to consume the message.
The is not valid.
-or- may only be true if provided with a non-null .
The status of the offered message. If the message was accepted by the target, is returned, and the source should no longer use the offered message, because it is now owned by the target. If the message was postponed by the target, is returned 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.
If the target would have otherwise postponed message, but was , is instead returned.
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, is returned.
If the target chose not to accept the message, is returned. If the target chose not to accept the message and will never accept another message from this source, is returned.
Returns a string that represents the formatted name of this instance.
A string that represents the formatted name of this instance.
Attempts to synchronously receive an available output item from the .
The predicate a value must successfully pass in order for it to be received. may be , in which case all items will pass.
The item received from the source.
if an item could be received; otherwise, .
Gets a that represents the asynchronous operation and completion of the dataflow block.
The task.
Provides a buffer for storing data for a Dataflow.
Specifies the type of the data buffered by this dataflow block.
Initializes a new .
Initializes a new with the specified .
The options with which to configure this .
The is .
Signals to the that it should not accept nor produce any more messages nor consume any more postponed messages.
Links the to the specified .
The to which to connect this source.
A instance that configures the link.
is null (Nothing in Visual Basic) or is null (Nothing in Visual Basic).
An IDisposable that, upon calling Dispose, will unlink the source from the target.
Causes the to complete in a state.
The that caused the faulting.
The is .
Called by a linked to accept and consume a previously offered by this .
The of the message being consumed.
The consuming the message.
if the message was successfully consumed; otherwise, .
The is not valid.
The is .
The value of the consumed message. This may correspond to a different instance than was previously reserved and passed as the to . The consuming must use the returned value instead of the value passed as through .
If the message requested is not available, the return value will be .
Called by a linked to release a previously reserved by this .
The of the reserved message being released.
The releasing the message it previously reserved.
The is not valid.
The is .
The did not have the message reserved.
Called by a linked to reserve a previously offered by this .
The of the message being reserved.
The reserving the message.
The is not valid.
The is .
if the message was successfully reserved; otherwise, .
Offers a message to the , giving the target the opportunity to consume or postpone the message.
A instance that represents the header of the message being offered.
The value of the message being offered.
The offering the message. This may be .
Set to true to instruct the target to call synchronously during the call to , prior to returning , in order to consume the message.
The is not valid.
-or- may only be true if provided with a non-null .
The status of the offered message. If the message was accepted by the target, is returned, and the source should no longer use the offered message, because it is now owned by the target. If the message was postponed by the target, is returned 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.
If the target would have otherwise postponed message, but was , is instead returned.
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, is returned.
If the target chose not to accept the message, is returned. If the target chose not to accept the message and will never accept another message from this source, is returned.
Returns a string that represents the formatted name of this instance.
A string that represents the formatted name of this instance.
Attempts to synchronously receive an available output item from the .
The predicate value must successfully pass in order for it to be received. may be , in which case all items will pass.
The item received from the source.
if an item could be received; otherwise, .
Attempts to synchronously receive all available items from the .
The items received from the source.
if one or more items could be received; otherwise, .
Gets a that represents the asynchronous operation and completion of the dataflow block.
The task.
Gets the number of items currently stored in the buffer.
The number of items.
Provides a set of static (Shared in Visual Basic) methods for working with dataflow blocks.
Creates a new abstraction over the .
The source to wrap.
Specifies the type of data contained in the source.
The is .
An that enables observers to be subscribed to the source.
Creates a new abstraction over the .
The target to wrap.
Specifies the type of input accepted by the target block.
An observer that wraps the target block.
Monitors two dataflow sources, invoking the provided handler for whichever source makes data available first.
The first source.
The handler to execute on data from the first source.
The second source.
The handler to execute on data from the second source.
Specifies type of data contained in the first source.
Specifies type of data contained in the second source.
The is .
-or-
The is .
-or-
The is .
-or-
The is .
A that represents the asynchronous choice. If both sources are completed prior to the choice completing, the resulting task will be canceled. When one of the sources has data available and successfully propagates it to the choice, the resulting task will complete when the handler completes; if the handler throws an exception, the task will end in the state and will contain the unhandled exception. Otherwise, the task will end with its set to either 0 or 1 to represent the first or second source, respectively.
This method will only consume an element from one of the two data sources, never both.
Monitors two dataflow sources, invoking the provided handler for whichever source makes data available first.
The first source.
The handler to execute on data from the first source.
The second source.
The handler to execute on data from the second source.
The options with which to configure this choice.
Specifies type of data contained in the first source.
Specifies type of data contained in the second source.
The is .
-or-
The is .
-or-
The is .
-or-
The is .
-or-
The is .
A that represents the asynchronous choice. If both sources are completed prior to the choice completing, or if the provided as part of is canceled prior to the choice completing, the resulting task will be canceled. When one of the sources has data available and successfully propagates it to the choice, the resulting task will complete when the handler completes; if the handler throws an exception, the task will end in the state and will contain the unhandled exception. Otherwise, the task will end with its set to either 0 or 1 to represent the first or second source, respectively.
Monitors three dataflow sources, invoking the provided handler for whichever source makes data available first.
The first source.
The handler to execute on data from the first source.
The second source.
The handler to execute on data from the second source.
The third source.
The handler to execute on data from the third source.
Specifies type of data contained in the first source.
Specifies type of data contained in the second source.
Specifies type of data contained in the third source.
The is .
-or-
The is .
-or-
The is .
-or-
The is .
-or-
The is .
-or-
The is .
A that represents the asynchronous choice. If all sources are completed prior to the choice completing, the resulting task will be canceled. When one of the sources has data available and successfully propagates it to the choice, the resulting task will complete when the handler completes; if the handler throws an exception, the task will end in the state and will contain the unhandled exception. Otherwise, the task will end with its set to the 0-based index of the source.
This method will only consume an element from one of the data sources, never more than one.
Monitors three dataflow sources, invoking the provided handler for whichever source makes data available first.
The first source.
The handler to execute on data from the first source.
The second source.
The handler to execute on data from the second source.
The third source.
The handler to execute on data from the third source.
The options with which to configure this choice.
Specifies type of data contained in the first source.
Specifies type of data contained in the second source.
Specifies type of data contained in the third source.
The is .
-or-
The is .
-or-
The is .
-or-
The is .
-or-
The is .
-or-
The is .
-or-
The is .
A that represents the asynchronous choice. If all sources are completed prior to the choice completing, or if the provided as part of is canceled prior to the choice completing, the resulting task will be canceled. When one of the sources has data available and successfully propagates it to the choice, the resulting task will complete when the handler completes; if the handler throws an exception, the task will end in the state and will contain the unhandled exception. Otherwise, the task will end with its set to the 0-based index of the source.
This method will only consume an element from one of the data sources, never more than one. If cancellation is requested after an element has been received, the cancellation request will be ignored, and the relevant handler will be allowed to execute.
Encapsulates a target and a source into a single propagator.
The target to encapsulate.
The source to encapsulate.
Specifies the type of input expected by the target.
Specifies the type of output produced by the source.
The encapsulated target and source.
Links the to the specified .
The source from which to link.
The to which to connect the source.
Specifies the type of data contained in the source.
The is .
-or-
The is .
An that, upon calling , will unlink the source from the target.
Links the to the specified using the specified filter.
The source from which to link.
The to which to connect the source.
The filter a message must pass in order for it to propagate from the source to the target.
Specifies the type of data contained in the source.
The is .
-or-
The is .
-or-
The is .
An that, upon calling , will unlink the source from the target.
Links the to the specified using the specified filter.
The source from which to link.
The to which to connect the source.
One of the enumeration values that specifies how to configure a link between dataflow blocks.
The filter a message must pass in order for it to propagate from the source to the target.
Specifies the type of data contained in the source.
The is null (Nothing in Visual Basic).
-or-
The is null (Nothing in Visual Basic).
-or-
The is null (Nothing in Visual Basic).
-or-
The is null (Nothing in Visual Basic).
An that, upon calling , will unlink the source from the target.
Gets a target block that synchronously accepts all messages offered to it and drops them.
The type of the messages this block can accept.
A that accepts and subsequently drops all offered messages.
Provides a that asynchronously monitors the source for available output.
The source to monitor.
Specifies the type of data contained in the source.
A that informs of whether and when more output is available. If, when the task completes, its is , more output is available in the source (though another consumer of the source may retrieve the data).
If it returns , more output is not and will never be available, due to the source completing prior to output being available.
Provides a that asynchronously monitors the source for available output.
The source to monitor.
The cancellation token with which to cancel the asynchronous operation.
Specifies the type of data contained in the source.
A that informs of whether and when more output is available. If, when the task completes, its is , more output is available in the source (though another consumer of the source may retrieve the data). If it returns , more output is not and will never be available, due to the source completing prior to output being available.
Posts an item to the .
The target block.
The item being offered to the target.
Specifies the type of data accepted by the target block.
if the item was accepted by the target block; otherwise, .
Synchronously receives a value from a specified source.
The source from which to receive the value.
The type of data contained in the source.
is .
No item could be received from the source.
The received value.
Synchronously receives a value from a specified source and provides a token to cancel the operation.
The source from which to receive the value.
The token to use to cancel the receive operation.
The type of data contained in the source.
is .
No item could be received from the source.
The operation was canceled before an item was received from the source.
The received value.
Synchronously receives a value from a specified source, observing an optional time-out period.
The source from which to receive the value.
The maximum time interval, in milliseconds, to wait for the synchronous operation to complete, or an interval that represents -1 milliseconds to wait indefinitely.
The type of data contained in the source.
is a negative number other than -1 milliseconds, which represents an infinite time-out period.
-or-
is greater than Int32.MaxValue.
is .
No item could be received from the source.
The specified time-out expired before an item was received from the source.
The received value.
Synchronously receives a value from a specified source, providing a token to cancel the operation and observing an optional time-out interval.
The source from which to receive the value.
The maximum time interval, in milliseconds, to wait for the synchronous operation to complete, or an interval that represents -1 milliseconds to wait indefinitely.
The token to use to cancel the receive operation.
The type of data contained in the source.
The is .
is a negative number other than -1 milliseconds, which represents an infinite time-out period.
-or-
is greater than Int32.MaxValue.
No item could be received from the source.
The specified time-out expired before an item was received from the source.
The operation was canceled before an item was received from the source.
The received value.
Creates an that enables receiving all of the data from the source.
The source from which to asynchronously receive.
The that can be used to cancel the receive operation.
Specifies the type of data contained in the source.
The is .
The created async enumerable.
Asynchronously receives a value from a specified source.
The source from which to receive the value.
The type of data contained in the source.
is .
A task that represents the asynchronous receive operation. When an item value is successfully received from the source, the returned task is completed and its returns the received value. If an item value cannot be retrieved because the source is empty and completed , an exception is thrown in the returned task.
Asynchronously receives a value from a specified source and provides a token to cancel the operation.
The source from which to receive the value.
The token to use to cancel the receive operation.
Specifies the type of data contained in the source.
is .
A task that represents the asynchronous receive operation. When a value is successfully received from the source, the returned task is completed and its returns the value. If a value cannot be retrieved because cancellation was requested, the returned task is canceled. If the value cannot be retrieved because the source is empty and completed , an exception is thrown in the returned task.
Asynchronously receives a value from a specified source, observing an optional time-out period.
The source from which to receive the value.
The maximum time interval, in milliseconds, to wait for the synchronous operation to complete, or an interval that represents -1 milliseconds to wait indefinitely.
The type of data contained in the source.
is .
is a negative number other than -1 milliseconds, which represents an infinite time-out period.
-or-
is greater than Int32.MaxValue.
A task that represents the asynchronous receive operation. When a value is successfully received from the source, the returned task is completed and its returns the value. If a value cannot be retrieved because the time-out expired, the returned task is canceled. If the value cannot be retrieved because the source is empty and completed , an exception is thrown in the returned task.
Asynchronously receives a value from a specified source, providing a token to cancel the operation and observing an optional time-out interval.
The source from which to receive the value.
The maximum time interval, in milliseconds, to wait for the synchronous operation to complete, or an interval that represents -1 milliseconds to wait indefinitely.
The token which may be used to cancel the receive operation.
The type of data contained in the source.
is .
is a negative number other than -1 milliseconds, which represents an infinite time-out period.
-or-
is greater than Int32.MaxValue.
A task that represents the asynchronous receive operation. When a value is successfully received from the source, the returned task is completed and its returns the value. If a value cannot be retrieved because the time-out expired or cancellation was requested, the returned task is canceled. If the value cannot be retrieved because the source is empty and completed, an exception is thrown in the returned task.
Asynchronously offers a message to the target message block, allowing for postponement.
The target to which to post the data.
The item being offered to the target.
Specifies the type of the data to post to the target.
The is .
A that represents the asynchronous send. If the target accepts and consumes the offered element during the call to , upon return from the call the resulting will be completed and its property will return . If the target declines the offered element during the call, upon return from the call the resulting will be completed and its property will return . If the target postpones the offered element, the element will be buffered until such time that the target consumes or releases it, at which point the task will complete, with its indicating whether the message was consumed. If the target never attempts to consume or release the message, the returned task will never complete.
Asynchronously offers a message to the target message block, allowing for postponement.
The target to which to post the data.
The item being offered to the target.
The cancellation token with which to request cancellation of the send operation.
Specifies the type of the data to post to the target.
The is null (Nothing in Visual Basic).
A that represents the asynchronous send. If the target accepts and consumes the offered element during the call to SendAsync, upon return from the call the resulting will be completed and its Result property will return true. If the target declines the offered element during the call, upon return from the call the resulting will be completed and its Result property will return false. If the target postpones the offered element, the element will be buffered until such time that the target consumes or releases it, at which point the Task will complete, with its Result indicating whether the message was consumed. If the target never attempts to consume or release the message, the returned task will never complete.
If cancellation is requested before the target has successfully consumed the sent data, the returned task will complete in the Canceled state and the data will no longer be available to the target.
Attempts to synchronously receive an item from the .
The source from which to receive.
The item received from the source.
Specifies the type of data contained in the source.
if an item could be received; otherwise, .
Provides options used to configure the processing performed by dataflow blocks.
A constant used to specify an unlimited quantity for members that provide an upper bound. This field is constant.
Initializes a new .
Gets or sets the maximum number of messages that may be buffered by the block.
The maximum number of messages. The default is -1, which indicates an unlimited number of messages.
Gets or sets the to monitor for cancellation requests.
The token.
Gets or sets a value that indicates whether ordered processing should be enforced on a block's handling of messages.
if ordered processing should be enforced; otherwise, . The default value is .
Gets or sets the maximum number of messages that may be processed per task.
The maximum number of messages. The default is -1, which indicates an unlimited number of messages.
Gets or sets the format string to use when a block is queried for its name.
The format string to use when a block is queried for its name.
Gets or sets the to use for scheduling tasks.
The task scheduler.
Provides options used to configure a link between dataflow blocks.
Initializes the .
Gets or sets whether the link should be appended to the source's list of links, or whether it should be prepended.
Returns .
Gets or sets the maximum number of messages that may be consumed across the link.
Returns .
Gets or sets whether the linked target will have completion and faulting notification propagated to it automatically.
Returns .
Provides a container of data attributes for passing between dataflow blocks.
Initializes a new with the specified attributes.
The ID of the message. Must be unique within the originating source block. It does not need to be globally unique.
Checks boxed instances for equality by ID.
A boxed instance.
if the instances are equal; otherwise, .
Checks two instances for equality by ID without boxing.
Another instance.
if the instances are equal; otherwise, .
Generates a hash code for the instance.
The hash code.
Checks two instances for equality by ID.
A instance.
A instance.
if the instances are equal; otherwise, .
Checks two instances for non-equality by ID.
A instance.
A instance.
if the instances are not equal; otherwise, .
Gets the ID of the message within the source.
The ID contained in the instance.
Gets the validity of the message.
if the ID of the message is different from 0. if the ID of the message is 0.
Represents the status of a when passed between dataflow blocks.
Indicates that the accepted the message. Once a target has accepted a message, it is wholly owned by the target.
Indicates that the declined the message. The still owns the message.
Indicates that the declined the message. The still owns the message.
Additionally, the will decline all future messages sent by the source.
Indicates that the tried to accept the message from the , but the message was no longer available.
Indicates that the postponed the message for potential consumption at a later time.
The still owns the message.
Provides options used to configure the processing performed by dataflow blocks that process each message through the invocation of a user-provided delegate. These are dataflow blocks such as and .
Initializes a new .
Gets the maximum number of messages that may be processed by the block concurrently.
The maximum number of messages.
Gets whether code using the dataflow block is constrained to one producer at a time.
Returns .
Provides options used to configure the processing performed by dataflow blocks that group together multiple messages. These are dataflow blocks such as and .
Initializes a new .
Gets or sets the Boolean value to use to determine whether to greedily consume offered messages.
to greedily consume offered messages; otherwise, .
Gets or sets the maximum number of groups that should be generated by the block.
The maximum number of groups.
Represents a dataflow block.
Signals to the that it should not accept nor produce any more messages nor consume any more postponed messages.
Causes the to complete in a state.
The that caused the faulting.
The is .
Gets a that represents the asynchronous operation and completion of the dataflow block.
The task.
Represents a dataflow block that is both a target for data and a source of data.
Specifies the type of data accepted by the .
Specifies the type of data supplied by the .
Represents a dataflow block that supports receiving messages without linking.
Specifies the type of data supplied by the .
Attempts to synchronously receive an available output item from the .
The predicate value must successfully pass in order for it to be received. may be , in which case all items will pass.
The item received from the source.
if an item could be received; otherwise, .
Attempts to synchronously receive all available items from the .
The items received from the source.
if one or more items could be received; otherwise, .
Represents a dataflow block that is a source of data.
Specifies the type of data supplied by the .
Called by a linked to accept and consume a previously offered by this .
The of the message being consumed.
The consuming the message.
if the message was successfully consumed; otherwise, .
The messageHeader is not valid.
The target is .
The value of the consumed message. This may correspond to a different instance than was previously reserved and passed as the to . The consuming must use the returned value instead of the value passed as through .
If the message requested is not available, the return value will be null.
Links the to the specified .
The to which to connect this source.
A instance that configures the link.
is null (Nothing in Visual Basic) or is null (Nothing in Visual Basic).
An IDisposable that, upon calling Dispose, will unlink the source from the target.
Called by a linked to release a previously reserved by this .
The of the reserved message being released.
The releasing the message it previously reserved.
The is not valid.
The is .
The did not have the message reserved.
Called by a linked to reserve a previously offered by this .
The of the message being reserved.
The reserving the message.
The is not valid.
The is .
if the message was successfully reserved; otherwise, .
Represents a dataflow block that is a target for data.
Specifies the type of data accepted by the .
Offers a message to the , giving the target the opportunity to consume or postpone the message.
A instance that represents the header of the message being offered.
The value of the message being offered.
The offering the message. This may be null.
Set to to instruct the target to call synchronously during the call to , prior to returning , in order to consume the message.
The is not valid.
-or- may only be true if provided with a non-null .
The status of the offered message. If the message was accepted by the target, is returned, and the source should no longer use the offered message, because it is now owned by the target. If the message was postponed by the target, is returned 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.
If the target would have otherwise postponed message, but source was , is instead returned.
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, is returned.
If the target chose not to accept the message, is returned. If the target chose not to accept the message and will never accept another message from this source, is returned.
Provides a dataflow block that joins across multiple dataflow sources, not necessarily of the same type, waiting for one item to arrive for each type before they're all released together as a tuple consisting of one item per type.
Specifies the type of data accepted by the block's first target.
Specifies the type of data accepted by the block's second target.
Initializes a new .
Initializes a new .
The options with which to configure this .
The is .
Signals to the that it should not accept nor produce any more messages nor consume any more postponed messages.
Links the to the specified .
Links the to the specified .
A instance that configures the link.
is (Nothing in Visual Basic) or is (Nothing in Visual Basic).
An IDisposable that, upon calling Dispose, will unlink the source from the target.
Causes the to complete in a state.
The that caused the faulting.
The is .
Passes the ownership of the message identified by the from this instance to the .
The of the message that is to be consumed.
The for which the message is to be consumed.
if the message was successfully consumed. otherwise.
The is not valid.
The is (Nothing in Visual Basic).
The value of the consumed message. This may correspond to a different instance than was previously reserved and passed as the to this method. The consuming must use the returned value instead of the value passed as to . If the message requested is not available, the return value is ( in Visual Basic).
Releases the right to pass the ownership of the message identified by the from this to the .
The of the reserved message.
The that currently holds the reservation.
The is not valid.
The is (Nothing in Visual Basic).
The did not have the message reserved.
Reserves the right to pass the ownership of the message identified by the from this to the .
The of the message that is to be reserved.
The for which the message is to be reserved.
The is not valid.
The is (Nothing in Visual Basic).
if the message was successfully reserved; otherwise, .
Returns a string that represents the formatted name of this instance.
A string that represents the formatted name of this instance.
Attempts to synchronously receive an available output item from the .
The predicate value must successfully pass in order for it to be received. may be , in which case all items will pass.
The item received from the source.
if an item could be received; otherwise, .
Attempts to synchronously receive all available items from the .
The items received from the source.
if one or more items could be received; otherwise, .
Gets a that represents the asynchronous operation and completion of the dataflow block.
The task.
Gets the number of output items available to be received from this block.
The number of output items.
Gets a target that may be used to offer messages of the first type.
The target.
Gets a target that may be used to offer messages of the second type.
The target.
Provides a dataflow block that joins across multiple dataflow sources, which are not necessarily of the same type, waiting for one item to arrive for each type before they're all released together as a tuple that contains one item per type.
Specifies the type of data accepted by the block's first target.
Specifies the type of data accepted by the block's second target.
Specifies the type of data accepted by the block's third target.
Initializes a new .
Initializes a new .
The options with which to configure this .
The is .
Signals to the that it should not accept nor produce any more messages nor consume any more postponed messages.
Links the source block to the specified target block.
The target block to which to connect this source.
An object that configures the link.
is .
-or-
is .
A disposable object that unlinks the source from the target when its method is called.
Causes the to complete in a state.
The that caused the faulting.
The is .
Passes the ownership of the message identified by the from this instance to the .
The of the message that is to be consumed.
The for which the message is to be consumed.
if the message was successfully consumed. otherwise.
The is not valid.
The is (Nothing in Visual Basic).
The value of the consumed message. This may correspond to a different instance than was previously reserved and passed as the to this method. The consuming must use the returned value instead of the value passed as to . If the message requested is not available, the return value is ( in Visual Basic).
Releases the right to pass the ownership of the message identified by the from this to the .
The of the reserved message.
The that currently holds the reservation.
The is not valid.
The is (Nothing in Visual Basic).
The did not have the message reserved.
Reserves the right to pass the ownership of the message identified by the from this to the .
The of the message that is to be reserved.
The for which the message is to be reserved.
The is not valid.
The is (Nothing in Visual Basic).
if the message was successfully reserved; otherwise, .
Returns a string that represents the formatted name of this instance.
A string that represents the formatted name of this instance.
Attempts to synchronously receive an available output item from the .
The predicate value must successfully pass in order for it to be received. may be , in which case all items will pass.
The item received from the source.
if an item could be received; otherwise, .
Attempts to synchronously receive all available items from the .
The items received from the source.
if one or more items could be received; otherwise, .
Gets a that represents the asynchronous operation and completion of the dataflow block.
The task.
Gets the number of output items available to be received from this block.
The number of output items.
Gets a target that may be used to offer messages of the first type.
The target.
Gets a target that may be used to offer messages of the second type.
The target.
Gets a target that may be used to offer messages of the third type.
The target.
Provides a dataflow block that invokes a provided delegate for every data element received.
Specifies the type of data received and operated on by this .
Specifies the type of data output by this .
Initializes a new with the specified .
The function to invoke with each data element received.
The is .
Initializes a new with the specified and .
The function to invoke with each data element received.
The options with which to configure this .
The is .
-or-
The is .
Initializes a new with the specified .
The function to invoke with each data element received.
The is .
Initializes a new with the specified and .
The function to invoke with each data element received.
The options with which to configure this .
The is .
-or-
The is .
Signals to the that it should not accept nor produce any more messages nor consume any more postponed messages.
Links the to the specified .
The to which to connect this source.
A instance that configures the link.
is null (Nothing in Visual Basic) or is null (Nothing in Visual Basic).
An IDisposable that, upon calling Dispose, will unlink the source from the target.
Causes the to complete in a state.
The that caused the faulting.
The is .
Called by a linked to accept and consume a previously offered by this .
The of the message being consumed.
The consuming the message.
if the message was successfully consumed; otherwise, .
The is not valid.
The is .
The value of the consumed message. This may correspond to a different instance than was previously reserved and passed as the to . The consuming must use the returned value instead of the value passed as through .
If the message requested is not available, the return value will be .
Called by a linked to release a previously reserved by this .
The of the reserved message being released.
The releasing the message it previously reserved.
The is not valid.
The is .
The did not have the message reserved.
Called by a linked to reserve a previously offered by this .
The of the message being reserved.
The reserving the message.
The is not valid.
The is .
if the message was successfully reserved; otherwise, .
Offers a message to the , giving the target the opportunity to consume or postpone the message.
A instance that represents the header of the message being offered.
The value of the message being offered.
The offering the message. This may be .
if the target must call synchronously during the call to , prior to returning , in order to consume the message.
The is not valid.
-or- may only be true if provided with a non-null .
The status of the offered message. If the message was accepted by the target, is returned, and the source should no longer use the offered message, because it is now owned by the target. If the message was postponed by the target, is returned 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.
If the target would have otherwise postponed but source was , is instead returned.
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, is returned.
If the target chose not to accept the message, is returned. If the target chose not to accept the message and will never accept another message from this source, is returned.
Returns a string that represents the formatted name of this instance.
A string that represents the formatted name of this instance.
Attempts to synchronously receive an available output item from the .
The predicate value must successfully pass in order for it to be received. may be , in which case all items will pass.
The item received from the source.
if an item could be received; otherwise, .
Attempts to synchronously receive all available items from the .
The items received from the source.
if one or more items could be received; otherwise, .
Gets a that represents the asynchronous operation and completion of the dataflow block.
The task.
Gets the number of input items waiting to be processed by this block.
The number of input items.
Gets the number of output items available to be received from this block.
The number of output items.
Provides a dataflow block that invokes a provided delegate for every data element received.
Specifies the type of data received and operated on by this .
Specifies the type of data output by this .
Initializes the with the specified function.
The function to invoke with each data element received. All of the data from the returned will be made available as output from this .
The is .
Initializes the with the specified function and .
The function to invoke with each data element received. All of the data from the returned will be made available as output from this .
The options with which to configure this .
The or is .
Initializes a new with the specified function.
The function to invoke with each data element received. All of the data from the returned will be made available as output from this .
The is .
Initializes a new with the specified function and .
The function to invoke with each data element received. All of the data from the returned in the will be made available as output from this .
The options with which to configure this .
The is .
-or-
The is .
Initializes a new with the specified function.
The function to invoke with each data element received. All of the data asynchronously returned in the will be made available as output from this .
The is .
Initializes a new with the specified function and .
The function to invoke with each data element received. All of the data asynchronously returned in the will be made available as output from this .
The options with which to configure this .
The is .
-or-
The is .
Signals to the that it should not accept nor produce any more messages nor consume any more postponed messages.
Links the to the specified .
The to which to connect this source.
A instance that configures the link.
is null (Nothing in Visual Basic) or is null (Nothing in Visual Basic).
An IDisposable that, upon calling Dispose, will unlink the source from the target.
Causes the to complete in a state.
The that caused the faulting.
The is .
Called by a linked to accept and consume a previously offered by this .
The of the message being consumed.
The consuming the message.
if the message was successfully consumed; otherwise, .
The is not valid.
The is .
The value of the consumed message. This may correspond to a different instance than was previously reserved and passed as the to . The consuming must use the returned value instead of the value passed as through OfferMessage
If the message requested is not available, the return value will be .
Called by a linked to release a previously reserved by this .
The of the reserved message being released.
The releasing the message it previously reserved.
The is not valid.
The is .
The did not have the message reserved.
Called by a linked to reserve a previously offered by this .
The of the message being reserved.
The reserving the message.
The is not valid.
The is .
if the message was successfully reserved; otherwise, .
Offers a message to the , giving the target the opportunity to consume or postpone the message.
A instance that represents the header of the message being offered.
The value of the message being offered.
The offering the message. This may be .
if the target must call synchronously during the call to , prior to returning , in order to consume the message.
The is not valid.
-or-
may only be true if provided with a non-null .
The status of the offered message. If the message was accepted by the target, is returned, and the source should no longer use the offered message, as it is now owned by the target. If the message was postponed by the target, is returned 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.
If the target would have otherwise postponed but source was , is instead returned.
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, is returned.
If the target chose not to accept the message, is returned. If the target chose not to accept the message and will never accept another message from this source, is returned.
Returns a string that represents the formatted name of this instance.
A string that represents the formatted name of this instance.
Attempts to synchronously receive an available output item from the .
The predicate value must successfully pass in order for it to be received. may be , in which case all items will pass.
The item received from the source.
if an item could be received; otherwise, .
Attempts to synchronously receive all available items from the .
The items received from the source.
if one or more items could be received; otherwise, .
Gets a that represents the asynchronous operation and completion of the dataflow block.
The task.
Gets the number of input items waiting to be processed by this block.
The number of input items.
Gets the number of output items available to be received from this block.
The number of output items.
Provides a buffer for receiving and storing at most one element in a network of dataflow blocks.
Specifies the type of the data buffered by this dataflow block.
Initializes a new .
The function to use to clone the data when offered to other blocks.
Initializes a new with the specified .
The function to use to clone the data when offered to other blocks.
The options with which to configure this .
The is .
Signals to the that it should not accept nor produce any more messages nor consume any more postponed messages.
Links the to the specified .
The to which to connect this source.
A instance that configures the link.
is null (Nothing in Visual Basic) or is null (Nothing in Visual Basic).
An IDisposable that, upon calling Dispose, will unlink the source from the target.
Causes the to complete in a state.
The that caused the faulting.
The is .
Attempts to synchronously receive all available items from the .
The items received from the source.
if one or more items could be received; otherwise, .
Called by a linked to accept and consume a previously offered by this .
The of the message being consumed.
The consuming the message.
if the message was successfully consumed; otherwise, .
The is not valid.
The is .
The value of the consumed message. This may correspond to a different instance than was previously reserved and passed as the to . The consuming must use the returned value instead of the value passed as through .
If the message requested is not available, the return value will be .
Called by a linked to release a previously reserved by this .
The of the reserved message being released.
The releasing the message it previously reserved.
The is not valid.
The is .
The did not have the message reserved.
Called by a linked to reserve a previously offered by this .
The of the message being reserved.
The reserving the message.
The is not valid.
The is .
if the message was successfully reserved; otherwise, .
Offers a message to the , giving the target the opportunity to consume or postpone the message.
A instance that represents the header of the message being offered.
The value of the message being offered.
The offering the message. This may be .
Set to to instruct the target to call synchronously during the call to , prior to returning , in order to consume the message.
The is not valid.
-or- may only be true if provided with a non-null .
The status of the offered message. If the message was accepted by the target, is returned, and the source should no longer use the offered message, because it is now owned by the target. If the message was postponed by the target, is returned 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.
If the target would have otherwise postponed message, but was , is instead returned.
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, is returned.
If the target chose not to accept the message, is returned. If the target chose not to accept the message and will never accept another message from this source, is returned.
Returns a string that represents the formatted name of this instance.
A string that represents the formatted name of this instance.
Attempts to synchronously receive an available output item from the .
The predicate value must successfully pass in order for it to be received. may be , in which case all items will pass.
The item received from the source.
if an item could be received; otherwise, .
Gets a that represents the asynchronous operation and completion of the dataflow block.
The task.