ISourceBlock<TOutput> Interface

 

Represents a dataflow block that is a source of data.

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

generic<typename TOutput>
public interface class ISourceBlock : IDataflowBlock

Type Parameters

outTOutput

Specifies the type of data supplied by the ISourceBlock<TOutput>.

NameDescription
System_CAPS_pubpropertyCompletion

Gets a Task that represents the asynchronous operation and completion of the dataflow block.(Inherited from IDataflowBlock.)

NameDescription
System_CAPS_pubmethodComplete()

Signals to the IDataflowBlock that it should not accept nor produce any more messages nor consume any more postponed messages.(Inherited from IDataflowBlock.)

System_CAPS_pubmethodConsumeMessage(DataflowMessageHeader, ITargetBlock<TOutput>^, Boolean)

Called by a linked ITargetBlock<TInput> to accept and consume a T:System.Threading.Tasks.Dataflow.DataflowMessageHeader previously offered by this ISourceBlock<TOutput>.

System_CAPS_pubmethodFault(Exception^)

Causes the IDataflowBlock to complete in a Faulted state.(Inherited from IDataflowBlock.)

System_CAPS_pubmethodLinkTo(ITargetBlock<TOutput>^, DataflowLinkOptions^)

Links the ISourceBlock<TOutput> to the specified ITargetBlock<TInput>.

System_CAPS_pubmethodReleaseReservation(DataflowMessageHeader, ITargetBlock<TOutput>^)

Called by a linked ITargetBlock<TInput> to release a previously reserved DataflowMessageHeader by this ISourceBlock<TOutput>.

System_CAPS_pubmethodReserveMessage(DataflowMessageHeader, ITargetBlock<TOutput>^)

Called by a linked ITargetBlock<TInput> to reserve a previously offered DataflowMessageHeader by this ISourceBlock<TOutput>.

NameDescription
System_CAPS_pubmethodAsObservable<TOutput>()

Creates a new IObservable<T> abstraction over the ISourceBlock<TOutput>.(Defined by DataflowBlock.)

System_CAPS_pubmethodLinkTo<TOutput>(ITargetBlock<TOutput>^)

Overloaded. Links the ISourceBlock<TOutput> to the specified ITargetBlock<TInput>. (Defined by DataflowBlock.)

System_CAPS_pubmethodLinkTo<TOutput>(ITargetBlock<TOutput>^, DataflowLinkOptions^, Predicate<TOutput>^)

Overloaded. Links the ISourceBlock<TOutput> to the specified ITargetBlock<TInput> using the specified filter. (Defined by DataflowBlock.)

System_CAPS_pubmethodLinkTo<TOutput>(ITargetBlock<TOutput>^, Predicate<TOutput>^)

Overloaded. Links the ISourceBlock<TOutput> to the specified ITargetBlock<TInput> using the specified filter. (Defined by DataflowBlock.)

System_CAPS_pubmethodOutputAvailableAsync<TOutput>()

Overloaded. Provides a Task<TResult> that asynchronously monitors the source for available output.(Defined by DataflowBlock.)

System_CAPS_pubmethodOutputAvailableAsync<TOutput>(CancellationToken)

Overloaded. Provides a Task<TResult> that asynchronously monitors the source for available output. (Defined by DataflowBlock.)

System_CAPS_pubmethodReceive<TOutput>()

Overloaded. Synchronously receives a value from a specified source.(Defined by DataflowBlock.)

System_CAPS_pubmethodReceive<TOutput>(CancellationToken)

Overloaded. Synchronously receives a value from a specified source and provides a token to cancel the operation. (Defined by DataflowBlock.)

System_CAPS_pubmethodReceive<TOutput>(TimeSpan)

Overloaded. Synchronously receives a value from a specified source, observing an optional time-out period.(Defined by DataflowBlock.)

System_CAPS_pubmethodReceive<TOutput>(TimeSpan, CancellationToken)

Overloaded. Synchronously receives a value from a specified source, providing a token to cancel the operation and observing an optional time-out interval. (Defined by DataflowBlock.)

System_CAPS_pubmethodReceiveAsync<TOutput>()

Overloaded. Asynchronously receives a value from a specified source.(Defined by DataflowBlock.)

System_CAPS_pubmethodReceiveAsync<TOutput>(CancellationToken)

Overloaded. Asynchronously receives a value from a specified source and provides a token to cancel the operation. (Defined by DataflowBlock.)

System_CAPS_pubmethodReceiveAsync<TOutput>(TimeSpan)

Overloaded. Asynchronously receives a value from a specified source, observing an optional time-out period.(Defined by DataflowBlock.)

System_CAPS_pubmethodReceiveAsync<TOutput>(TimeSpan, CancellationToken)

Overloaded. Asynchronously receives a value from a specified source, providing a token to cancel the operation and observing an optional time-out interval. (Defined by DataflowBlock.)

System_CAPS_noteNote

The TPL Dataflow Library (System.Threading.Tasks.Dataflow namespace) is not distributed with the net_v45. To install the System.Threading.Tasks.Dataflow namespace, open your project in vs_dev11_long, choose Manage NuGet Packages from the Project menu, and search online for the Microsoft.Tpl.Dataflow package.

Return to top
Show: