IDurableOrchestrationContext.WaitForExternalEvent Método

Definição

Namespace:

Microsoft.Azure.WebJobs.Extensions.DurableTask

Assembly:

Microsoft.Azure.WebJobs.Extensions.DurableTask.dll

Pacote:

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

Sobrecargas

WaitForExternalEvent(String)	Aguarda de forma assíncrona para que um evento seja acionado com o nome name.
WaitForExternalEvent(String, TimeSpan, CancellationToken)	Aguarda de forma assíncrona para que um evento seja acionado com o nome name.
WaitForExternalEvent<T>(String, TimeSpan, CancellationToken)	Aguarda de forma assíncrona que um evento seja acionado com o nome name e retorna os dados do evento.
WaitForExternalEvent<T>(String)	Aguarda de forma assíncrona que um evento seja acionado com o nome name e retorna os dados do evento.
WaitForExternalEvent<T>(String, TimeSpan, T, CancellationToken)	Aguarda de forma assíncrona que um evento seja acionado com o nome name e retorna os dados do evento.

WaitForExternalEvent(String)

Origem:

IDurableOrchestrationContext.cs

Aguarda de forma assíncrona para que um evento seja acionado com o nome 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

Parâmetros

name

String

O nome do evento pelo qual aguardar.

Retornos

Task

Uma tarefa durável que é concluída quando o evento externo é recebido.

Comentários

Clientes externos podem gerar eventos para uma instância de orquestração em espera usando RaiseEventAsync(String, String, Object) com o parâmetro de objeto definido como null.

WaitForExternalEvent(String, TimeSpan, CancellationToken)

Origem:

IDurableOrchestrationContext.cs

Aguarda de forma assíncrona para que um evento seja acionado com o nome 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

Parâmetros

name

String

O nome do evento pelo qual aguardar.

timeout

TimeSpan

A duração após a qual gerar um TimeoutException.

cancelToken

CancellationToken

O CancellationToken a ser usado para cancelar timeouto temporizador interno do .

Retornos

Task

Uma tarefa durável que é concluída quando o evento externo é recebido.

Exceções

TimeoutException

O evento externo não foi recebido antes do tempo limite expirar.

Comentários

Clientes externos podem gerar eventos para uma instância de orquestração em espera usando RaiseEventAsync(String, String, Object) com o parâmetro de objeto definido como null.

WaitForExternalEvent<T>(String, TimeSpan, CancellationToken)

Origem:

IDurableOrchestrationContext.cs

Aguarda de forma assíncrona que um evento seja acionado com o nome name e retorna os dados do evento.

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)

Parâmetros de tipo

T

Qualquer tipo serializável que represente o conteúdo do evento JSON.

Parâmetros

name

String

O nome do evento pelo qual aguardar.

timeout

TimeSpan

A duração do tempo para aguardar o evento.

cancelToken

CancellationToken

O CancellationToken a ser usado para cancelar timeouto temporizador interno do .

Retornos

Task<T>

Uma tarefa durável que é concluída quando o evento externo é recebido ou gera uma exceção de tempo limite"/> se o tempo limite expirar.

Exceções

TimeoutException

O evento externo não foi recebido antes do tempo limite expirar.

Comentários

Clientes externos podem gerar eventos para uma instância de orquestração em espera usando RaiseEventAsync(String, String, Object).

WaitForExternalEvent<T>(String)

Origem:

IDurableOrchestrationContext.cs

Aguarda de forma assíncrona que um evento seja acionado com o nome name e retorna os dados do evento.

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)

Parâmetros de tipo

T

Qualquer tipo serializável que represente o conteúdo do evento JSON.

Parâmetros

name

String

O nome do evento pelo qual aguardar.

Retornos

Task<T>

Uma tarefa durável que é concluída quando o evento externo é recebido.

Comentários

Clientes externos podem gerar eventos para uma instância de orquestração em espera usando RaiseEventAsync(String, String, Object).

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

Origem:

IDurableOrchestrationContext.cs

Aguarda de forma assíncrona que um evento seja acionado com o nome name e retorna os dados do evento.

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)

Parâmetros de tipo

T

Qualquer tipo serializável que represente o conteúdo do evento JSON.

Parâmetros

name

String

O nome do evento pelo qual aguardar.

timeout

TimeSpan

A duração do tempo para aguardar o evento.

defaultValue

T

Se especificado, o valor padrão a ser retornado se o tempo limite expirar antes do evento externo ser recebido. Caso contrário, uma exceção de tempo limite será gerada.

cancelToken

CancellationToken

O CancellationToken a ser usado para cancelar timeouto temporizador interno do .

Retornos

Task<T>

Uma tarefa durável que é concluída quando o evento externo é recebido ou retorna o valor de defaultValue se o tempo limite expirar.

Comentários

Clientes externos podem gerar eventos para uma instância de orquestração em espera usando RaiseEventAsync(String, String, Object).