DataflowBlockOptions クラス

定義

データフロー ブロックによって実行される処理を構成するために使用されるオプションを提供します。

public ref class DataflowBlockOptions
public class DataflowBlockOptions
type DataflowBlockOptions = class
Public Class DataflowBlockOptions
継承
DataflowBlockOptions
派生

注釈

Note

TPL データフロー ライブラリ (System.Threading.Tasks.Dataflow 名前空間) は.NET と共に配布されません。 Visual Studio で System.Threading.Tasks.Dataflow 名前空間をインストールするには、プロジェクトを開き、[プロジェクト] メニューから [NuGet パッケージの管理] 選択し、System.Threading.Tasks.Dataflow パッケージをオンラインで検索します。 または、.NET Core CLI 使用してインストールするには、dotnet add package System.Threading.Tasks.Dataflow実行します。

DataflowBlockOptions は変更可能であり、そのプロパティを使用して構成できます。

特定の構成オプションが設定されていない場合は、次の既定値が使用されます。

オプション デフォルト
TaskScheduler Default
MaxMessagesPerTask DataflowBlockOptions.Unbounded (-1)
CancellationToken None
BoundedCapacity DataflowBlockOptions.Unbounded (-1)

データフロー ブロックは、構築時のオプションの状態をキャプチャします。 指定された DataflowBlockOptions インスタンスに対する後続の変更は、データフロー ブロックの動作に影響を与えるべきではありません。

コンストラクター

名前 説明
DataflowBlockOptions()

新しい DataflowBlockOptionsを初期化します。

フィールド

名前 説明
Unbounded

上限を提供するメンバー DataflowBlockOptions 無制限の数量を指定するために使用される定数。 このフィールドは定数です。

プロパティ

名前 説明
BoundedCapacity

ブロックによってバッファーされる可能性があるメッセージの最大数を取得または設定します。

CancellationToken

取り消し要求を監視する CancellationToken を取得または設定します。

EnsureOrdered

順序指定された処理をブロックのメッセージの処理に適用するかどうかを示す値を取得または設定します。

MaxMessagesPerTask

タスクごとに処理できるメッセージの最大数を取得または設定します。

NameFormat

ブロックの名前を照会するときに使用する書式指定文字列を取得または設定します。

TaskScheduler

タスクのスケジュールに使用する TaskScheduler を取得または設定します。

メソッド

名前 説明
Equals(Object)

指定したオブジェクトが現在のオブジェクトと等しいかどうかを判断します。

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
MemberwiseClone()

現在の Objectの簡易コピーを作成します。

(継承元 Object)
ToString()

現在のオブジェクトを表す文字列を返します。

(継承元 Object)

適用対象