DataflowBlock.ReceiveAsync Metoda

Definice

Obor názvů:

System.Threading.Tasks.Dataflow

Sestavení:

System.Threading.Tasks.Dataflow.dll

Balíček:

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

Přetížení

ReceiveAsync<TOutput>(ISourceBlock<TOutput>)	Asynchronně obdrží hodnotu ze zadaného zdroje.
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, CancellationToken)	Asynchronně přijímá hodnotu ze zadaného zdroje a poskytuje token pro zrušení operace.
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan)	Asynchronně přijímá hodnotu ze zadaného zdroje a sleduje volitelné období časového limitu.
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan, CancellationToken)	Asynchronně přijímá hodnotu ze zadaného zdroje, poskytuje token pro zrušení operace a sleduje volitelný interval časového limitu.

ReceiveAsync<TOutput>(ISourceBlock<TOutput>)

Zdroj:

DataflowBlock.cs

Asynchronně obdrží hodnotu ze zadaného zdroje.

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 dat obsažených ve zdroji.

Parametry

source

ISourceBlock<TOutput>

Zdroj, ze kterého chcete získat hodnotu.

Návraty

Task<TOutput>

Úloha, která představuje asynchronní operaci příjmu. Když je hodnota položky úspěšně přijata ze zdroje, vrácená úloha je dokončena a Result vrátí přijatou hodnotu. Pokud hodnotu položky nelze načíst, protože zdroj je prázdný a dokončený , InvalidOperationException je vyvolán výjimka ve vrácené úloze.

Výjimky

ArgumentNullException

source je null.

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

Zdroj:

DataflowBlock.cs

Asynchronně přijímá hodnotu ze zadaného zdroje a poskytuje token pro zrušení operace.

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

Určuje typ dat obsažených ve zdroji.

Parametry

source

ISourceBlock<TOutput>

Zdroj, ze kterého chcete získat hodnotu.

cancellationToken

CancellationToken

Token, který se má použít ke zrušení operace příjmu.

Návraty

Task<TOutput>

Úloha, která představuje asynchronní operaci příjmu. Po úspěšném přijetí hodnoty ze zdroje je vrácená úloha dokončena a Result vrátí hodnotu . Pokud hodnotu nelze načíst, protože bylo požadováno zrušení, vrácená úloha je zrušena. Pokud hodnotu nelze načíst, protože zdroj je prázdný a dokončený , InvalidOperationException vyvolá se ve vrácené úloze výjimka.

Výjimky

ArgumentNullException

source je null.

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka se uloží do vrácené úlohy.

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

Zdroj:

DataflowBlock.cs

Asynchronně přijímá hodnotu ze zadaného zdroje a sleduje volitelné období časového limitu.

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 dat obsažených ve zdroji.

Parametry

source

ISourceBlock<TOutput>

Zdroj, ze kterého chcete získat hodnotu.

timeout

TimeSpan

Maximální časový interval v milisekundách, který se má čekat na dokončení synchronní operace, nebo interval představující -1 milisekund, který má čekat neomezeně dlouho.

Návraty

Task<TOutput>

Úloha, která představuje asynchronní operaci příjmu. Po úspěšném přijetí hodnoty ze zdroje je vrácená úloha dokončena a Result vrátí hodnotu . Pokud hodnotu nelze načíst, protože vypršel časový limit, vrácený úkol je zrušen. Pokud hodnotu nelze načíst, protože zdroj je prázdný a dokončený , InvalidOperationException vyvolá se ve vrácené úloze výjimka.

Výjimky

ArgumentNullException

source je null.

ArgumentOutOfRangeException

timeout je záporné číslo jiné než -1 milisekund, které představuje nekonečnou dobu časového limitu.

-nebo-

timeout je větší než Int32.MaxValue.

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

Zdroj:

DataflowBlock.cs

Asynchronně přijímá hodnotu ze zadaného zdroje, poskytuje token pro zrušení operace a sleduje volitelný interval časového limitu.

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 dat obsažených ve zdroji.

Parametry

source

ISourceBlock<TOutput>

Zdroj, ze kterého chcete získat hodnotu.

timeout

TimeSpan

Maximální časový interval v milisekundách, který se má čekat na dokončení synchronní operace, nebo interval představující -1 milisekund, který má čekat neomezeně dlouho.

cancellationToken

CancellationToken

Token, který lze použít ke zrušení operace příjmu.

Návraty

Task<TOutput>

Úloha, která představuje asynchronní operaci příjmu. Po úspěšném přijetí hodnoty ze zdroje je vrácená úloha dokončena a Result vrátí hodnotu . Pokud hodnotu nelze načíst, protože vypršel časový limit nebo bylo požadováno zrušení, vrácený úkol je zrušen. Pokud hodnotu nelze načíst, protože zdroj je prázdný a dokončený, InvalidOperationException je ve vrácené úloze vyvoláno výjimka.

Výjimky

ArgumentNullException

source je null.

ArgumentOutOfRangeException

timeout je záporné číslo jiné než -1 milisekund, které představuje nekonečnou dobu časového limitu.

-nebo-

timeout je větší než Int32.MaxValue.

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka se uloží do vrácené úlohy.