Export (0) Print
Expand All

BatchedJoinBlock<T1, T2> Class

.NET Framework 4.5

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

System::Object
  System.Threading.Tasks.Dataflow::BatchedJoinBlock<T1, T2>

Namespace:  System.Threading.Tasks.Dataflow
Assembly:  System.Threading.Tasks.Dataflow (in System.Threading.Tasks.Dataflow.dll)

generic<typename T1, typename T2>
public ref class BatchedJoinBlock sealed : IReceivableSourceBlock<Tuple<IList<T1>^, IList<T2>^>^>, 
	ISourceBlock<Tuple<IList<T1>^, IList<T2>^>^>, IDataflowBlock

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.

The BatchedJoinBlock<T1, T2> type exposes the following members.

  NameDescription
Public methodSupported by Portable Class LibraryBatchedJoinBlock<T1, T2>(Int32)Initializes a newBatchedJoinBlock<T1, T2> with the specified configuration.
Public methodSupported by Portable Class LibraryBatchedJoinBlock<T1, T2>(Int32, GroupingDataflowBlockOptions)Initializes a new BatchedJoinBlock<T1, T2> with the specified configuration.
Top

  NameDescription
Public propertySupported by Portable Class LibraryBatchSizeGets the size of the batches generated by this BatchedJoinBlock<T1, T2>.
Public propertySupported by Portable Class LibraryCompletionGets a Task that represents the asynchronous operation and completion of the dataflow block.
Public propertySupported by Portable Class LibraryOutputCountGets the number of output items available to be received from this block.
Public propertySupported by Portable Class LibraryTarget1Gets a target that may be used to offer messages of the first type.
Public propertySupported by Portable Class LibraryTarget2Gets a target that may be used to offer messages of the second type.
Top

  NameDescription
Public methodSupported by Portable Class LibraryCompleteSignals to the IDataflowBlock that it should not accept nor produce any more messages nor consume any more postponed messages.
Public methodSupported by Portable Class LibraryEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodSupported by Portable Class LibraryGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodSupported by Portable Class LibraryGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Portable Class LibraryLinkToLinks the ISourceBlock<TOutput> to the specified ITargetBlock<TInput>.
Public methodSupported by Portable Class LibraryToStringReturns a string that represents the formatted name of this IDataflowBlock instance. (Overrides Object::ToString().)
Public methodSupported by Portable Class LibraryTryReceiveAttempts to synchronously receive an available output item from the IReceivableSourceBlock<TOutput>.
Public methodSupported by Portable Class LibraryTryReceiveAllAttempts to synchronously receive all available items from the IReceivableSourceBlock<TOutput>.
Top

  NameDescription
Public Extension MethodSupported by Portable Class LibraryAsObservable<Tuple<IList<T1>, IList<T2>>>Creates a new IObservable<T> abstraction over the ISourceBlock<TOutput>. (Defined by DataflowBlock.)
Public Extension MethodSupported by Portable Class LibraryLinkTo<Tuple<IList<T1>, IList<T2>>>(ITargetBlock<Tuple<IList<T1>, IList<T2>>>)Overloaded. Links the ISourceBlock<TOutput> to the specified ITargetBlock<TInput>. (Defined by DataflowBlock.)
Public Extension MethodSupported by Portable Class LibraryLinkTo<Tuple<IList<T1>, IList<T2>>>(ITargetBlock<Tuple<IList<T1>, IList<T2>>>, Predicate<Tuple<IList<T1>, IList<T2>>>)Overloaded. Links the ISourceBlock<TOutput> to the specified ITargetBlock<TInput> using the specified filter. (Defined by DataflowBlock.)
Public Extension MethodSupported by Portable Class LibraryLinkTo<Tuple<IList<T1>, IList<T2>>>(ITargetBlock<Tuple<IList<T1>, IList<T2>>>, DataflowLinkOptions, Predicate<Tuple<IList<T1>, IList<T2>>>)Overloaded. Links the ISourceBlock<TOutput> to the specified ITargetBlock<TInput> using the specified filter. (Defined by DataflowBlock.)
Public Extension MethodSupported by Portable Class LibraryOutputAvailableAsync<Tuple<IList<T1>, IList<T2>>>()Overloaded. Provides a Task<TResult> that asynchronously monitors the source for available output. (Defined by DataflowBlock.)
Public Extension MethodSupported by Portable Class LibraryOutputAvailableAsync<Tuple<IList<T1>, IList<T2>>>(CancellationToken)Overloaded. Provides a Task<TResult> that asynchronously monitors the source for available output. (Defined by DataflowBlock.)
Public Extension MethodSupported by Portable Class LibraryReceive<Tuple<IList<T1>, IList<T2>>>()Overloaded. Synchronously receives a value from a specified source. (Defined by DataflowBlock.)
Public Extension MethodSupported by Portable Class LibraryReceive<Tuple<IList<T1>, IList<T2>>>(CancellationToken)Overloaded. Synchronously receives a value from a specified source and provides a token to cancel the operation. (Defined by DataflowBlock.)
Public Extension MethodSupported by Portable Class LibraryReceive<Tuple<IList<T1>, IList<T2>>>(TimeSpan)Overloaded. Synchronously receives a value from a specified source, observing an optional time-out period. (Defined by DataflowBlock.)
Public Extension MethodSupported by Portable Class LibraryReceive<Tuple<IList<T1>, IList<T2>>>(TimeSpan, CancellationToken)Overloaded. Synchronously receives a value from a specified source, providing a token to cancel the operation and observing an optional time-out interval. (Defined by DataflowBlock.)
Public Extension MethodSupported by Portable Class LibraryReceiveAsync<Tuple<IList<T1>, IList<T2>>>()Overloaded. Asynchronously receives a value from a specified source. (Defined by DataflowBlock.)
Public Extension MethodSupported by Portable Class LibraryReceiveAsync<Tuple<IList<T1>, IList<T2>>>(CancellationToken)Overloaded. Asynchronously receives a value from a specified source and provides a token to cancel the operation. (Defined by DataflowBlock.)
Public Extension MethodSupported by Portable Class LibraryReceiveAsync<Tuple<IList<T1>, IList<T2>>>(TimeSpan)Overloaded. Asynchronously receives a value from a specified source, observing an optional time-out period. (Defined by DataflowBlock.)
Public Extension MethodSupported by Portable Class LibraryReceiveAsync<Tuple<IList<T1>, IList<T2>>>(TimeSpan, CancellationToken)Overloaded. Asynchronously receives a value from a specified source, providing a token to cancel the operation and observing an optional time-out interval. (Defined by DataflowBlock.)
Public Extension MethodSupported by Portable Class LibraryTryReceive<Tuple<IList<T1>, IList<T2>>>Attempts to synchronously receive an item from the ISourceBlock<TOutput>. (Defined by DataflowBlock.)
Top

NoteNote

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.

.NET Framework

Supported in: 4.5

Portable Class Library

Supported in: Portable Class Library

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft