DataflowBlock.ReceiveAsync Metoda

Definicja

Przestrzeń nazw:

System.Threading.Tasks.Dataflow

Zestaw:

System.Threading.Tasks.Dataflow.dll

Pakiet:

System.Threading.Tasks.Dataflow v9.0.0-rc.1.24431.7

Przeciążenia

ReceiveAsync<TOutput>(ISourceBlock<TOutput>)	Asynchronicznie odbiera wartość z określonego źródła.
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, CancellationToken)	Asynchronicznie odbiera wartość z określonego źródła i udostępnia token umożliwiający anulowanie operacji.
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan)	Asynchronicznie odbiera wartość z określonego źródła, obserwując opcjonalny limit czasu.
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan, CancellationToken)	Asynchronicznie odbiera wartość z określonego źródła, zapewniając token umożliwiający anulowanie operacji i obserwowanie opcjonalnego interwału limitu czasu.

ReceiveAsync<TOutput>(ISourceBlock<TOutput>)

Źródło:

DataflowBlock.cs

Asynchronicznie odbiera wartość z określonego źródła.

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)

Parametry typu

TOutput

Typ danych zawartych w źródle.

Parametry

source

ISourceBlock<TOutput>

Źródło, z którego ma zostać odebrana wartość.

Zwraca

Task<TOutput>

Zadanie reprezentujące asynchroniczną operację odbierania. Gdy wartość elementu zostanie pomyślnie odebrana ze źródła, zwrócone zadanie zostanie ukończone i zwraca wartość Result odebraną. Jeśli nie można pobrać wartości elementu, ponieważ źródło jest puste i ukończone, InvalidOperationException w zwróconym zadaniu zostanie zgłoszony wyjątek.

Wyjątki

ArgumentNullException

source to null.

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

Źródło:

DataflowBlock.cs

Asynchronicznie odbiera wartość z określonego źródła i udostępnia token umożliwiający anulowanie operacji.

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)

Parametry typu

TOutput

Określa typ danych zawartych w źródle.

Parametry

source

ISourceBlock<TOutput>

Źródło, z którego ma zostać odebrana wartość.

cancellationToken

CancellationToken

Token używany do anulowania operacji odbierania.

Zwraca

Task<TOutput>

Zadanie reprezentujące asynchroniczną operację odbierania. Gdy wartość zostanie pomyślnie odebrana ze źródła, zwrócone zadanie zostanie ukończone i zwróci jego Result wartość. Jeśli nie można pobrać wartości, ponieważ zażądano anulowania, zwrócone zadanie zostanie anulowane. Jeśli nie można pobrać wartości, ponieważ źródło jest puste i ukończone, InvalidOperationException w zwróconym zadaniu zostanie zgłoszony wyjątek.

Wyjątki

ArgumentNullException

source to null.

OperationCanceledException

Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwracanym zadaniu.

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

Źródło:

DataflowBlock.cs

Asynchronicznie odbiera wartość z określonego źródła, obserwując opcjonalny limit czasu.

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)

Parametry typu

TOutput

Typ danych zawartych w źródle.

Parametry

source

ISourceBlock<TOutput>

Źródło, z którego ma zostać odebrana wartość.

timeout

TimeSpan

Maksymalny interwał czasu (w milisekundach) oczekiwania na ukończenie operacji synchronicznej lub interwał reprezentujący -1 milisekundy oczekiwania na czas nieokreślony.

Zwraca

Task<TOutput>

Zadanie reprezentujące asynchroniczną operację odbierania. Gdy wartość zostanie pomyślnie odebrana ze źródła, zwrócone zadanie zostanie ukończone i zwróci jego Result wartość. Jeśli nie można pobrać wartości, ponieważ upłynął limit czasu, zwrócone zadanie zostanie anulowane. Jeśli nie można pobrać wartości, ponieważ źródło jest puste i ukończone, InvalidOperationException w zwróconym zadaniu zostanie zgłoszony wyjątek.

Wyjątki

ArgumentNullException

source to null.

ArgumentOutOfRangeException

timeout jest liczbą ujemną inną niż -1 milisekundy, która reprezentuje nieskończony limit czasu.

-lub-

timeout parametr jest większy niż Int32.MaxValue.

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

Źródło:

DataflowBlock.cs

Asynchronicznie odbiera wartość z określonego źródła, zapewniając token umożliwiający anulowanie operacji i obserwowanie opcjonalnego interwału limitu czasu.

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)

Parametry typu

TOutput

Typ danych zawartych w źródle.

Parametry

source

ISourceBlock<TOutput>

Źródło, z którego ma zostać odebrana wartość.

timeout

TimeSpan

Maksymalny interwał czasu (w milisekundach) oczekiwania na ukończenie operacji synchronicznej lub interwał reprezentujący -1 milisekundy oczekiwania na czas nieokreślony.

cancellationToken

CancellationToken

Token, który może służyć do anulowania operacji odbierania.

Zwraca

Task<TOutput>

Zadanie reprezentujące asynchroniczną operację odbierania. Gdy wartość zostanie pomyślnie odebrana ze źródła, zwrócone zadanie zostanie ukończone i zwróci jego Result wartość. Jeśli nie można pobrać wartości, ponieważ upłynął limit czasu lub zażądano anulowania, zwrócone zadanie zostanie anulowane. Jeśli nie można pobrać wartości, ponieważ źródło jest puste i ukończone, InvalidOperationException zwracany jest wyjątek w zwróconym zadaniu.

Wyjątki

ArgumentNullException

source to null.

ArgumentOutOfRangeException

timeout jest liczbą ujemną inną niż -1 milisekundy, która reprezentuje nieskończony limit czasu.

-lub-

timeout parametr jest większy niż Int32.MaxValue.

OperationCanceledException

Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwracanym zadaniu.