Language

ISourceBlock Interface

Definition

Namespace:
System.Threading.Tasks.Dataflow
Assembly:
System.Threading.Tasks.Dataflow.dll
Package:
System.Threading.Tasks.Dataflow v11.0.0-rc.1.26425.128
Source:
ISourceBlock.cs
Source:
ISourceBlock.cs
Source:
ISourceBlock.cs
Source:
ISourceBlock.cs
Source:
ActionBlock.cs

Represents a dataflow block that is a source of data.

generic 
public interface class ISourceBlock : System::Threading::Tasks::Dataflow::IDataflowBlock
public interface ISourceBlock : System.Threading.Tasks.Dataflow.IDataflowBlock
type ISourceBlock<'Output> = interface
    interface IDataflowBlock
Public Interface ISourceBlock(Of Out TOutput)
Implements IDataflowBlock

Type Parameters

TOutput

Specifies the type of data supplied by the ISourceBlock.

This type parameter is covariant. That is, you can use either the type you specified or any type that is more derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics.
Derived
Implements
IDataflowBlock

Properties

Name Description
Completion

Gets a Task that represents the asynchronous operation and completion of the dataflow block.

(Inherited from IDataflowBlock)

Methods

Name Description
Complete()

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

(Inherited from IDataflowBlock)
ConsumeMessage(DataflowMessageHeader, ITargetBlock, Boolean)

Called by a linked ITargetBlock to accept and consume a DataflowMessageHeader previously offered by this ISourceBlock.
Fault(Exception)

Causes the IDataflowBlock to complete in a Faulted state.

(Inherited from IDataflowBlock)
LinkTo(ITargetBlock, DataflowLinkOptions)

Links the ISourceBlock to the specified ITargetBlock.
ReleaseReservation(DataflowMessageHeader, ITargetBlock)

Called by a linked ITargetBlock to release a previously reserved DataflowMessageHeader by this ISourceBlock.
ReserveMessage(DataflowMessageHeader, ITargetBlock)

Called by a linked ITargetBlock to reserve a previously offered DataflowMessageHeader by this ISourceBlock.

Extension Methods

Name Description
AsObservable(ISourceBlock)

Creates a new IObservable abstraction over the ISourceBlock.
LinkTo(ISourceBlock, ITargetBlock, DataflowLinkOptions, Predicate)

Links the ISourceBlock to the specified ITargetBlock using the specified filter.
LinkTo(ISourceBlock, ITargetBlock, Predicate)

Links the ISourceBlock to the specified ITargetBlock using the specified filter.
LinkTo(ISourceBlock, ITargetBlock)

Links the ISourceBlock to the specified ITargetBlock.
OutputAvailableAsync(ISourceBlock, CancellationToken)

Provides a Task that asynchronously monitors the source for available output.
OutputAvailableAsync(ISourceBlock)

Provides a Task that asynchronously monitors the source for available output.
Receive(ISourceBlock, CancellationToken)

Synchronously receives a value from a specified source and provides a token to cancel the operation.
Receive(ISourceBlock, TimeSpan, CancellationToken)

Synchronously receives a value from a specified source, providing a token to cancel the operation and observing an optional time-out interval.
Receive(ISourceBlock, TimeSpan)

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

Synchronously receives a value from a specified source.
ReceiveAsync(ISourceBlock, CancellationToken)

Asynchronously receives a value from a specified source and provides a token to cancel the operation.
ReceiveAsync(ISourceBlock, TimeSpan, CancellationToken)

Asynchronously receives a value from a specified source, providing a token to cancel the operation and observing an optional time-out interval.
ReceiveAsync(ISourceBlock, TimeSpan)

Asynchronously receives a value from a specified source, observing an optional time-out period.
ReceiveAsync(ISourceBlock)

Asynchronously receives a value from a specified source.

Applies to