BatchedJoinBlock<T1,T2> BatchedJoinBlock<T1,T2> BatchedJoinBlock<T1,T2> BatchedJoinBlock<T1,T2> Class

Definition

Provides a dataflow block that batches a specified number of inputs of potentially differing types provided to one or more of its targets.

generic <typename T1, typename T2>
public ref class BatchedJoinBlock sealed : System::Threading::Tasks::Dataflow::IReceivableSourceBlock<Tuple<System::Collections::Generic::IList<T1> ^, System::Collections::Generic::IList<T2> ^> ^>, System::Threading::Tasks::Dataflow::ISourceBlock<Tuple<System::Collections::Generic::IList<T1> ^, System::Collections::Generic::IList<T2> ^> ^>
public sealed class BatchedJoinBlock<T1,T2> : System.Threading.Tasks.Dataflow.IReceivableSourceBlock<Tuple<System.Collections.Generic.IList<T1>,System.Collections.Generic.IList<T2>>>, System.Threading.Tasks.Dataflow.ISourceBlock<Tuple<System.Collections.Generic.IList<T1>,System.Collections.Generic.IList<T2>>>
type BatchedJoinBlock<'T1, 'T2> = class
    interface IDataflowBlock
    interface IReceivableSourceBlock<IList<'T1> * IList<'T2>>
    interface ISourceBlock<IList<'T1> * IList<'T2>>
Public NotInheritable Class BatchedJoinBlock(Of T1, T2)
Implements IReceivableSourceBlock(Of Tuple(Of IList(Of T1), IList(Of T2))), ISourceBlock(Of Tuple(Of IList(Of T1), IList(Of T2)))

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.

Inheritance
BatchedJoinBlock<T1,T2>BatchedJoinBlock<T1,T2>BatchedJoinBlock<T1,T2>BatchedJoinBlock<T1,T2>
Implements

Remarks

Note

The TPL Dataflow Library (the System.Threading.Tasks.Dataflow namespace) is not distributed with .NET. To install the System.Threading.Tasks.Dataflow namespace in Visual Studio, open your project, choose Manage NuGet Packages from the Project menu, and search online for the System.Threading.Tasks.Dataflow package. Alternatively, to install it using the .NET Core CLI, run dotnet add package System.Threading.Tasks.Dataflow.

Constructors

BatchedJoinBlock<T1,T2>(Int32) BatchedJoinBlock<T1,T2>(Int32) BatchedJoinBlock<T1,T2>(Int32) BatchedJoinBlock<T1,T2>(Int32)

Initializes a new BatchedJoinBlock<T1,T2> with the specified configuration.

BatchedJoinBlock<T1,T2>(Int32, GroupingDataflowBlockOptions) BatchedJoinBlock<T1,T2>(Int32, GroupingDataflowBlockOptions) BatchedJoinBlock<T1,T2>(Int32, GroupingDataflowBlockOptions) BatchedJoinBlock<T1,T2>(Int32, GroupingDataflowBlockOptions)

Initializes a new BatchedJoinBlock<T1,T2> with the specified configuration.

Properties

BatchSize BatchSize BatchSize BatchSize

Gets the size of the batches generated by this BatchedJoinBlock<T1,T2>.

Completion Completion Completion Completion

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

OutputCount OutputCount OutputCount OutputCount

Gets the number of output items available to be received from this block.

Target1 Target1 Target1 Target1

Gets a target that may be used to offer messages of the first type.

Target2 Target2 Target2 Target2

Gets a target that may be used to offer messages of the second type.

Methods

Complete() Complete() Complete() Complete()

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

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
LinkTo(ITargetBlock<Tuple<IList<T1>,IList<T2>>>, DataflowLinkOptions) LinkTo(ITargetBlock<Tuple<IList<T1>,IList<T2>>>, DataflowLinkOptions) LinkTo(ITargetBlock<Tuple<IList<T1>,IList<T2>>>, DataflowLinkOptions) LinkTo(ITargetBlock<Tuple<IList<T1>,IList<T2>>>, DataflowLinkOptions)

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

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Returns a string that represents the formatted name of this IDataflowBlock instance.

TryReceive(Predicate<Tuple<IList<T1>,IList<T2>>>, Tuple<IList<T1>,IList<T2>>) TryReceive(Predicate<Tuple<IList<T1>,IList<T2>>>, Tuple<IList<T1>,IList<T2>>) TryReceive(Predicate<Tuple<IList<T1>,IList<T2>>>, Tuple<IList<T1>,IList<T2>>) TryReceive(Predicate<Tuple<IList<T1>,IList<T2>>>, Tuple<IList<T1>,IList<T2>>)

Attempts to synchronously receive an available output item from the IReceivableSourceBlock<TOutput>.

TryReceiveAll(IList<Tuple<IList<T1>,IList<T2>>>) TryReceiveAll(IList<Tuple<IList<T1>,IList<T2>>>) TryReceiveAll(IList<Tuple<IList<T1>,IList<T2>>>) TryReceiveAll(IList<Tuple<IList<T1>,IList<T2>>>)

Attempts to synchronously receive all available items from the IReceivableSourceBlock<TOutput>.

Explicit Interface Implementations

IDataflowBlock.Fault(Exception) IDataflowBlock.Fault(Exception) IDataflowBlock.Fault(Exception) IDataflowBlock.Fault(Exception)

Causes the IDataflowBlock to complete in a Faulted state.

ISourceBlock<Tuple<IList<T1>,IList<T2>>>.ConsumeMessage(DataflowMessageHeader, ITargetBlock<Tuple<IList<T1>,IList<T2>>>, Boolean) ISourceBlock<Tuple<IList<T1>,IList<T2>>>.ConsumeMessage(DataflowMessageHeader, ITargetBlock<Tuple<IList<T1>,IList<T2>>>, Boolean) ISourceBlock<Tuple<IList<T1>,IList<T2>>>.ConsumeMessage(DataflowMessageHeader, ITargetBlock<Tuple<IList<T1>,IList<T2>>>, Boolean) ISourceBlock<Tuple<IList<T1>,IList<T2>>>.ConsumeMessage(DataflowMessageHeader, ITargetBlock<Tuple<IList<T1>,IList<T2>>>, Boolean)
ISourceBlock<Tuple<IList<T1>,IList<T2>>>.ReleaseReservation(DataflowMessageHeader, ITargetBlock<Tuple<IList<T1>,IList<T2>>>) ISourceBlock<Tuple<IList<T1>,IList<T2>>>.ReleaseReservation(DataflowMessageHeader, ITargetBlock<Tuple<IList<T1>,IList<T2>>>) ISourceBlock<Tuple<IList<T1>,IList<T2>>>.ReleaseReservation(DataflowMessageHeader, ITargetBlock<Tuple<IList<T1>,IList<T2>>>) ISourceBlock<Tuple<IList<T1>,IList<T2>>>.ReleaseReservation(DataflowMessageHeader, ITargetBlock<Tuple<IList<T1>,IList<T2>>>)
ISourceBlock<Tuple<IList<T1>,IList<T2>>>.ReserveMessage(DataflowMessageHeader, ITargetBlock<Tuple<IList<T1>,IList<T2>>>) ISourceBlock<Tuple<IList<T1>,IList<T2>>>.ReserveMessage(DataflowMessageHeader, ITargetBlock<Tuple<IList<T1>,IList<T2>>>) ISourceBlock<Tuple<IList<T1>,IList<T2>>>.ReserveMessage(DataflowMessageHeader, ITargetBlock<Tuple<IList<T1>,IList<T2>>>) ISourceBlock<Tuple<IList<T1>,IList<T2>>>.ReserveMessage(DataflowMessageHeader, ITargetBlock<Tuple<IList<T1>,IList<T2>>>)

Extension Methods

AsObservable<TOutput>(ISourceBlock<TOutput>) AsObservable<TOutput>(ISourceBlock<TOutput>) AsObservable<TOutput>(ISourceBlock<TOutput>) AsObservable<TOutput>(ISourceBlock<TOutput>)

Creates a new IObservable<T> abstraction over the ISourceBlock<TOutput>.

LinkTo<TOutput>(ISourceBlock<TOutput>, ITargetBlock<TOutput>) LinkTo<TOutput>(ISourceBlock<TOutput>, ITargetBlock<TOutput>) LinkTo<TOutput>(ISourceBlock<TOutput>, ITargetBlock<TOutput>) LinkTo<TOutput>(ISourceBlock<TOutput>, ITargetBlock<TOutput>)

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

LinkTo<TOutput>(ISourceBlock<TOutput>, ITargetBlock<TOutput>, Predicate<TOutput>) LinkTo<TOutput>(ISourceBlock<TOutput>, ITargetBlock<TOutput>, Predicate<TOutput>) LinkTo<TOutput>(ISourceBlock<TOutput>, ITargetBlock<TOutput>, Predicate<TOutput>) LinkTo<TOutput>(ISourceBlock<TOutput>, ITargetBlock<TOutput>, Predicate<TOutput>)

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

LinkTo<TOutput>(ISourceBlock<TOutput>, ITargetBlock<TOutput>, DataflowLinkOptions, Predicate<TOutput>) LinkTo<TOutput>(ISourceBlock<TOutput>, ITargetBlock<TOutput>, DataflowLinkOptions, Predicate<TOutput>) LinkTo<TOutput>(ISourceBlock<TOutput>, ITargetBlock<TOutput>, DataflowLinkOptions, Predicate<TOutput>) LinkTo<TOutput>(ISourceBlock<TOutput>, ITargetBlock<TOutput>, DataflowLinkOptions, Predicate<TOutput>)

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

OutputAvailableAsync<TOutput>(ISourceBlock<TOutput>) OutputAvailableAsync<TOutput>(ISourceBlock<TOutput>) OutputAvailableAsync<TOutput>(ISourceBlock<TOutput>) OutputAvailableAsync<TOutput>(ISourceBlock<TOutput>)

Provides a Task<TResult> that asynchronously monitors the source for available output.

OutputAvailableAsync<TOutput>(ISourceBlock<TOutput>, CancellationToken) OutputAvailableAsync<TOutput>(ISourceBlock<TOutput>, CancellationToken) OutputAvailableAsync<TOutput>(ISourceBlock<TOutput>, CancellationToken) OutputAvailableAsync<TOutput>(ISourceBlock<TOutput>, CancellationToken)

Provides a Task<TResult> that asynchronously monitors the source for available output.

Receive<TOutput>(ISourceBlock<TOutput>) Receive<TOutput>(ISourceBlock<TOutput>) Receive<TOutput>(ISourceBlock<TOutput>) Receive<TOutput>(ISourceBlock<TOutput>)

Synchronously receives a value from a specified source.

Receive<TOutput>(ISourceBlock<TOutput>, CancellationToken) Receive<TOutput>(ISourceBlock<TOutput>, CancellationToken) Receive<TOutput>(ISourceBlock<TOutput>, CancellationToken) Receive<TOutput>(ISourceBlock<TOutput>, CancellationToken)

Synchronously receives a value from a specified source and provides a token to cancel the operation.

Receive<TOutput>(ISourceBlock<TOutput>, TimeSpan) Receive<TOutput>(ISourceBlock<TOutput>, TimeSpan) Receive<TOutput>(ISourceBlock<TOutput>, TimeSpan) Receive<TOutput>(ISourceBlock<TOutput>, TimeSpan)

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

Receive<TOutput>(ISourceBlock<TOutput>, TimeSpan, CancellationToken) Receive<TOutput>(ISourceBlock<TOutput>, TimeSpan, CancellationToken) Receive<TOutput>(ISourceBlock<TOutput>, TimeSpan, CancellationToken) Receive<TOutput>(ISourceBlock<TOutput>, TimeSpan, CancellationToken)

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

ReceiveAsync<TOutput>(ISourceBlock<TOutput>) ReceiveAsync<TOutput>(ISourceBlock<TOutput>) ReceiveAsync<TOutput>(ISourceBlock<TOutput>) ReceiveAsync<TOutput>(ISourceBlock<TOutput>)

Asynchronously receives a value from a specified source.

ReceiveAsync<TOutput>(ISourceBlock<TOutput>, CancellationToken) ReceiveAsync<TOutput>(ISourceBlock<TOutput>, CancellationToken) ReceiveAsync<TOutput>(ISourceBlock<TOutput>, CancellationToken) ReceiveAsync<TOutput>(ISourceBlock<TOutput>, CancellationToken)

Asynchronously receives a value from a specified source and provides a token to cancel the operation.

ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan) ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan) ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan) ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan)

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

ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan, CancellationToken) ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan, CancellationToken) ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan, CancellationToken) ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan, CancellationToken)

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

TryReceive<TOutput>(IReceivableSourceBlock<TOutput>, TOutput) TryReceive<TOutput>(IReceivableSourceBlock<TOutput>, TOutput) TryReceive<TOutput>(IReceivableSourceBlock<TOutput>, TOutput) TryReceive<TOutput>(IReceivableSourceBlock<TOutput>, TOutput)

Attempts to synchronously receive an item from the ISourceBlock<TOutput>.

Applies to