DataflowBlock.ReceiveAsync Méthode

Définition

Espace de noms:

System.Threading.Tasks.Dataflow

Assembly:

System.Threading.Tasks.Dataflow.dll

Paquet:

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

Surcharges

ReceiveAsync<TOutput>(ISourceBlock<TOutput>)	Reçoit de façon asynchrone une valeur d'une source spécifiée.
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, CancellationToken)	Accepte de façon asynchrone une valeur d'une source spécifiée et fournit un jeton pour annuler l'opération.
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan)	Reçoit de façon asynchrone une valeur d'une source spécifiée, en observant un délai d'attente facultatif.
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan, CancellationToken)	Reçoit de façon asynchrone une valeur d'une source spécifiée, en fournissant un jeton pour annuler l'opération et en observant un délai d'attente facultatif.

ReceiveAsync<TOutput>(ISourceBlock<TOutput>)

Source:

DataflowBlock.cs

Reçoit de façon asynchrone une valeur d'une source spécifiée.

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)

Paramètres de type

TOutput

Le type des données contenues dans la source.

Paramètres

source

ISourceBlock<TOutput>

La source à partir de laquelle recevoir la valeur.

Retours

Task<TOutput>

Tâche qui représente l'opération de réception asynchrone. Lorsqu'une valeur d'élément est reçue avec succès depuis la source, la tâche retournée est exécutée et son Result retourne la valeur reçue. Si la valeur d’un élément ne peut pas être récupérée car la source est vide et terminée, une exception InvalidOperationException est levée dans la tâche retournée.

Exceptions

ArgumentNullException

source a la valeur null.

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

Source:

DataflowBlock.cs

Accepte de façon asynchrone une valeur d'une source spécifiée et fournit un jeton pour annuler l'opération.

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)

Paramètres de type

TOutput

Spécifie le type de données contenu dans la source.

Paramètres

source

ISourceBlock<TOutput>

La source à partir de laquelle recevoir la valeur.

cancellationToken

CancellationToken

Le jeton à utiliser pour annuler l'opération de réception.

Retours

Task<TOutput>

Tâche qui représente l'opération de réception asynchrone. Lorsqu'une valeur est correctement reçue de la source, la tâche retournée est terminée et son Result retourne la valeur. Si une valeur ne peut pas être récupérée parce que l'annulation a été demandée, la tâche retournée est annulée. Si la valeur ne peut pas être récupérée car la source est vide et terminée, une exception InvalidOperationException est levée dans la tâche retournée.

Exceptions

ArgumentNullException

source a la valeur null.

OperationCanceledException

Le jeton d’annulation a été annulé. Cette exception est stockée dans la tâche retournée.

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

Source:

DataflowBlock.cs

Reçoit de façon asynchrone une valeur d'une source spécifiée, en observant un délai d'attente facultatif.

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)

Paramètres de type

TOutput

Le type des données contenues dans la source.

Paramètres

source

ISourceBlock<TOutput>

La source à partir de laquelle recevoir la valeur.

timeout

TimeSpan

Intervalle de temps maximum, en millisecondes, à attendre pour que l'exécution synchrone se termine, ou intervalle qui représente -1 milliseconde pour attendre indéfiniment.

Retours

Task<TOutput>

Tâche qui représente l'opération de réception asynchrone. Lorsqu'une valeur est correctement reçue de la source, la tâche retournée est terminée et son Result retourne la valeur. Si une valeur ne peut pas être récupérée car le délai d'attente a expiré, la tâche retournée est annulée. Si la valeur ne peut pas être récupérée car la source est vide et terminée, une exception InvalidOperationException est levée dans la tâche retournée.

Exceptions

ArgumentNullException

source a la valeur null.

ArgumentOutOfRangeException

timeout est un nombre négatif autre que -1 milliseconde, qui représente un délai d'attente infini.

- ou -

timeout est supérieur à Int32.MaxValue.

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

Source:

DataflowBlock.cs

Reçoit de façon asynchrone une valeur d'une source spécifiée, en fournissant un jeton pour annuler l'opération et en observant un délai d'attente facultatif.

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)

Paramètres de type

TOutput

Le type des données contenues dans la source.

Paramètres

source

ISourceBlock<TOutput>

La source à partir de laquelle recevoir la valeur.

timeout

TimeSpan

Intervalle de temps maximum, en millisecondes, à attendre pour que l'exécution synchrone se termine, ou intervalle qui représente -1 milliseconde pour attendre indéfiniment.

cancellationToken

CancellationToken

Le jeton pouvant être utilisé pour annuler l'opération de réception.

Retours

Task<TOutput>

Tâche qui représente l'opération de réception asynchrone. Lorsqu'une valeur est correctement reçue de la source, la tâche retournée est terminée et son Result retourne la valeur. Si une valeur ne peut pas être récupérée parce que le délai d'attente a expiré ou l'annulation a été demandée, la tâche retournée est annulée. Si la valeur ne peut pas être récupérée parce que la source est vide et terminée, une exception InvalidOperationException est levée dans la tâche retournée.

Exceptions

ArgumentNullException

source a la valeur null.

ArgumentOutOfRangeException

timeout est un nombre négatif autre que -1 milliseconde, qui représente un délai d'attente infini.

- ou -

timeout est supérieur à Int32.MaxValue.

OperationCanceledException

Le jeton d’annulation a été annulé. Cette exception est stockée dans la tâche retournée.