DataflowBlock.SendAsync Méthode

Définition

Espace de noms:

System.Threading.Tasks.Dataflow

Assembly:

System.Threading.Tasks.Dataflow.dll

Surcharges

SendAsync<TInput>(ITargetBlock<TInput>, TInput, CancellationToken)	Propose de façon asynchrone un message au bloc de message cible, en autorisant l'ajournement.
SendAsync<TInput>(ITargetBlock<TInput>, TInput)	Propose de façon asynchrone un message au bloc de message cible, en autorisant l'ajournement.

SendAsync<TInput>(ITargetBlock<TInput>, TInput, CancellationToken)

Source:

DataflowBlock.cs

Propose de façon asynchrone un message au bloc de message cible, en autorisant l'ajournement.

public:
generic <typename TInput>
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task<bool> ^ SendAsync(System::Threading::Tasks::Dataflow::ITargetBlock<TInput> ^ target, TInput item, System::Threading::CancellationToken cancellationToken);

public static System.Threading.Tasks.Task<bool> SendAsync<TInput> (this System.Threading.Tasks.Dataflow.ITargetBlock<TInput> target, TInput item, System.Threading.CancellationToken cancellationToken);

static member SendAsync : System.Threading.Tasks.Dataflow.ITargetBlock<'Input> * 'Input * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>

<Extension()>
Public Function SendAsync(Of TInput) (target As ITargetBlock(Of TInput), item As TInput, cancellationToken As CancellationToken) As Task(Of Boolean)

Paramètres de type

TInput

Spécifie le type des données à publier sur la cible.

Paramètres

target

ITargetBlock<TInput>

Cible dans laquelle publier les données.

item

TInput

Élément qui est proposé à la cible.

cancellationToken

CancellationToken

Jeton d'annulation utilisé pour demander l'annulation de l'opération d'envoi.

Retours

Task<Boolean>

Task<TResult> qui représente l'envoi asynchrone. Si la cible accepte et consomme l’élément proposé pendant l’appel à SendAsync, à la retour de l’appel, le résultat Task<TResult> est terminé et sa Result propriété retourne true. Si la cible refuse l’élément proposé pendant l’appel, à la reprise de l’appel, le résultat Task<TResult> est terminé et sa Result propriété retourne false. Si la cible reporte l’élément proposé, l’élément est mis en mémoire tampon jusqu’à ce que la cible l’utilise ou le libère, auquel moment la tâche se termine, avec son Result indiquant si le message a été consommé. Si la cible n'essaie jamais de consommer ou de libérer le message, la tâche retournée ne se terminera jamais.

Si l'annulation est demandée avant que la cible n'ait consommé avec succès les données envoyées, la tâche retournée se terminera à l'état d'annulation et les données ne seront plus disponibles pour la cible.

Exceptions

ArgumentNullException

a la target valeur Null (Nothing en Visual Basic).

OperationCanceledException

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

SendAsync<TInput>(ITargetBlock<TInput>, TInput)

Source:

DataflowBlock.cs

Propose de façon asynchrone un message au bloc de message cible, en autorisant l'ajournement.

public:
generic <typename TInput>
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task<bool> ^ SendAsync(System::Threading::Tasks::Dataflow::ITargetBlock<TInput> ^ target, TInput item);

public static System.Threading.Tasks.Task<bool> SendAsync<TInput> (this System.Threading.Tasks.Dataflow.ITargetBlock<TInput> target, TInput item);

static member SendAsync : System.Threading.Tasks.Dataflow.ITargetBlock<'Input> * 'Input -> System.Threading.Tasks.Task<bool>

<Extension()>
Public Function SendAsync(Of TInput) (target As ITargetBlock(Of TInput), item As TInput) As Task(Of Boolean)

Paramètres de type

TInput

Spécifie le type des données à publier sur la cible.

Paramètres

target

ITargetBlock<TInput>

Cible dans laquelle publier les données.

item

TInput

Élément qui est proposé à la cible.

Retours

Task<Boolean>

Task<TResult> qui représente l'envoi asynchrone. Si la cible accepte et consomme l'élément proposé pendant l'appel à SendAsync<TInput>(ITargetBlock<TInput>, TInput), au retour de l'appel la Task<TResult> résultante sera terminée et sa propriété Result retournera la valeur true. Si la cible refuse l'élément proposé pendant l'appel, au retour de l'appel la Task<TResult> résultante sera terminée et sa propriété Result retournera la valeur false. Si la cible diffère l'élément proposé, l'élément sera mis en mémoire tampon jusqu'au moment où la cible le consomme ou le libère. À ce moment-là, la tâche se terminera, avec son Result indiquant si le message a été consommé. Si la cible n'essaie jamais de consommer ou de libérer le message, la tâche retournée ne se terminera jamais.

Exceptions

ArgumentNullException

Le target est null.