DataflowBlock::Receive<TOutput> Method (ISourceBlock<TOutput>^, TimeSpan)

Synchronously receives a value from a specified source, observing an optional time-out period.

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

Syntax

public:
generic<typename TOutput>
[ExtensionAttribute]
static TOutput Receive(
	ISourceBlock<TOutput>^ source,
	TimeSpan timeout
)

source: Type: System.Threading.Tasks.Dataflow::ISourceBlock<TOutput>^
The source from which to receive the value.

timeout: Type: System::TimeSpan
The maximum time interval, in milliseconds, to wait for the synchronous operation to complete, or an interval that represents -1 milliseconds to wait indefinitely.

Type: TOutput

The received value.

Exception	Condition
ArgumentOutOfRangeException	timeout is a negative number other than -1 milliseconds, which represents an infinite time-out period. -or- timeout is greater than MaxValue.
ArgumentNullException	source is null.
InvalidOperationException	No item could be received from the source.
TimeoutException	The specified time-out expired 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 time-out occurs.