DataflowBlock.ReceiveAsync メソッド

定義

名前空間:

System.Threading.Tasks.Dataflow

アセンブリ:

System.Threading.Tasks.Dataflow.dll

パッケージ:

System.Threading.Tasks.Dataflow v9.0.0-preview.3.24172.9

オーバーロード

ReceiveAsync<TOutput>(ISourceBlock<TOutput>)	指定されたソースから値を非同期的に受信します。
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, CancellationToken)	非同期に指定したソースから値を受け取り、操作をキャンセルするトークンを提供します。
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan)	非同期に指定したソースから値を受信し、オプションのタイムアウト期間を確認します。
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan, CancellationToken)	非同期に操作をキャンセルするトークンを提供し、オプションのタイムアウト間隔を確認する指定したソースから値を受け取ります。

ReceiveAsync<TOutput>(ISourceBlock<TOutput>)

ソース:

DataflowBlock.cs

指定されたソースから値を非同期的に受信します。

public:
generic <typename TOutput>
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task<TOutput> ^ ReceiveAsync(System::Threading::Tasks::Dataflow::ISourceBlock<TOutput> ^ source);

public static System.Threading.Tasks.Task<TOutput> ReceiveAsync<TOutput> (this System.Threading.Tasks.Dataflow.ISourceBlock<TOutput> source);

static member ReceiveAsync : System.Threading.Tasks.Dataflow.ISourceBlock<'Output> -> System.Threading.Tasks.Task<'Output>

<Extension()>
Public Function ReceiveAsync(Of TOutput) (source As ISourceBlock(Of TOutput)) As Task(Of TOutput)

型パラメーター

TOutput

ソースに含まれるデータの型。

パラメーター

source

ISourceBlock<TOutput>

値を受信する元のソース。

戻り値

Task<TOutput>

非同期の受信操作を表すタスク。 項目値をソースから正常に受け取った場合、返されたタスクが完了し、Result が受け取った値を返します。 ソースが空で完了しているために項目の値が取得できない場合には、返されたタスクで InvalidOperationException 例外がスローされます。

例外

ArgumentNullException

source は null です。

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

ソース:

DataflowBlock.cs

非同期に指定したソースから値を受け取り、操作をキャンセルするトークンを提供します。

public:
generic <typename TOutput>
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task<TOutput> ^ ReceiveAsync(System::Threading::Tasks::Dataflow::ISourceBlock<TOutput> ^ source, System::Threading::CancellationToken cancellationToken);

public static System.Threading.Tasks.Task<TOutput> ReceiveAsync<TOutput> (this System.Threading.Tasks.Dataflow.ISourceBlock<TOutput> source, System.Threading.CancellationToken cancellationToken);

static member ReceiveAsync : System.Threading.Tasks.Dataflow.ISourceBlock<'Output> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Output>

<Extension()>
Public Function ReceiveAsync(Of TOutput) (source As ISourceBlock(Of TOutput), cancellationToken As CancellationToken) As Task(Of TOutput)

型パラメーター

TOutput

ソースに格納されるデータの種類を指定します。

パラメーター

source

ISourceBlock<TOutput>

値を受信する元のソース。

cancellationToken

CancellationToken

受信操作を取り消すために使用するトークン。

戻り値

Task<TOutput>

非同期の受信操作を表すタスク。 値をソースから正常に受け取った場合、返されたタスクが完了し、Result が値を返します。 キャンセルが要求されたため値を取得できない場合には、返されたタスクはキャンセルされます。 ソースが空で完了しているために値が取得できない場合には、返されたタスクの InvalidOperationException 例外がスローされます。

例外

ArgumentNullException

source は null です。

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

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

ソース:

DataflowBlock.cs

非同期に指定したソースから値を受信し、オプションのタイムアウト期間を確認します。

public:
generic <typename TOutput>
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task<TOutput> ^ ReceiveAsync(System::Threading::Tasks::Dataflow::ISourceBlock<TOutput> ^ source, TimeSpan timeout);

public static System.Threading.Tasks.Task<TOutput> ReceiveAsync<TOutput> (this System.Threading.Tasks.Dataflow.ISourceBlock<TOutput> source, TimeSpan timeout);

static member ReceiveAsync : System.Threading.Tasks.Dataflow.ISourceBlock<'Output> * TimeSpan -> System.Threading.Tasks.Task<'Output>

<Extension()>
Public Function ReceiveAsync(Of TOutput) (source As ISourceBlock(Of TOutput), timeout As TimeSpan) As Task(Of TOutput)

型パラメーター

TOutput

ソースに含まれるデータの型。

パラメーター

source

ISourceBlock<TOutput>

値を受信する元のソース。

timeout

TimeSpan

同期操作が完了するまで待機する最大時間間隔 (ミリ秒単位)。-1 ミリ秒を設定すると無制限に待機します。

戻り値

Task<TOutput>

非同期の受信操作を表すタスク。 値をソースから正常に受け取った場合、返されたタスクが完了し、Result が値を返します。 タイムアウトの時間が経過したため値を取得できない場合には、返されたタスクはキャンセルされます。 ソースが空で完了しているために値が取得できない場合には、返されたタスクの InvalidOperationException 例外がスローされます。

例外

ArgumentNullException

source が nullです。

ArgumentOutOfRangeException

timeout は -1 ミリ秒以外の負数です。-1 は無制限のタイムアウト期間を表します。

- または -

timeout が Int32.MaxValue より大きい。

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

ソース:

DataflowBlock.cs

非同期に操作をキャンセルするトークンを提供し、オプションのタイムアウト間隔を確認する指定したソースから値を受け取ります。

public:
generic <typename TOutput>
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task<TOutput> ^ ReceiveAsync(System::Threading::Tasks::Dataflow::ISourceBlock<TOutput> ^ source, TimeSpan timeout, System::Threading::CancellationToken cancellationToken);

public static System.Threading.Tasks.Task<TOutput> ReceiveAsync<TOutput> (this System.Threading.Tasks.Dataflow.ISourceBlock<TOutput> source, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

static member ReceiveAsync : System.Threading.Tasks.Dataflow.ISourceBlock<'Output> * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Output>

<Extension()>
Public Function ReceiveAsync(Of TOutput) (source As ISourceBlock(Of TOutput), timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of TOutput)

型パラメーター

TOutput

ソースに含まれるデータの型。

パラメーター

source

ISourceBlock<TOutput>

値を受信する元のソース。

timeout

TimeSpan

同期操作が完了するまで待機する最大時間間隔 (ミリ秒単位)。-1 ミリ秒を設定すると無制限に待機します。

cancellationToken

CancellationToken

受信操作を取り消すために使用できるトークン。

戻り値

Task<TOutput>

非同期の受信操作を表すタスク。 値をソースから正常に受け取った場合、返されたタスクが完了し、Result が値を返します。 タイムアウトの時間が経過するか、キャンセルが要求されたため値を取得できない場合には、返されたタスクはキャンセルされます。 ソースが空で完了しているために値が取得できない場合には、返されたタスクの InvalidOperationException 例外がスローされます。

例外

ArgumentNullException

source が nullです。

ArgumentOutOfRangeException

timeout は -1 ミリ秒以外の負数です。-1 は無制限のタイムアウト期間を表します。

- または -

timeout が Int32.MaxValue より大きい。

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。