DataflowBlock.ReceiveAsync Método

Definição

Sobrecargas

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

De forma assíncrona, recebe um valor de uma fonte especificada.

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

De forma assíncrona, recebe um valor de uma fonte especificada e fornece um token para cancelar a operação.

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

De forma assíncrona, recebe um valor de uma fonte especificada, observando um período opcional de time-out.

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

De forma assíncrona, recebe um valor de uma fonte especificada, fornecendo um token para cancelar a operação e observando um intervalo opcional de time-out.

ReceiveAsync<TOutput>(ISourceBlock<TOutput>)

De forma assíncrona, recebe um valor de uma fonte 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 Genérico

TOutput

O tipo de dados contidos na fonte.

Parâmetros

source
ISourceBlock<TOutput>

A fonte de onde receber o valor.

Devoluções

Task<TOutput>

Uma tarefa que representa a operação de receção assíncrona. Quando um valor de item é recebido com sucesso da fonte, a tarefa devolvida é concluída e devolve Result o valor recebido. Se um valor de item não puder ser recuperado porque a fonte está vazia e concluída , uma InvalidOperationException exceção é lançada na tarefa devolvida.

Exceções

source é null.

Aplica-se a

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

De forma assíncrona, recebe um valor de uma fonte 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 Genérico

TOutput

Especifica o tipo de dados contidos na fonte.

Parâmetros

source
ISourceBlock<TOutput>

A fonte de onde receber o valor.

cancellationToken
CancellationToken

O token a usar para cancelar a operação de receção.

Devoluções

Task<TOutput>

Uma tarefa que representa a operação de receção assíncrona. Quando um valor é recebido com sucesso da fonte, a tarefa devolvida é concluída e devolve Result o valor. Se um valor não puder ser recuperado porque foi solicitado o cancelamento, a tarefa devolvida é cancelada. Se o valor não puder ser recuperado porque a fonte está vazia e concluída , uma InvalidOperationException exceção é lançada na tarefa devolvida.

Exceções

source é null.

O token de cancelamento foi cancelado. Esta exceção é armazenada na tarefa devolvida.

Aplica-se a

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

De forma assíncrona, recebe um valor de uma fonte especificada, observando um período opcional de time-out.

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 Genérico

TOutput

O tipo de dados contidos na fonte.

Parâmetros

source
ISourceBlock<TOutput>

A fonte de onde receber o valor.

timeout
TimeSpan

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

Devoluções

Task<TOutput>

Uma tarefa que representa a operação de receção assíncrona. Quando um valor é recebido com sucesso da fonte, a tarefa devolvida é concluída e devolve Result o valor. Se um valor não puder ser recuperado porque o time-out expirou, a tarefa devolvida é cancelada. Se o valor não puder ser recuperado porque a fonte está vazia e concluída , uma InvalidOperationException exceção é lançada na tarefa devolvida.

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 do que Int32.MaxValue.

Aplica-se a

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

De forma assíncrona, recebe um valor de uma fonte especificada, fornecendo um token para cancelar a operação e observando um intervalo opcional de time-out.

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 Genérico

TOutput

O tipo de dados contidos na fonte.

Parâmetros

source
ISourceBlock<TOutput>

A fonte de onde receber o valor.

timeout
TimeSpan

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

cancellationToken
CancellationToken

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

Devoluções

Task<TOutput>

Uma tarefa que representa a operação de receção assíncrona. Quando um valor é recebido com sucesso da fonte, a tarefa devolvida é concluída e devolve Result o valor. Se um valor não puder ser recuperado porque o time-out expirou ou foi pedido o cancelamento, a tarefa devolvida é cancelada. Se o valor não puder ser recuperado porque a fonte está vazia e concluída, é lançada uma InvalidOperationException exceção na tarefa devolvida.

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 do que Int32.MaxValue.

O token de cancelamento foi cancelado. Esta exceção é armazenada na tarefa devolvida.

Aplica-se a