IDataflowBlock.Completion Property

.NET Framework 4.5

Gets a Task that represents the asynchronous operation and completion of the dataflow block.

Namespace:  System.Threading.Tasks.Dataflow
Assembly:  System.Threading.Tasks.Dataflow (in System.Threading.Tasks.Dataflow.dll)

Task Completion { get; }

Property Value

Type: System.Threading.Tasks.Task
The task.

A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process any more messages. The returned Task will transition to a completed state when the associated block has completed. It will transition to the TaskStatus RanToCompletion state when the block completes its processing successfully according to the dataflow block’s defined semantics. It will transition to the TaskStatus Faulted state when the dataflow block has completed processing prematurely due to an unhandled exception, and it will transition to the TaskStatus Canceled state when the dataflow block has completed processing prematurely due to receiving a cancellation request. If the task completes in the Faulted state, its Exception property will return an AggregateException containing the one or more exceptions that caused the block to fail.

Portable Class Library

Supported in: Portable Class Library

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft