IDurableOrchestrationContext.WaitForExternalEvent Methode

Definition

Namespace:

Microsoft.Azure.WebJobs.Extensions.DurableTask

Assembly:

Microsoft.Azure.WebJobs.Extensions.DurableTask.dll

Paket:

Microsoft.Azure.WebJobs.Extensions.DurableTask v2.8.1

Überlädt

WaitForExternalEvent(String)	Wartet asynchron, bis ein Ereignis mit dem Namen nameausgelöst wird.
WaitForExternalEvent(String, TimeSpan, CancellationToken)	Wartet asynchron, bis ein Ereignis mit dem Namen nameausgelöst wird.
WaitForExternalEvent<T>(String, TimeSpan, CancellationToken)	Wartet asynchron, bis ein Ereignis mit dem Namen name ausgelöst wird, und gibt die Ereignisdaten zurück.
WaitForExternalEvent<T>(String)	Wartet asynchron, bis ein Ereignis mit dem Namen name ausgelöst wird, und gibt die Ereignisdaten zurück.
WaitForExternalEvent<T>(String, TimeSpan, T, CancellationToken)	Wartet asynchron, bis ein Ereignis mit dem Namen name ausgelöst wird, und gibt die Ereignisdaten zurück.

WaitForExternalEvent(String)

Quelle:

IDurableOrchestrationContext.cs

Wartet asynchron, bis ein Ereignis mit dem Namen nameausgelöst wird.

public System.Threading.Tasks.Task WaitForExternalEvent (string name);

abstract member WaitForExternalEvent : string -> System.Threading.Tasks.Task

Public Function WaitForExternalEvent (name As String) As Task

Parameter

name

String

Der Name des Ereignisses, auf das gewartet werden soll.

Gibt zurück

Task

Eine dauerhafte Aufgabe, die abgeschlossen wird, wenn das externe Ereignis empfangen wird.

Hinweise

Externe Clients können Ereignisse für eine Warteorchestrierung instance mit RaiseEventAsync(String, String, Object) auslösen, wobei der Objektparameter auf nullfestgelegt ist.

WaitForExternalEvent(String, TimeSpan, CancellationToken)

Quelle:

IDurableOrchestrationContext.cs

Wartet asynchron, bis ein Ereignis mit dem Namen nameausgelöst wird.

public System.Threading.Tasks.Task WaitForExternalEvent (string name, TimeSpan timeout, System.Threading.CancellationToken cancelToken = default);

abstract member WaitForExternalEvent : string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function WaitForExternalEvent (name As String, timeout As TimeSpan, Optional cancelToken As CancellationToken = Nothing) As Task

Parameter

name

String

Der Name des Ereignisses, auf das gewartet werden soll.

timeout

TimeSpan

Die Dauer, nach der eine TimeoutException ausgelöst werden soll.

cancelToken

CancellationToken

Die CancellationToken , die zum Abbrechen timeoutdes internen Timers verwendet werden soll.

Gibt zurück

Task

Eine dauerhafte Aufgabe, die abgeschlossen wird, wenn das externe Ereignis empfangen wird.

Ausnahmen

TimeoutException

Das externe Ereignis wurde nicht empfangen, bevor das Timeout abgelaufen ist.

Hinweise

Externe Clients können Ereignisse für eine Warteorchestrierung instance mit RaiseEventAsync(String, String, Object) auslösen, wobei der Objektparameter auf nullfestgelegt ist.

WaitForExternalEvent<T>(String, TimeSpan, CancellationToken)

Quelle:

IDurableOrchestrationContext.cs

Wartet asynchron, bis ein Ereignis mit dem Namen name ausgelöst wird, und gibt die Ereignisdaten zurück.

public System.Threading.Tasks.Task<T> WaitForExternalEvent<T> (string name, TimeSpan timeout, System.Threading.CancellationToken cancelToken = default);

abstract member WaitForExternalEvent : string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'T>

Public Function WaitForExternalEvent(Of T) (name As String, timeout As TimeSpan, Optional cancelToken As CancellationToken = Nothing) As Task(Of T)

Typparameter

T

Jeder serialisierbare Typ, der die JSON-Ereignisnutzlast darstellt.

Parameter

name

String

Der Name des Ereignisses, auf das gewartet werden soll.

timeout

TimeSpan

Die Dauer des Wartens auf das Ereignis.

cancelToken

CancellationToken

Die CancellationToken , die zum Abbrechen timeoutdes internen Timers verwendet werden soll.

Gibt zurück

Task<T>

Eine dauerhafte Aufgabe, die abgeschlossen wird, wenn das externe Ereignis empfangen wird, oder löst eine Timeoutausnahme aus" /> aus, wenn das Timeout abläuft.

Ausnahmen

TimeoutException

Das externe Ereignis wurde nicht empfangen, bevor das Timeout abgelaufen ist.

Hinweise

Externe Clients können mithilfe von RaiseEventAsync(String, String, Object)Ereignisse für eine wartende Orchestrierung instance auslösen.

WaitForExternalEvent<T>(String)

Quelle:

IDurableOrchestrationContext.cs

Wartet asynchron, bis ein Ereignis mit dem Namen name ausgelöst wird, und gibt die Ereignisdaten zurück.

public System.Threading.Tasks.Task<T> WaitForExternalEvent<T> (string name);

abstract member WaitForExternalEvent : string -> System.Threading.Tasks.Task<'T>

Public Function WaitForExternalEvent(Of T) (name As String) As Task(Of T)

Typparameter

T

Jeder serialisierbare Typ, der die JSON-Ereignisnutzlast darstellt.

Parameter

name

String

Der Name des Ereignisses, auf das gewartet werden soll.

Gibt zurück

Task<T>

Eine dauerhafte Aufgabe, die abgeschlossen wird, wenn das externe Ereignis empfangen wird.

Hinweise

Externe Clients können mithilfe von RaiseEventAsync(String, String, Object)Ereignisse für eine wartende Orchestrierung instance auslösen.

WaitForExternalEvent<T>(String, TimeSpan, T, CancellationToken)

Quelle:

IDurableOrchestrationContext.cs

Wartet asynchron, bis ein Ereignis mit dem Namen name ausgelöst wird, und gibt die Ereignisdaten zurück.

public System.Threading.Tasks.Task<T> WaitForExternalEvent<T> (string name, TimeSpan timeout, T defaultValue, System.Threading.CancellationToken cancelToken = default);

abstract member WaitForExternalEvent : string * TimeSpan * 'T * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'T>

Public Function WaitForExternalEvent(Of T) (name As String, timeout As TimeSpan, defaultValue As T, Optional cancelToken As CancellationToken = Nothing) As Task(Of T)

Typparameter

T

Jeder serialisierbare Typ, der die JSON-Ereignisnutzlast darstellt.

Parameter

name

String

Der Name des Ereignisses, auf das gewartet werden soll.

timeout

TimeSpan

Die Dauer des Wartens auf das Ereignis.

defaultValue

T

Wenn angegeben, der Standardwert, der zurückgegeben werden soll, wenn das Timeout abläuft, bevor das externe Ereignis empfangen wird. Andernfalls wird stattdessen eine Timeoutausnahme ausgelöst.

cancelToken

CancellationToken

Die CancellationToken , die zum Abbrechen timeoutdes internen Timers verwendet werden soll.

Gibt zurück

Task<T>

Eine dauerhafte Aufgabe, die abgeschlossen wird, wenn das externe Ereignis empfangen wird, oder den Wert von defaultValue zurückgibt, wenn das Timeout abläuft.

Hinweise

Externe Clients können mithilfe von RaiseEventAsync(String, String, Object)Ereignisse für eine wartende Orchestrierung instance auslösen.