@azure/core-amqp package

Classi

CbsClient	Descrive il client EventHub/ServiceBus Cbs che comunica con l'endpoint $cbs tramite la connessione AMQP.
MessagingError	Descrive la classe di base per l'errore di messaggistica.
RequestResponseLink	Descrive un collegamento amqp request(sender)-response(ricevitore) creato su una sessione amqp.

Interfacce

AcquireLockProperties	Descrive le proprietà che devono essere fornite durante l'acquisizione di un blocco.
AmqpAnnotatedMessage	Descrive AmqpAnnotatedMessage, parte della proprietà ServiceBusReceivedMessage(come amqpAnnotatedMessage proprietà).
AmqpMessageHeader	Descrive il set definito di proprietà dell'intestazione standard del messaggio.
AmqpMessageProperties	Descrive il set definito di proprietà standard del messaggio.
CancellableAsyncLock	CancellableAsyncLock fornisce un meccanismo per forzare le attività usando la stessa "chiave" da eseguire serialmente. Le attività in sospeso possono essere annullate manualmente tramite un oggetto abortSignal o automaticamente annullate dal raggiungimento di un valore di timeout specificato.
CbsResponse	Descrive la risposta CBS.
ConnectionConfig	Descrive l'oggetto config di connessione creato dopo l'analisi di una stringa di connessione EventHub o ServiceBus.
ConnectionConfigOptions	Descrive le opzioni che possono essere fornite durante la creazione di una configurazione di connessione.
ConnectionContextBase	Fornisce informazioni contestuali come la connessione amqp sottostante, cbs sessione, tokenProvider, configurazione connessione, trasformatore di dati e così via.
ConnectionProperties	Definisce le proprietà che devono essere impostate durante la definizione della connessione AMQP.
CreateConnectionContextBaseParameters	Descrive i parametri che possono essere forniti per creare il contesto di connessione di base.
NetworkSystemError	Descrive i campi in un Node.js SystemError. Omette i campi che non sono correlati alle chiamate di rete (ad esempio le chiamate al file system). Vedere https://nodejs.org/dist/latest-v12.x/docs/api/errors.html#errors_class_systemerror
RetryConfig	Descrive i parametri che devono essere configurati per l'operazione di ripetizione dei tentativi.
RetryOptions	Opzioni dei criteri di ripetizione dei tentativi che determinano la modalità, il numero di tentativi, l'intervallo di ripetizione dei tentativi e così via.
SendRequestOptions	Descrive le opzioni che possono essere specificate durante l'invio di una richiesta.
WebSocketOptions	Opzioni per configurare il canale della connessione AMQP su Web Sockets.

Alias tipo

ParsedOutput

Definisce un oggetto con le possibili proprietà definite in T.

Enumerazioni

ConditionErrorNameMapper	Esegue il mapping delle condizioni di errore amqp ai nomi degli errori.
ErrorNameConditionMapper	Esegue il mapping dei nomi degli errori alle condizioni di errore di amqp.
RetryMode	Descrive il tipo di modalità tentativi
RetryOperationType	Descrive il tipo di operazione di ripetizione dei tentativi.
SystemErrorConditionMapper	Esegue il mapping di alcuni SystemErrors a condizioni di errore amqp
TokenType	Descrive il tipo di token supportati.

Funzioni

delay<T>(number, AbortSignalLike, string, T)	Wrapper per setTimeout che risolve una promessa dopo t millisecondi.
isMessagingError(Error | MessagingError)	Determina se un errore è un MessagingError.
isSystemError(unknown)	Verifica se l'errore specificato è un node.js SystemError.
parseConnectionString<T>(string)	Analizza la stringa di connessione e restituisce un oggetto di tipo T. Le stringhe di connessione hanno la sintassi seguente: ConnectionString ::= Part ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] [ PartLiteral [ "=" PartLiteral ] PartLiteral ::= [ WhiteSpace ] Letterale [ WhiteSpace ] Valore letterale ::= ? qualsiasi sequenza di caratteri tranne ; o = o WhiteSpace ? WhiteSpace ::= ? tutti i caratteri di spazi vuoti inclusi \r e \n ?
retry<T>(RetryConfig<T>)	Ogni operazione viene tentata almeno una volta. I tentativi aggiuntivi vengono effettuati se il tentativo precedente non è riuscito con un errore riprovabile. Il numero di tentativi aggiuntivi è disciplinato dalla maxRetries proprietà fornita nell'argomento RetryConfig . Se mode l'opzione è impostata su Fixed, i tentativi vengono effettuati sull'operazione specificata per un numero specificato di volte, con un ritardo fisso tra ogni tentativo ogni volta. Se mode l'opzione è impostata su Exponential, il ritardo tra i tentativi viene modificato per aumentare in modo esponenziale ogni tentativo usando il fattore back-off della potenza 2.
translate(unknown)	Converte l'errore AMQP ricevuto a livello di protocollo o systemError in un MessagingError. Tutti gli altri errori vengono restituiti invariati.

Dettagli funzione

delay<T>(number, AbortSignalLike, string, T)

Wrapper per setTimeout che risolve una promessa dopo t millisecondi.

function delay<T>(delayInMs: number, abortSignal?: AbortSignalLike, abortErrorMsg?: string, value?: T): Promise<T | void>

Parametri

delayInMs

number

Numero di millisecondi da ritardare.

abortSignal

AbortSignalLike

Oggetto abortSignal associato all'operazione contenente l'operazione.

abortErrorMsg

string

Messaggio di errore di interruzione associato all'operazione contenente.

value

T

Valore da risolvere dopo un timeout di t millisecondi.

Restituisce

Promise<T | void>

• Promessa risolta

isMessagingError(Error | MessagingError)

Determina se un errore è un MessagingError.

function isMessagingError(error: Error | MessagingError): error

Parametri

error

Error | MessagingError

Errore che può essere un errore o un MessagingError.

Restituisce

error

isSystemError(unknown)

Verifica se l'errore specificato è un node.js SystemError.

function isSystemError(err: unknown): err

Parametri

err

unknown

Oggetto che può contenere informazioni sugli errori.

Restituisce

err

parseConnectionString<T>(string)

Analizza la stringa di connessione e restituisce un oggetto di tipo T. Le stringhe di connessione hanno la sintassi seguente:

ConnectionString ::= Part ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] [ PartLiteral [ "=" PartLiteral ] PartLiteral ::= [ WhiteSpace ] Letterale [ WhiteSpace ] Valore letterale ::= ? qualsiasi sequenza di caratteri tranne ; o = o WhiteSpace ? WhiteSpace ::= ? tutti i caratteri di spazi vuoti inclusi \r e \n ?

function parseConnectionString<T>(connectionString: string): ParsedOutput<T>

Parametri

connectionString

string

Stringa di connessione da analizzare.

Restituisce

ParsedOutput<T>

ParsedOutput.

retry<T>(RetryConfig<T>)

Ogni operazione viene tentata almeno una volta. I tentativi aggiuntivi vengono effettuati se il tentativo precedente non è riuscito con un errore riprovabile. Il numero di tentativi aggiuntivi è disciplinato dalla maxRetries proprietà fornita nell'argomento RetryConfig . Se mode l'opzione è impostata su Fixed, i tentativi vengono effettuati sull'operazione specificata per un numero specificato di volte, con un ritardo fisso tra ogni tentativo ogni volta.

Se mode l'opzione è impostata su Exponential, il ritardo tra i tentativi viene modificato per aumentare in modo esponenziale ogni tentativo usando il fattore back-off della potenza 2.

function retry<T>(config: RetryConfig<T>): Promise<T>

Parametri

config

RetryConfig<T>

Parametri per configurare l'operazione di ripetizione dei tentativi

Restituisce

Promise<T>

Promessa.

translate(unknown)

Converte l'errore AMQP ricevuto a livello di protocollo o systemError in un MessagingError. Tutti gli altri errori vengono restituiti invariati.

function translate(err: unknown): MessagingError | Error

Parametri

err

unknown

Errore amqp ricevuto.

Restituisce

MessagingError | Error

Oggetto MessagingError.