Compartilhar via

CbsClient class

  • Referência
Pacote:
@azure/core-amqp

Descreve o cliente EventHub/ServiceBus Cbs que conversa com o ponto de extremidade $cbs pela conexão AMQP.

Construtores

CbsClient(Connection, string)

Propriedades

cbsLock

O nome de bloqueio exclusivo por $cbs sessão por conexão usada para adquirir o bloqueio para estabelecer uma sessão cbs se não existir uma conexão amqp.
connection

A conexão AMQP.
connectionLock

O nome de bloqueio exclusivo por conexão que é usado para adquirir o bloqueio para estabelecer uma conexão amqp se um não existir.
endpoint

Ponto de extremidade da CBS - "$cbs"
replyTo

Resposta da CBS – o nome do link do receptor ao qual o serviço deve responder.

Métodos

close()

Fecha a sessão cbs do AMQP para o EventHub/ServiceBus para esse cliente, retornando uma promessa que será resolvida quando a desconexão for concluída.
init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })

Cria uma instância singleton da sessão cbs se ela não tiver sido inicializada anteriormente na conexão fornecida.
isOpen()

Indica se o link do receptor do remetente cbs está aberto ou fechado.
negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })

Negocia a declaração cbs com o Serviço EventHub/ServiceBus.
remove()

Remove a sessão cbs amqp para o EventHub/ServiceBus para este cliente,

Detalhes do construtor

CbsClient(Connection, string) 

new CbsClient(connection: Connection, connectionLock: string)

Parâmetros

connection

Connection

A conexão AMQP.

connectionLock

string

Uma cadeia de caracteres exclusiva (geralmente um guid) por conexão.

Detalhes da propriedade

cbsLock

O nome de bloqueio exclusivo por $cbs sessão por conexão usada para adquirir o bloqueio para estabelecer uma sessão cbs se não existir uma conexão amqp.

cbsLock: string

Valor da propriedade

string

connection

A conexão AMQP.

connection: Connection

Valor da propriedade

Connection

connectionLock

O nome de bloqueio exclusivo por conexão que é usado para adquirir o bloqueio para estabelecer uma conexão amqp se um não existir.

connectionLock: string

Valor da propriedade

string

endpoint

Ponto de extremidade da CBS - "$cbs"

endpoint: string

Valor da propriedade

string

replyTo

Resposta da CBS – o nome do link do receptor ao qual o serviço deve responder.

replyTo: string

Valor da propriedade

string

Detalhes do método

close()

Fecha a sessão cbs do AMQP para o EventHub/ServiceBus para esse cliente, retornando uma promessa que será resolvida quando a desconexão for concluída.

function close(): Promise<void>

Retornos

Promise<void>

init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })

Cria uma instância singleton da sessão cbs se ela não tiver sido inicializada anteriormente na conexão fornecida.

function init(options?: { abortSignal?: AbortSignalLike, timeoutInMs?: number }): Promise<void>

Parâmetros

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Parâmetros opcionais que podem ser usados para afetar o comportamento desse método. Por exemplo, abortSignal pode ser passado para permitir o cancelamento de uma invocação em andamento init .

Retornos

Promise<void>

Prometo.

isOpen()

Indica se o link do receptor do remetente cbs está aberto ou fechado.

function isOpen(): boolean

Retornos

boolean

true aberto, false fechado.

negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })

Negocia a declaração cbs com o Serviço EventHub/ServiceBus.

function negotiateClaim(audience: string, token: string, tokenType: TokenType, options?: { abortSignal?: AbortSignalLike, timeoutInMs?: number }): Promise<CbsResponse>

Parâmetros

audience

string

O público-alvo do token de entidade para o qual o token é solicitado em uma das seguintes formas:

  • Barramento de Serviço

    • Remetente

      • "sb://<yournamespace>.servicebus.windows.net/<queue-name>"
      • "sb://<yournamespace>.servicebus.windows.net/<topic-name>"

    • Receptor - "sb://<yournamespace>.servicebus.windows.net/<queue-name>" - "sb://<yournamespace>.servicebus.windows.net/<topic-name>"

    • ManagementClient - "sb://<your-namespace>.servicebus.windows.net/<queue-name>/$management". - "sb://<your-namespace>.servicebus.windows.net/<topic-name>/$management".

  • EventHubs

    • Remetente

      • "sb://<yournamespace>.servicebus.windows.net/<hubName>"
      • "sb://<yournamespace>.servicebus.windows.net/<hubName>/Partitions/<partitionId>".

    • Receptor

      • "sb://<your-namespace>.servicebus.windows.net/<event-hub-name>/ConsumerGroups/<consumer-group-name>/Partitions/<partition-id>".

    • ManagementClient

      • "sb://<your-namespace>.servicebus.windows.net/<event-hub-name>/$management".
token

string

O token que precisa ser enviado na solicitação put-token.

tokenType
TokenType

O tipo de token que está sendo usado. Por exemplo, 'jwt' ou 'servicebus.windows.net:sastoken'.

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Parâmetros opcionais que podem ser usados para afetar o comportamento desse método. Por exemplo, abortSignal pode ser passado para permitir o cancelamento de uma invocação em andamento negotiateClaim .

Retornos

Promise<CbsResponse>

Uma Promessa que resolve quando $cbs autenticação é bem-sucedida e rejeita quando ocorre um erro durante $cbs autenticação.

remove()

Remove a sessão cbs amqp para o EventHub/ServiceBus para este cliente,

function remove()