@azure/core-amqp package
Classes
| CbsClient |
Descreve o cliente EventHub/ServiceBus Cbs que conversa com o ponto de extremidade $cbs pela conexão AMQP. |
| MessagingError |
Descreve a classe base para Erro de Mensagens. |
| RequestResponseLink |
Descreve um link amqp request(sender)-response(receiver) criado em uma sessão amqp. |
Interfaces
| AcquireLockProperties |
Descreve as propriedades que devem ser fornecidas durante a aquisição de um bloqueio. |
| AmqpAnnotatedMessage |
Descreve o AmqpAnnotatedMessage, parte da propriedade ServiceBusReceivedMessage(as |
| AmqpMessageHeader |
Descreve o conjunto definido de propriedades de cabeçalho padrão da mensagem. |
| AmqpMessageProperties |
Descreve o conjunto definido de propriedades padrão da mensagem. |
| CancellableAsyncLock |
CancellableAsyncLock fornece um mecanismo para forçar tarefas usando a mesma "chave" a serem executadas serialmente. Tarefas pendentes podem ser canceladas manualmente por meio de um abortSignal ou canceladas automaticamente, atingindo um valor de tempo limite fornecido. |
| CbsResponse |
Descreve a resposta da CBS. |
| ConnectionConfig |
Descreve o objeto de configuração de conexão criado após a análise de uma cadeia de conexão EventHub ou ServiceBus. |
| ConnectionConfigOptions |
Descreve as opções que podem ser fornecidas durante a criação de uma configuração de conexão. |
| ConnectionContextBase |
Fornece informações contextuais, como a conexão amqp subjacente, sessão cbs, tokenProvider, configuração de conexão, transformador de dados etc. |
| ConnectionProperties |
Define as propriedades que precisam ser definidas ao estabelecer a conexão AMQP. |
| CreateConnectionContextBaseParameters |
Descreve os parâmetros que podem ser fornecidos para criar o contexto de conexão base. |
| NetworkSystemError |
Descreve os campos em uma Node.js SystemError. Omite campos que não estão relacionados a chamadas de rede (por exemplo, chamadas do sistema de arquivos). Consulte https://nodejs.org/dist/latest-v12.x/docs/api/errors.html#errors_class_systemerror |
| RetryConfig |
Descreve os parâmetros que precisam ser configurados para a operação de repetição. |
| RetryOptions |
Opções de política de repetição que determinam o modo, o número de repetições, o intervalo de repetição etc. |
| SendRequestOptions |
Descreve as opções que podem ser especificadas ao enviar uma solicitação. |
| WebSocketOptions |
Opções para configurar a canalização da conexão AMQP por meio de Soquetes Web. |
Aliases de tipo
| ParsedOutput |
Define um objeto com possíveis propriedades definidas em T. |
Enumerações
| ConditionErrorNameMapper |
Mapeia as condições de erro amqp para os nomes de erro. |
| ErrorNameConditionMapper |
Mapeia os nomes de erro para as condições de erro amqp. |
| RetryMode |
Descreve o tipo de Modo de Repetição |
| RetryOperationType |
Descreve o tipo de operação de repetição. |
| SystemErrorConditionMapper |
Mapeia alguns SystemErrors para condições de erro amqp |
| TokenType |
Descreve o tipo de tokens com suporte. |
Funções
| delay<T>(number, Abort |
Um wrapper para setTimeout que resolve uma promessa após milissegundos. |
| is |
Determina se um erro é um MessagingError. |
| is |
Verifica se o erro fornecido é uma node.js SystemError. |
| parse |
Analisa a cadeia de conexão e retorna um objeto do tipo T. As cadeias de conexão têm a seguinte sintaxe: ConnectionString ::= |
| retry<T>(Retry |
Todas as operações são tentadas pelo menos uma vez. Tentativas adicionais são feitas se a tentativa anterior falhou com um erro retrátivel. O número de tentativas adicionais é regido pela propriedade Se Se |
| translate(unknown) | Converte o erro AMQP recebido na camada de protocolo ou em um SystemError em um MessagingError. Todos os outros erros são retornados sem filtro. |
Detalhes da função
delay<T>(number, AbortSignalLike, string, T)
Um wrapper para setTimeout que resolve uma promessa após milissegundos.
function delay<T>(delayInMs: number, abortSignal?: AbortSignalLike, abortErrorMsg?: string, value?: T): Promise<T | void>
Parâmetros
- delayInMs
-
number
O número de milissegundos a serem atrasados.
- abortSignal
- AbortSignalLike
O abortSignal associado à operação de contenção.
- abortErrorMsg
-
string
A mensagem de erro de anulação associada à operação de contenção.
- value
-
T
O valor a ser resolvido após um tempo limite de t milissegundos.
Retornos
Promise<T | void>
- Promessa resolvida
isMessagingError(MessagingError | Error)
Determina se um erro é um MessagingError.
function isMessagingError(error: MessagingError | Error): error
Parâmetros
- error
-
MessagingError | Error
Um erro que pode ser um Erro ou um MessagingError.
Retornos
error
isSystemError(unknown)
Verifica se o erro fornecido é uma node.js SystemError.
function isSystemError(err: unknown): err
Parâmetros
- err
-
unknown
Um objeto que pode conter informações de erro.
Retornos
err
parseConnectionString<T>(string)
Analisa a cadeia de conexão e retorna um objeto do tipo T.
As cadeias de conexão têm a seguinte sintaxe:
ConnectionString ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] Parte ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? qualquer sequência de caracteres, exceto ; ou = ou WhiteSpace?
Espaço em branco ::= ? todos os caracteres de espaço em branco, incluindo \r e \n?
function parseConnectionString<T>(connectionString: string): ParsedOutput<T>
Parâmetros
- connectionString
-
string
A cadeia de conexão a ser analisada.
Retornos
ParsedOutput<T>
ParsedOutput<T>.
retry<T>(RetryConfig<T>)
Todas as operações são tentadas pelo menos uma vez. Tentativas adicionais são feitas se a tentativa anterior falhou com um erro retrátivel. O número de tentativas adicionais é regido pela propriedade maxRetries fornecida no argumento RetryConfig.
Se mode opção estiver definida como Fixed, as novas tentativas serão feitas na operação determinada por um número especificado de vezes, com um atraso fixo entre cada repetição a cada vez.
Se mode opção estiver definida como Exponential, o atraso entre novas tentativas será ajustado para aumentar exponencialmente com cada tentativa usando o fator de retirada da potência 2.
function retry<T>(config: RetryConfig<T>): Promise<T>
Parâmetros
- config
-
RetryConfig<T>
Parâmetros para configurar a operação de repetição
Retornos
Promise<T>
Promessa<T>.
translate(unknown)
Converte o erro AMQP recebido na camada de protocolo ou em um SystemError em um MessagingError. Todos os outros erros são retornados sem filtro.
function translate(err: unknown): MessagingError | Error
Parâmetros
- err
-
unknown
O erro amqp que foi recebido.
Retornos
MessagingError | Error
Objeto MessagingError.