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

Source:: BatchedJoinBlock.cs

Source:: BatchedJoinBlock.cs

Source:: BatchedJoinBlock.cs

Source:: BatchedJoinBlock.cs

Source:: BatchedJoinBlock.cs

Source:: BatchedJoinBlock.cs

Source:: BatchedJoinBlock.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 dataflow block that batches a specified number of inputs of potentially differing types provided to one or more of its targets.

generic 
public ref class BatchedJoinBlock sealed : System::Threading::Tasks::Dataflow::IReceivableSourceBlock ^, System::Collections::Generic::IList ^, System::Collections::Generic::IList ^> ^>, System::Threading::Tasks::Dataflow::ISourceBlock ^, System::Collections::Generic::IList ^, System::Collections::Generic::IList ^> ^>

public sealed class BatchedJoinBlock : System.Threading.Tasks.Dataflow.IReceivableSourceBlock,System.Collections.Generic.IList,System.Collections.Generic.IList>>, System.Threading.Tasks.Dataflow.ISourceBlock,System.Collections.Generic.IList,System.Collections.Generic.IList>>

type BatchedJoinBlock<'T1, 'T2, 'T3> = class
    interface IReceivableSourceBlock * IList<'T2> * IList<'T3>>
    interface ISourceBlock * IList<'T2> * IList<'T3>>
    interface IDataflowBlock

type BatchedJoinBlock<'T1, 'T2, 'T3> = class
    interface IDataflowBlock
    interface IReceivableSourceBlock * IList<'T2> * IList<'T3>>
    interface ISourceBlock * IList<'T2> * IList<'T3>>

Public NotInheritable Class BatchedJoinBlock(Of T1, T2, T3)
Implements IReceivableSourceBlock(Of Tuple(Of IList(Of T1), IList(Of T2), IList(Of T3))), ISourceBlock(Of Tuple(Of IList(Of T1), IList(Of T2), IList(Of T3)))

Type Parameters

T1

Specifies the type of data accepted by the block's first target.

T2

Specifies the type of data accepted by the block's second target.

T3

Specifies the type of data accepted by the block's third target.

Inheritance: Object
BatchedJoinBlock

Implements: IDataflowBlock IReceivableSourceBlock<Tuple<IList,IList,IList>> ISourceBlock<Tuple<IList,IList,IList>> ISourceBlock

Constructors

Name	Description
BatchedJoinBlock(Int32, GroupingDataflowBlockOptions)	Initializes a new BatchedJoinBlock with the specified configuration.
BatchedJoinBlock(Int32)	Initializes a new BatchedJoinBlock with the specified configuration.

Properties

Name	Description
BatchSize	Gets the size of the batches generated by this BatchedJoinBlock.
Completion	Gets a Task that represents the asynchronous operation and completion of the dataflow block.
OutputCount	Gets the number of output items available to be received from this block.
Target1	Gets a target that may be used to offer messages of the first type.
Target2	Gets a target that may be used to offer messages of the second type.
Target3	Gets a target that may be used to offer messages of the third type.

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,IList,IList>>, 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,IList,IList>>, Tuple,IList,IList>)	Attempts to synchronously receive an available output item from the IReceivableSourceBlock.
TryReceiveAll(IList,IList,IList>>)	Attempts to synchronously receive all available items from the IReceivableSourceBlock.

Explicit Interface Implementations

Name	Description
IDataflowBlock.Fault(Exception)	Causes the IDataflowBlock to complete in a Faulted state.
ISourceBlock,IList,IList>>.ConsumeMessage(DataflowMessageHeader, ITargetBlock,IList,IList>>, Boolean)	Passes the ownership of the message identified by the DataflowMessageHeader from this ISourceBlock instance to the ITargetBlock.
ISourceBlock,IList,IList>>.ReleaseReservation(DataflowMessageHeader, ITargetBlock,IList,IList>>)	Releases the right to pass the ownership of the message identified by the DataflowMessageHeader from this ISourceBlock to the ITargetBlock.
ISourceBlock,IList,IList>>.ReserveMessage(DataflowMessageHeader, ITargetBlock,IList,IList>>)	Reserves the right to pass the ownership of the message identified by the DataflowMessageHeader from this ISourceBlock to the ITargetBlock.

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.
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.
TryReceive(IReceivableSourceBlock, TOutput)	Attempts to synchronously receive an item from the ISourceBlock.

Applies to

Feedback

Was this page helpful?