Freigeben über


DataflowBlock.ReceiveAsync Methode

Definition

Überlädt

ReceiveAsync<TOutput>(ISourceBlock<TOutput>)

Empfängt asynchron einen Wert aus der angegebenen Quelle.

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

Erhält asynchron einen Wert aus einer angegebenen Quelle und stellt ein Token bereit, um die Operation abzubrechen.

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

Empfängt asynchron einen Wert aus einer angegebenen Quelle und beachtet ein optionales Timeout.

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

Empfängt asynchron einen Wert aus einer angegebenen Quelle, stellt ein Token bereit, um den Vorgang abzubrechen und beachtet ein optionales Timeoutintervall.

ReceiveAsync<TOutput>(ISourceBlock<TOutput>)

Quelle:
DataflowBlock.cs
Quelle:
DataflowBlock.cs
Quelle:
DataflowBlock.cs

Empfängt asynchron einen Wert aus der angegebenen Quelle.

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)

Typparameter

TOutput

Der Datentyp, der in der Datenquelle enthalten ist.

Parameter

source
ISourceBlock<TOutput>

Die Quelle, aus der der Wert empfangen werden soll.

Gibt zurück

Task<TOutput>

Eine Aufgabe, die den asynchronen Empfangsvorgang darstellt. Wenn ein Elementwert erfolgreich aus der Quelle empfangen wird, wird die zurückgegebene Aufgabe abgeschlossen, und ihr Result gibt den empfangene Elementwert zurück. Wenn ein Elementwert nicht abgerufen werden kann, weil die Quelle leer ist und abgeschlossen wurde, wird eine InvalidOperationException-Ausnahme in der zurückgegebenen Aufgabe ausgelöst.

Ausnahmen

source ist null

Gilt für:

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

Quelle:
DataflowBlock.cs
Quelle:
DataflowBlock.cs
Quelle:
DataflowBlock.cs

Erhält asynchron einen Wert aus einer angegebenen Quelle und stellt ein Token bereit, um die Operation abzubrechen.

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)

Typparameter

TOutput

Gibt den Datentyp an, der in der Quelle enthalten ist.

Parameter

source
ISourceBlock<TOutput>

Die Quelle, aus der der Wert empfangen werden soll.

cancellationToken
CancellationToken

Das Token, das verwendet wird, um den Empfangsvorgang abzubrechen.

Gibt zurück

Task<TOutput>

Eine Aufgabe, die den asynchronen Empfangsvorgang darstellt. Wenn ein Wert erfolgreich aus der Quelle empfangen wird, wird die zurückgegebene Aufgabe fertig gestellt und ihr Result gibt den Wert zurück. Wenn ein Wert nicht abgerufen werden kann, da ein Abbruch angefordert wurde, wird die zurückgegebene Aufgabe abgebrochen. Wenn der Wert nicht abgerufen werden kann, weil die Quelle leer ist und abgeschlossen wurde, wird eine InvalidOperationException-Ausnahme in der zurückgegebene Aufgabe ausgelöst.

Ausnahmen

source ist null

Das Abbruchtoken wurde abgebrochen. Diese Ausnahme wird in der zurückgegebenen Aufgabe gespeichert.

Gilt für:

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

Quelle:
DataflowBlock.cs
Quelle:
DataflowBlock.cs
Quelle:
DataflowBlock.cs

Empfängt asynchron einen Wert aus einer angegebenen Quelle und beachtet ein optionales Timeout.

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)

Typparameter

TOutput

Der Datentyp, der in der Datenquelle enthalten ist.

Parameter

source
ISourceBlock<TOutput>

Die Quelle, aus der der Wert empfangen werden soll.

timeout
TimeSpan

Das maximale Zeitintervall, in Millisekunden, der gewartet werden muss, bis der synchrone Vorgang abgeschlossen wurde, oder auf ein Intervall, der -1 Millisekunden darstellt, um unbegrenzt zu warten.

Gibt zurück

Task<TOutput>

Eine Aufgabe, die den asynchronen Empfangsvorgang darstellt. Wenn ein Wert erfolgreich aus der Quelle empfangen wird, wird die zurückgegebene Aufgabe fertig gestellt und ihr Result gibt den Wert zurück. Wenn ein Wert nicht abgerufen werden kann, da das Timeout abgelaufen ist, wird die zurückgegebene Aufgabe abgebrochen. Wenn der Wert nicht abgerufen werden kann, weil die Quelle leer ist und abgeschlossen wurde, wird eine InvalidOperationException-Ausnahme in der zurückgegebene Aufgabe ausgelöst.

Ausnahmen

source ist null.

timeout ist eine negative Zahl, aber nicht -1 Millisekunde. Ein Wert von -1 Millisekunde gibt eine Endlostimeoutperiode an.

- oder -

timeout ist größer als Int32.MaxValue.

Gilt für:

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

Quelle:
DataflowBlock.cs
Quelle:
DataflowBlock.cs
Quelle:
DataflowBlock.cs

Empfängt asynchron einen Wert aus einer angegebenen Quelle, stellt ein Token bereit, um den Vorgang abzubrechen und beachtet ein optionales Timeoutintervall.

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)

Typparameter

TOutput

Der Datentyp, der in der Datenquelle enthalten ist.

Parameter

source
ISourceBlock<TOutput>

Die Quelle, aus der der Wert empfangen werden soll.

timeout
TimeSpan

Das maximale Zeitintervall, in Millisekunden, der gewartet werden muss, bis der synchrone Vorgang abgeschlossen wurde, oder auf ein Intervall, der -1 Millisekunden darstellt, um unbegrenzt zu warten.

cancellationToken
CancellationToken

Das Token, das verwendet wird, um den Empfangsvorgang abzubrechen.

Gibt zurück

Task<TOutput>

Eine Aufgabe, die den asynchronen Empfangsvorgang darstellt. Wenn ein Wert erfolgreich aus der Quelle empfangen wird, wird die zurückgegebene Aufgabe fertig gestellt und ihr Result gibt den Wert zurück. Wenn ein Wert nicht abgerufen werden kann, da das Timeout abgelaufen ist oder der Abbruch angefordert wurden, wird die zurückgegebene Aufgabe abgebrochen. Wenn der Wert nicht abgerufen werden kann, weil die Quelle leer und abgeschlossen wurde, wird eine InvalidOperationException Ausnahme in der zurückgegebene Aufgabe ausgelöst.

Ausnahmen

source ist null.

timeout ist eine negative Zahl, aber nicht -1 Millisekunde. Ein Wert von -1 Millisekunde gibt eine Endlostimeoutperiode an.

- oder -

timeout ist größer als Int32.MaxValue.

Das Abbruchtoken wurde abgebrochen. Diese Ausnahme wird in der zurückgegebenen Aufgabe gespeichert.

Gilt für: