DataflowBlock.ReceiveAsync Método

Definição

Sobrecargas

Nome Description
ReceiveAsync<TOutput>(ISourceBlock<TOutput>)

Recebe de forma assíncrona um valor de uma origem especificada.

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

Recebe de forma assíncrona um valor de uma origem especificada e fornece um token para cancelar a operação.

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

Recebe de forma assíncrona um valor de uma origem especificada, observando um período de tempo limite opcional.

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

Recebe de forma assíncrona um valor de uma origem especificada, fornecendo um token para cancelar a operação e observando um intervalo de tempo limite opcional.

ReceiveAsync<TOutput>(ISourceBlock<TOutput>)

Recebe de forma assíncrona um valor de uma origem especificada.

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)

Parâmetros de tipo

TOutput

O tipo de dados contido na origem.

Parâmetros

source
ISourceBlock<TOutput>

A origem da qual receber o valor.

Retornos

Task<TOutput>

Uma tarefa que representa a operação de recebimento assíncrono. Quando um valor de item é recebido com êxito da origem, a tarefa retornada é concluída e Result retorna o valor recebido. Se um valor de item não puder ser recuperado porque a origem está vazia e concluída, uma exceção InvalidOperationException é gerada na tarefa retornada.

Exceções

source é null.

Aplica-se a

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

Recebe de forma assíncrona um valor de uma origem especificada e fornece um token para cancelar a operação.

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)

Parâmetros de tipo

TOutput

Especifica o tipo de dados contidos na origem.

Parâmetros

source
ISourceBlock<TOutput>

A origem da qual receber o valor.

cancellationToken
CancellationToken

O token a ser usado para cancelar a operação de recebimento.

Retornos

Task<TOutput>

Uma tarefa que representa a operação de recebimento assíncrono. Quando um valor é recebido com êxito da origem, a tarefa retornada é concluída e Result retorna o valor. Se um valor não puder ser recuperado porque o cancelamento foi solicitado, a tarefa retornada será cancelada. Se o valor não puder ser recuperado porque a origem está vazia e concluída, uma exceção InvalidOperationException é gerada na tarefa retornada.

Exceções

source é null.

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Aplica-se a

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

Recebe de forma assíncrona um valor de uma origem especificada, observando um período de tempo limite opcional.

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)

Parâmetros de tipo

TOutput

O tipo de dados contido na origem.

Parâmetros

source
ISourceBlock<TOutput>

A origem da qual receber o valor.

timeout
TimeSpan

O intervalo de tempo máximo, em milissegundos, para aguardar a conclusão da operação síncrona ou um intervalo que represente -1 milissegundos aguardar indefinidamente.

Retornos

Task<TOutput>

Uma tarefa que representa a operação de recebimento assíncrono. Quando um valor é recebido com êxito da origem, a tarefa retornada é concluída e Result retorna o valor. Se um valor não puder ser recuperado porque o tempo limite expirou, a tarefa retornada será cancelada. Se o valor não puder ser recuperado porque a origem está vazia e concluída, uma exceção InvalidOperationException é gerada na tarefa retornada.

Exceções

source é null.

timeout é um número negativo diferente de -1 milissegundos, que representa um período de tempo limite infinito.

-ou-

timeout é maior que Int32.MaxValue.

Aplica-se a

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

Recebe de forma assíncrona um valor de uma origem especificada, fornecendo um token para cancelar a operação e observando um intervalo de tempo limite opcional.

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)

Parâmetros de tipo

TOutput

O tipo de dados contido na origem.

Parâmetros

source
ISourceBlock<TOutput>

A origem da qual receber o valor.

timeout
TimeSpan

O intervalo de tempo máximo, em milissegundos, para aguardar a conclusão da operação síncrona ou um intervalo que represente -1 milissegundos aguardar indefinidamente.

cancellationToken
CancellationToken

O token que pode ser usado para cancelar a operação de recebimento.

Retornos

Task<TOutput>

Uma tarefa que representa a operação de recebimento assíncrono. Quando um valor é recebido com êxito da origem, a tarefa retornada é concluída e Result retorna o valor. Se um valor não puder ser recuperado porque o tempo limite expirou ou o cancelamento foi solicitado, a tarefa retornada será cancelada. Se o valor não puder ser recuperado porque a origem está vazia e concluída, uma exceção InvalidOperationException é gerada na tarefa retornada.

Exceções

source é null.

timeout é um número negativo diferente de -1 milissegundos, que representa um período de tempo limite infinito.

-ou-

timeout é maior que Int32.MaxValue.

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Aplica-se a