Export (0) Print
Expand All

DataflowBlock.Receive(TOutput) Method (ISourceBlock(TOutput), TimeSpan)

.NET Framework 4.5

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)

static member Receive : 
        source:ISourceBlock<'TOutput> * 
        timeout:TimeSpan -> 'TOutput 

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.

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.

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
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 a null reference (Nothing in Visual Basic).

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.

.NET Framework

Supported in: 4.5

Portable Class Library

Supported in: Portable Class Library

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.

Show:
© 2014 Microsoft