BroadcastBlock Class

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:: BroadcastBlock.cs

Source:: BroadcastBlock.cs

Source:: BroadcastBlock.cs

Source:: BroadcastBlock.cs

Source:: BroadcastBlock.cs

Source:: BroadcastBlock.cs

Source:: BroadcastBlock.cs

Source:: BroadcastBlock.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides a buffer for storing at most one element at time, overwriting each message with the next as it arrives.

generic 
public ref class BroadcastBlock sealed : System::Threading::Tasks::Dataflow::IPropagatorBlock, System::Threading::Tasks::Dataflow::IReceivableSourceBlock, System::Threading::Tasks::Dataflow::ISourceBlock, System::Threading::Tasks::Dataflow::ITargetBlock

public sealed class BroadcastBlock : System.Threading.Tasks.Dataflow.IPropagatorBlock, System.Threading.Tasks.Dataflow.IReceivableSourceBlock, System.Threading.Tasks.Dataflow.ISourceBlock, System.Threading.Tasks.Dataflow.ITargetBlock

type BroadcastBlock<'T> = class
    interface IPropagatorBlock<'T, 'T>
    interface ITargetBlock<'T>
    interface IDataflowBlock
    interface ISourceBlock<'T>
    interface IReceivableSourceBlock<'T>

type BroadcastBlock<'T> = class
    interface IDataflowBlock
    interface IPropagatorBlock<'T, 'T>
    interface ISourceBlock<'T>
    interface ITargetBlock<'T>
    interface IReceivableSourceBlock<'T>

Public NotInheritable Class BroadcastBlock(Of T)
Implements IPropagatorBlock(Of T, T), IReceivableSourceBlock(Of T), ISourceBlock(Of T), ITargetBlock(Of T)

Type Parameters

T

Specifies the type of the data buffered by this dataflow block.

Inheritance: Object
BroadcastBlock

Implements: IDataflowBlock IPropagatorBlock IReceivableSourceBlock ISourceBlock ISourceBlock ITargetBlock ITargetBlock

Remarks

BroadcastBlock exposes at most one element at a time. However, unlike WriteOnceBlock, that element will be overwritten as new elements are provided to the block. BroadcastBlock ensures that the current element is broadcast to any linked targets before allowing the element to be overwritten.

Constructors

Name	Description
BroadcastBlock(Func, DataflowBlockOptions)	Initializes the BroadcastBlock with the specified cloning function and DataflowBlockOptions.
BroadcastBlock(Func)	Initializes the BroadcastBlock with the specified cloning function.

Properties

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

Methods

Name	Description
Complete()	Signals to the IDataflowBlock that it should not accept nor produce any more messages nor consume any more postponed messages.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
LinkTo(ITargetBlock, DataflowLinkOptions)	Links the ISourceBlock to the specified ITargetBlock.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the formatted name of this IDataflowBlock instance.
TryReceive(Predicate, T)	Attempts to synchronously receive an available output item from the IReceivableSourceBlock.

Explicit Interface Implementations

Name	Description
IDataflowBlock.Fault(Exception)	Causes the IDataflowBlock to complete in a Faulted state.
IReceivableSourceBlock.TryReceiveAll(IList)	Attempts to synchronously receive all available items from the IReceivableSourceBlock.
ISourceBlock.ConsumeMessage(DataflowMessageHeader, ITargetBlock, Boolean)	Called by a linked ITargetBlock to accept and consume a DataflowMessageHeader previously offered by this ISourceBlock.
ISourceBlock.ReleaseReservation(DataflowMessageHeader, ITargetBlock)	Called by a linked ITargetBlock to release a previously reserved DataflowMessageHeader by this ISourceBlock.
ISourceBlock.ReserveMessage(DataflowMessageHeader, ITargetBlock)	Called by a linked ITargetBlock to reserve a previously offered DataflowMessageHeader by this ISourceBlock.
ITargetBlock.OfferMessage(DataflowMessageHeader, T, ISourceBlock, Boolean)	Offers a message to the ITargetBlock, giving the target the opportunity to consume or postpone the message.

Extension Methods

Name	Description
AsObservable(ISourceBlock)	Creates a new IObservable abstraction over the ISourceBlock.
AsObserver(ITargetBlock)	Creates a new IObserver abstraction over the ITargetBlock.
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.
Post(ITargetBlock, TInput)	Posts an item to the ITargetBlock.
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.
ReceiveAllAsync(IReceivableSourceBlock, CancellationToken)	Creates an IAsyncEnumerable that enables receiving all of the data from the 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.
SendAsync(ITargetBlock, TInput, CancellationToken)	Asynchronously offers a message to the target message block, allowing for postponement.
SendAsync(ITargetBlock, TInput)	Asynchronously offers a message to the target message block, allowing for postponement.
TryReceive(IReceivableSourceBlock, TOutput)	Attempts to synchronously receive an item from the ISourceBlock.

Applies to

Feedback

Was this page helpful?