Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Receive(TOutput) Method (ISourceBlock(TOutput), CancellationToken)

DataflowBlock.Receive<TOutput> Method (ISourceBlock<TOutput>, CancellationToken)

.NET Framework 4.6 and 4.5

Synchronously receives a value from a specified source and provides a token to cancel the operation.

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

public static TOutput Receive<TOutput>(
	this ISourceBlock<TOutput> source,
	CancellationToken cancellationToken
)

Type Parameters

TOutput

The type of data contained in the source.

Parameters

source
Type: System.Threading.Tasks.Dataflow.ISourceBlock<TOutput>

The source from which to receive the value.

cancellationToken
Type: System.Threading.CancellationToken

The token to use to cancel the receive operation.

Return Value

Type: TOutput
The received value.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ISourceBlock<TOutput>. 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).

ExceptionCondition
ArgumentNullException

source is null.

InvalidOperationException

No item could be received from the source.

OperationCanceledException

The operation was canceled before an item was received from the source.

If the source successfully offered an item that was received by this operation, that item is returned even if a concurrent cancellation request occurs.

.NET Framework

Supported in: 4.5

Portable Class Library

Supported in: Portable Class Library
Show:
© 2015 Microsoft