DataflowBlock.Receive メソッド

定義

名前空間:

System.Threading.Tasks.Dataflow

アセンブリ:

System.Threading.Tasks.Dataflow.dll

パッケージ:

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

オーバーロード

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

Receive<TOutput>(ISourceBlock<TOutput>)

ソース:

DataflowBlock.cs

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

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

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

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

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

型パラメーター

TOutput

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

パラメーター

source

ISourceBlock<TOutput>

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

戻り値

TOutput

受け取った値。

例外

ArgumentNullException

source が nullです。

InvalidOperationException

ソースから項目を受信できませんでした。

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

ソース:

DataflowBlock.cs

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

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

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

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

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

型パラメーター

TOutput

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

パラメーター

source

ISourceBlock<TOutput>

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

cancellationToken

CancellationToken

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

戻り値

TOutput

受け取った値。

例外

ArgumentNullException

source が nullです。

InvalidOperationException

ソースから項目を受信できませんでした。

OperationCanceledException

操作は、ソースから項目を受け取る前に取り消されました。

注釈

ソースがこの操作によって受信されたアイテムを正常に提供した場合、同時キャンセル要求が発生した場合でも、そのアイテムが返されます。

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

ソース:

DataflowBlock.cs

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

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

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

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

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

型パラメーター

TOutput

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

パラメーター

source

ISourceBlock<TOutput>

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

timeout

TimeSpan

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

戻り値

TOutput

受け取った値。

例外

ArgumentOutOfRangeException

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

- または -

timeout が Int32.MaxValue より大きい。

ArgumentNullException

source が nullです。

InvalidOperationException

ソースから項目を受信できませんでした。

TimeoutException

項目をソースから受け取る前に、指定されたタイムアウトの時間になりました。

注釈

ソースがこの操作によって受信されたアイテムを正常に提供した場合、同時タイムアウトが発生した場合でも、そのアイテムが返されます。

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

ソース:

DataflowBlock.cs

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

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

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

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

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

型パラメーター

TOutput

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

パラメーター

source

ISourceBlock<TOutput>

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

timeout

TimeSpan

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

cancellationToken

CancellationToken

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

戻り値

TOutput

受け取った値。

例外

ArgumentNullException

source が null です。

ArgumentOutOfRangeException

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

- または -

timeout が Int32.MaxValue より大きい。

InvalidOperationException

ソースから項目を受信できませんでした。

TimeoutException

項目をソースから受け取る前に、指定されたタイムアウトの時間になりました。

OperationCanceledException

操作は、ソースから項目を受け取る前に取り消されました。

注釈

ソースがこの操作で受信した項目の値を正常に提供した場合、同時タイムアウトまたはキャンセル要求が発生した場合でも、その値が返されます。