ExecutionDataflowBlockOptions クラス

定義

ユーザー指定デリゲートの呼び出しにより各メッセージを処理するデータフロー ブロックで実行される、処理の構成に使用するオプションを提供します。Provides options used to configure the processing performed by dataflow blocks that process each message through the invocation of a user-provided delegate. これらは ActionBlock<TInput> および TransformBlock<TInput,TOutput> のようなデータ フローのブロックです。These are dataflow blocks such as ActionBlock<TInput> and TransformBlock<TInput,TOutput>.

public ref class ExecutionDataflowBlockOptions : System::Threading::Tasks::Dataflow::DataflowBlockOptions
public class ExecutionDataflowBlockOptions : System.Threading.Tasks.Dataflow.DataflowBlockOptions
type ExecutionDataflowBlockOptions = class
    inherit DataflowBlockOptions
Public Class ExecutionDataflowBlockOptions
Inherits DataflowBlockOptions
継承
ExecutionDataflowBlockOptions

注釈

注意

TPL データフロー ライブラリ (System.Threading.Tasks.Dataflow 名前空間) は、.NET と一緒には配布されません。The TPL Dataflow Library (the System.Threading.Tasks.Dataflow namespace) is not distributed with .NET. Visual Studio に System.Threading.Tasks.Dataflow 名前空間をインストールするには、プロジェクトを開き、 [プロジェクト] メニューの [NuGet パッケージの管理] をクリックし、System.Threading.Tasks.Dataflow パッケージをオンラインで検索します。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. または、.NET Core CLI を使ってインストールするには、dotnet add package System.Threading.Tasks.Dataflow を実行します。Alternatively, to install it using the .NET Core CLI, run dotnet add package System.Threading.Tasks.Dataflow.

ExecutionDataflowBlockOptions は変更可能で、そのプロパティを使用して構成できます。ExecutionDataflowBlockOptions is mutable and can be configured through its properties.

特定の構成オプションが設定されていない場合は、次の既定値が使用されます。When specific configuration options are not set, the following defaults are used:

オプションOptions DefaultDefault
TaskSchedulerTaskScheduler Default
CancellationTokenCancellationToken None
System.threading.tasks.dataflow.dataflowblockoptions.maxmessagespertaskMaxMessagesPerTask DataflowBlockOptions。無制限 (-1)DataflowBlockOptions.Unbounded (-1)
BoundedCapacityBoundedCapacity DataflowBlockOptions。無制限 (-1)DataflowBlockOptions.Unbounded (-1)
MaxDegreeOfParallelismMaxDegreeOfParallelism 11

データフローブロックは、構築時にオプションの状態をキャプチャします。Dataflow blocks capture the state of the options at their construction. 指定されたインスタンスへの後続の変更 ExecutionDataflowBlockOptions は、データフローブロックの動作に影響しません。Subsequent changes to the provided ExecutionDataflowBlockOptions instance should not affect the behavior of a dataflow block.

コンストラクター

ExecutionDataflowBlockOptions()

新しい ExecutionDataflowBlockOptions を初期化します。Initializes a new ExecutionDataflowBlockOptions.

フィールド

Unbounded

上限を提示する DataflowBlockOptions メンバーに無制限の数量を指定するために使用される定数。A constant used to specify an unlimited quantity for DataflowBlockOptions members that provide an upper bound. このフィールドは定数です。This field is constant.

(継承元 DataflowBlockOptions)

プロパティ

BoundedCapacity

ブロックによってバッファリングできるメッセージ数の最大値を取得または設定します。Gets or sets the maximum number of messages that may be buffered by the block.

(継承元 DataflowBlockOptions)
CancellationToken

キャンセル要求を監視するための CancellationToken を取得または設定します。Gets or sets the CancellationToken to monitor for cancellation requests.

(継承元 DataflowBlockOptions)
EnsureOrdered

順次処理をブロックのメッセージの処理に強制するかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether ordered processing should be enforced on a block's handling of messages.

(継承元 DataflowBlockOptions)
MaxDegreeOfParallelism

ブロックによって同時に処理できるメッセージ数の最大値を取得します。Gets the maximum number of messages that may be processed by the block concurrently.

MaxMessagesPerTask

タスクごとに処理できるメッセージの最大数を取得または設定します。Gets or sets the maximum number of messages that may be processed per task.

(継承元 DataflowBlockOptions)
NameFormat

ブロックで名前がクエリされるときに使用する書式指定文字列を取得または設定します。Gets or sets the format string to use when a block is queried for its name.

(継承元 DataflowBlockOptions)
SingleProducerConstrained

データフロー ブロックを使用しているコードで、同時に使用できるプロデューサーが 1 つに制限されているかどうかを取得します。Gets whether code using the dataflow block is constrained to one producer at a time.

TaskScheduler

タスクをスケジュールするために使用 TaskScheduler を取得または設定します。Gets or sets the TaskScheduler to use for scheduling tasks.

(継承元 DataflowBlockOptions)

メソッド

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(継承元 Object)

適用対象