DataflowBlock.ReceiveAsync<TOutput> Method (ISourceBlock<TOutput>, CancellationToken)
Asynchronously receives a value from a specified source and provides a token to cancel the operation.
Assembly: System.Threading.Tasks.Dataflow (in System.Threading.Tasks.Dataflow.dll)
public static Task<TOutput> ReceiveAsync<TOutput>( this ISourceBlock<TOutput> source, CancellationToken cancellationToken )
Specifies the type of data contained in the source.
- Type: System.Threading.Tasks.Dataflow.ISourceBlock<>
The source from which to receive the value.
- Type: System.Threading.CancellationToken
The token to use to cancel the receive operation.
Return ValueType: System.Threading.Tasks.Task<>
A task that represents the asynchronous receive operation. When a value is successfully received from the source, the returned task is completed and its Result 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 InvalidOperationException exception is thrown in the returned task.
Usage NoteIn Visual Basic and C#, you can call this method as an instance method on any object of type ISourceBlock<>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.
Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.