DataflowBlock.ReceiveAsync Método

Definição

Namespace:

System.Threading.Tasks.Dataflow

Assembly:

System.Threading.Tasks.Dataflow.dll

Pacote:

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

Sobrecargas

ReceiveAsync<TOutput>(ISourceBlock<TOutput>)	Recebe assincronamente um valor de uma origem especificada.
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, CancellationToken)	Recebe assincronamente um valor de uma origem especificada e fornece um token para cancelar a operação.
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan)	Recebe assincronamente um valor de uma origem especificada, observando um período de tempo limite opcional.
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan, CancellationToken)	Recebe assincronamente um valor de uma fonte especificada, fornecendo um token para cancelar a operação e observando um intervalo de tempo limite opcional.

ReceiveAsync<TOutput>(ISourceBlock<TOutput>)

Origem:

DataflowBlock.cs

Recebe assincronamente 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 o valor será recebido.

Retornos

Task<TOutput>

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

Exceções

ArgumentNullException

source é null.

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

Origem:

DataflowBlock.cs

Recebe assincronamente 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 o valor será recebido.

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íncrona. Quando um valor é recebido com êxito da origem, a tarefa retornada é concluída e seu 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 fonte está vazia e concluída, uma exceção InvalidOperationException será gerada na tarefa retornada.

Exceções

ArgumentNullException

source é null.

OperationCanceledException

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

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

Origem:

DataflowBlock.cs

Recebe assincronamente 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 o valor será recebido.

timeout

TimeSpan

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

Retornos

Task<TOutput>

Uma tarefa que representa a operação de recebimento assíncrona. Quando um valor é recebido com êxito da origem, a tarefa retornada é concluída e seu 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 fonte está vazia e concluída, uma exceção InvalidOperationException será gerada na tarefa retornada.

Exceções

ArgumentNullException

source é null.

ArgumentOutOfRangeException

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

- ou -

timeout é maior que Int32.MaxValue.

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

Origem:

DataflowBlock.cs

Recebe assincronamente um valor de uma fonte 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 o valor será recebido.

timeout

TimeSpan

O intervalo de tempo máximo, em milissegundos, de espera para a operação síncrona ser concluída ou um intervalo que representa -1 milissegundos para 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íncrona. Quando um valor é recebido com êxito da origem, a tarefa retornada é concluída e seu 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 fonte está vazia e concluída, uma exceção InvalidOperationException será gerada na tarefa retornada.

Exceções

ArgumentNullException

source é null.

ArgumentOutOfRangeException

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

- ou -

timeout é maior que Int32.MaxValue.

OperationCanceledException

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