BroadcastBlock<T>
Class
Definition
Provides a buffer for storing at most one element at time, overwriting each message with the next as it arrives.
public sealed class BroadcastBlock<T> : System.Threading.Tasks.Dataflow.IPropagatorBlock<T,T>, System.Threading.Tasks.Dataflow.IReceivableSourceBlock<T>, System.Threading.Tasks.Dataflow.ISourceBlock<T>, System.Threading.Tasks.Dataflow.ITargetBlock<T>
- T
Specifies the type of the data buffered by this dataflow block.
- Inheritance
-
BroadcastBlock<T>
- Implements
Inherited Members
System.Object
Remarks
Note
The TPL Dataflow Library (System.Threading.Tasks.Dataflow namespace) is not distributed with the .NET Framework 4.5. To install the System.Threading.Tasks.Dataflow namespace, open your project in Visual Studio 2012, choose Manage NuGet Packages from the Project menu, and search online for the Microsoft.Tpl.Dataflow package.
BroadcastBlock<T> exposes at most one element at a time. However, unlike WriteOnceBlock<T>, that element will be overwritten as new elements are provided to the block. BroadcastBlock<T> ensures that the current element is broadcast to any linked targets before allowing the element to be overwritten.
Constructors
| BroadcastBlock<T>(Func<T,T>) |
Initializes the BroadcastBlock<T> with the specified cloning function. |
| BroadcastBlock<T>(Func<T,T>, DataflowBlockOptions) |
Initializes the BroadcastBlock<T> with the specified cloning function and DataflowBlockOptions. |
Properties
| Completion |
Gets a Task that represents the asynchronous operation and completion of the dataflow block. |
Methods
| Complete() |
Signals to the IDataflowBlock that it should not accept nor produce any more messages nor consume any more postponed messages. |
| LinkTo(ITargetBlock<T>, DataflowLinkOptions) |
Links the ISourceBlock<TOutput> to the specified ITargetBlock<TInput>. |
| ToString() |
Returns a string that represents the formatted name of this IDataflowBlock instance. |
| TryReceive(Predicate<T>, T) |
Attempts to synchronously receive an available output item from the IReceivableSourceBlock<TOutput>. |