IDurableOrchestrationContext.WaitForExternalEvent メソッド

定義

名前空間:

Microsoft.Azure.WebJobs.Extensions.DurableTask

アセンブリ:

Microsoft.Azure.WebJobs.Extensions.DurableTask.dll

パッケージ:

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

オーバーロード

WaitForExternalEvent(String)	という名前のイベントが発生するまで非同期的に待機します name。
WaitForExternalEvent(String, TimeSpan, CancellationToken)	という名前のイベントが発生するまで非同期的に待機します name。
WaitForExternalEvent<T>(String, TimeSpan, CancellationToken)	名前 name でイベントが発生するまで非同期的に待機し、イベント データを返します。
WaitForExternalEvent<T>(String)	名前 name でイベントが発生するまで非同期的に待機し、イベント データを返します。
WaitForExternalEvent<T>(String, TimeSpan, T, CancellationToken)	名前 name でイベントが発生するまで非同期的に待機し、イベント データを返します。

WaitForExternalEvent(String)

ソース:

IDurableOrchestrationContext.cs

という名前のイベントが発生するまで非同期的に待機します name。

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

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

Public Function WaitForExternalEvent (name As String) As Task

パラメーター

name

String

待機するイベントの名前。

戻り値

Task

外部イベントの受信時に完了する永続的なタスク。

注釈

外部クライアントは、 オブジェクト パラメーターを に設定して を使用して RaiseEventAsync(String, String, Object) 、待機中のオーケストレーション インスタンスにイベントを null発生させることができます。

WaitForExternalEvent(String, TimeSpan, CancellationToken)

ソース:

IDurableOrchestrationContext.cs

という名前のイベントが発生するまで非同期的に待機します name。

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

パラメーター

name

String

待機するイベントの名前。

timeout

TimeSpan

TimeoutException をスローするまでの時間。

cancelToken

CancellationToken

の CancellationToken 内部タイマーを取り消すために timeout使用する 。

戻り値

Task

外部イベントの受信時に完了する永続的なタスク。

例外

TimeoutException

タイムアウトの期限が切れる前に、外部イベントが受信されませんでした。

注釈

外部クライアントは、 オブジェクト パラメーターを に設定して を使用して RaiseEventAsync(String, String, Object) 、待機中のオーケストレーション インスタンスにイベントを null発生させることができます。

WaitForExternalEvent<T>(String, TimeSpan, CancellationToken)

ソース:

IDurableOrchestrationContext.cs

名前 name でイベントが発生するまで非同期的に待機し、イベント データを返します。

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)

型パラメーター

T

JSON イベント ペイロードを表すシリアル化可能な任意の型。

パラメーター

name

String

待機するイベントの名前。

timeout

TimeSpan

イベントを待機する時間。

cancelToken

CancellationToken

の CancellationToken 内部タイマーを取り消すために timeout使用する 。

戻り値

Task<T>

外部イベントの受信時に完了するか、タイムアウトの有効期限が切れた場合にタイムアウト例外を> スローする永続的なタスク。

例外

TimeoutException

タイムアウトの期限が切れる前に、外部イベントが受信されませんでした。

注釈

外部クライアントは、 を使用して RaiseEventAsync(String, String, Object)待機中のオーケストレーション インスタンスにイベントを発生させることができます。

WaitForExternalEvent<T>(String)

ソース:

IDurableOrchestrationContext.cs

名前 name でイベントが発生するまで非同期的に待機し、イベント データを返します。

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)

型パラメーター

T

JSON イベント ペイロードを表すシリアル化可能な任意の型。

パラメーター

name

String

待機するイベントの名前。

戻り値

Task<T>

外部イベントの受信時に完了する永続的なタスク。

注釈

外部クライアントは、 を使用して RaiseEventAsync(String, String, Object)待機中のオーケストレーション インスタンスにイベントを発生させることができます。

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

ソース:

IDurableOrchestrationContext.cs

名前 name でイベントが発生するまで非同期的に待機し、イベント データを返します。

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)

型パラメーター

T

JSON イベント ペイロードを表すシリアル化可能な任意の型。

パラメーター

name

String

待機するイベントの名前。

timeout

TimeSpan

イベントを待機する時間。

defaultValue

T

指定した場合、外部イベントを受信する前にタイムアウトが切れた場合に返される既定値。 それ以外の場合は、代わりにタイムアウト例外がスローされます。

cancelToken

CancellationToken

の CancellationToken 内部タイマーを取り消すために timeout使用する 。

戻り値

Task<T>

外部イベントの受信時に完了する永続的なタスク。タイムアウトが切れた場合は の defaultValue 値を返します。

注釈

外部クライアントは、 を使用して RaiseEventAsync(String, String, Object)待機中のオーケストレーション インスタンスにイベントを発生させることができます。