@azure/amqp-common package

Classi

AsyncLock
AadTokenProvider

Definisce il TokenProvider di AAD (Azure ActiveDirectory). Accetta le credenziali seguenti dal pacchetto @azure/ms-rest-nodeauth:

  • ApplicationTokenCredentials
  • UserTokenCredentials
  • DeviceTokenCredentials
  • MSITokenCredentials (MSIVmTokenCredentials)
CbsClient
DefaultDataTransformer

Trasformatore di dati predefinito che verrà usato da Azure SDK.

MessagingError

Descrive la classe di base per l'errore di messaggistica.

RequestResponseLink

Descrive un collegamento amqp request(sender)-response(receiver) creato in una sessione amqp.

SasTokenProvider
Timeout

Descrive una classe Timeout che può attendere l'intervallo di tempo specificato e quindi risolvere/rifiutare la promessa con il valore specificato.

Interfacce

AsyncLockOptions
ConnectionConfig

Descrive l'oggetto config di connessione creato dopo l'analisi di una stringa di connessione EventHub o ServiceBus.

ConnectionContextBase
EventHubConnectionConfig

Descrive l'oggetto config di connessione creato dopo l'analisi di una stringa di connessione EventHub. Fornisce anche alcuni metodi pratici per ottenere l'indirizzo e il gruppo di destinatari per entità diverse.

MessageHeader

Descrive il set definito di proprietà di intestazione standard del messaggio.

MessageProperties

Descrive il set definito di proprietà standard del messaggio.

AmqpMessage

Descrive il messaggio AMQP inviato o ricevuto in transito.

AmqpMessageHeader

Descrive il set definito di proprietà di intestazione standard del messaggio.

AmqpMessageProperties

Descrive il set definito di proprietà standard del messaggio.

AsyncLockOptions

Descrive le opzioni che è possibile specificare per creare un blocco asincrono.

CbsResponse

Descrive la risposta CBS.

ConnectionConfigOptions

Vengono descritte le opzioni che è possibile specificare durante la creazione di una configurazione di connessione.

ConnectionProperties

Definisce le proprietà che devono essere impostate durante la definizione della connessione AMQP.

CreateConnectionContextBaseParameters

Descrive i parametri che è possibile specificare per creare il contesto di connessione di base.

DataTransformer

Descrive le trasformazioni che possono essere eseguite per codificare/decodificare i dati prima di inviarli (o riceverli dal collegamento).

Dictionary

Fornisce un dizionario come struttura <chiave, valore> di tipo T.

EventHubConnectionStringModel

Descrive il modello di stringa di connessione eventhub.

IotHubConnectionStringModel

Descrive il modello di stringa di connessione iothub.

RetryConfig

Descrive i parametri che devono essere configurati per l'operazione di ripetizione dei tentativi.

SendRequestOptions

Descrive le opzioni che è possibile specificare durante l'invio di una richiesta.

ServiceBusConnectionStringModel

Descrive il modello di stringa di connessione del bus di servizio.

StorageConnectionStringModel

Descrive il modello di stringa di connessione di stroage.

TokenInfo

Fornisce informazioni sul token.

TokenProvider

Descrive il provider di token di base.

Alias tipo

AsyncLockDoneCallback
Func

Dichiarazione di tipo per un tipo di funzione in cui T è l'input per la funzione e V è l'output della funzione.

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.

ConditionStatusMapper

Esegue il mapping delle condizioni ai codici di stato di risposta AMQP numerici.

ErrorNameConditionMapper

Esegue il mapping dei nomi degli errori alle condizioni di errore amqp.

RetryOperationType

Descrive il tipo di operazione di ripetizione dei tentativi. RetryOperationType

SystemErrorConditionMapper

Esegue il mapping di alcuni SytemErrors a condizioni di errore amqp SystemErrorConditionMapper

TokenType

Descrive il tipo di token supportati. TokenType

Funzioni

delay<T>(number, T)

Wrapper per setTimeout che risolve una promessa dopo t millisecondi.

executePromisesSequentially(any[], any)
getNewAsyncLock(AsyncLockOptions)

Ottiene una nuova istanza del blocco asincrono con le impostazioni desiderate.

isAmqpError(any)

Determina se l'oggetto errore specificato è simile a un oggetto AmqpError.

isIotHubConnectionString(string)

Determina se la stringa di connessione specificata è una stringa di connessione iothub.

isSystemError(any)
parseConnectionString<T>(string)

Analizza la stringa di connessione e restituisce un oggetto di tipo T.

Le stringhe di connessione hanno la sintassi seguente:

ConnectionString ::= Parte { ";" Part } [ ";" ] [ Spazio vuoto ] Part ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? qualsiasi sequenza di caratteri tranne ; o = o spazi vuoti ? Spazio bianco ::= ? tutti gli spazi vuoti, inclusi \r e \n ?

randomNumberFromInterval(number, number)

Genera un numero casuale tra l'intervallo specificato

retry<T>(RetryConfig<T>)

Tenterà di ripetere in modo lineare un'operazione con un numero specificato di volte con un ritardo specificato tra ogni tentativo. I tentativi si verificheranno solo se l'errore è riprovabile.

translate(Error | AmqpError)

Converte l'errore AQMP ricevuto a livello di protocollo o un errore generico in MessagingError.

Variabili

defaultLock
isNode

Una costante che indica se l'ambiente è node.js o basato su browser.

retryableErrors

Fornisce una lista di errori AMQP ritentabili. "ErroreServerInterno", "ErroreOccupatoServitore", "ErroreIndisponibileServizio", "ErroreCancellato", "ErroreOccupatoMittente", "ErroreMessaggio", "ErroreForzatoDistaccato", "ErroreForzatoForzato", "LimiteTrasferitoExceedErrore", "ErroreOperazionePerditaCausa"

Dettagli funzione

delay<T>(number, T)

Wrapper per setTimeout che risolve una promessa dopo t millisecondi.

function delay<T>(t: number, value?: T): Promise<T>

Parametri

t

number

Numero di millisecondi da ritardare.

value

T

Valore da risolvere con dopo un timeout di t millisecondi.

Restituisce

Promise<T>

  • Promessa risolta

executePromisesSequentially(any[], any)

function executePromisesSequentially(promiseFactories: any[], kickstart?: any): Promise<any>

Parametri

promiseFactories

any[]

kickstart

any

Restituisce

Promise<any>

getNewAsyncLock(AsyncLockOptions)

Ottiene una nuova istanza del blocco asincrono con le impostazioni desiderate.

function getNewAsyncLock(options?: AsyncLockOptions): AsyncLock

Parametri

options
AsyncLockOptions

Opzioni di blocco asincrono.

Restituisce

AsyncLock

isAmqpError(any)

Determina se l'oggetto errore specificato è simile a un oggetto AmqpError.

function isAmqpError(err: any): boolean

Parametri

err

any

Oggetto AmqpError

Restituisce

boolean

result : true se si tratta di un errore AMQP; false in caso contrario.

isIotHubConnectionString(string)

Determina se la stringa di connessione specificata è una stringa di connessione iothub.

function isIotHubConnectionString(connectionString: string): boolean

Parametri

connectionString

string

Stringa di connessione.

Restituisce

boolean

booleano.

isSystemError(any)

function isSystemError(err: any): boolean

Parametri

err

any

Restituisce

boolean

parseConnectionString<T>(string)

Analizza la stringa di connessione e restituisce un oggetto di tipo T.

Le stringhe di connessione hanno la sintassi seguente:

ConnectionString ::= Parte { ";" Part } [ ";" ] [ Spazio vuoto ] Part ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? qualsiasi sequenza di caratteri tranne ; o = o spazi vuoti ? Spazio bianco ::= ? tutti gli spazi vuoti, inclusi \r e \n ?

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

Parametri

connectionString

string

Stringa di connessione da analizzare.

Restituisce

ParsedOutput<T>.

randomNumberFromInterval(number, number)

Genera un numero casuale tra l'intervallo specificato

function randomNumberFromInterval(min: number, max: number): number

Parametri

min

number

Numero minimo dell'intervallo (incluso).

max

number

Numero massimo dell'intervallo (inclusivo).

Restituisce

number

retry<T>(RetryConfig<T>)

Tenterà di ripetere in modo lineare un'operazione con un numero specificato di volte con un ritardo specificato tra ogni tentativo. I tentativi si verificheranno solo se l'errore è riprovabile.

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<T>.

translate(Error | AmqpError)

Converte l'errore AQMP ricevuto a livello di protocollo o un errore generico in MessagingError.

function translate(err: Error | AmqpError): MessagingError

Parametri

err

Error | AmqpError

Errore amqp ricevuto.

Restituisce

Oggetto MessagingError.

Variable Details

defaultLock

defaultLock: AsyncLock

Tipo

isNode

Una costante che indica se l'ambiente è node.js o basato su browser.

isNode: boolean

Tipo

boolean

retryableErrors

Fornisce una lista di errori AMQP ritentabili. "ErroreServerInterno", "ErroreOccupatoServitore", "ErroreIndisponibileServizio", "ErroreCancellato", "ErroreOccupatoMittente", "ErroreMessaggio", "ErroreForzatoDistaccato", "ErroreForzatoForzato", "LimiteTrasferitoExceedErrore", "ErroreOperazionePerditaCausa"

retryableErrors: string[]

Tipo

string[]