@azure/amqp-common package

Klassen

AsyncLock
AadTokenProvider	Definiert den AAD -TokenProvider (Azure ActiveDirectory). Dies akzeptiert die folgenden Anmeldeinformationen aus dem @azure/ms-rest-nodeauth Paket: ApplicationTokenCredentials UserTokenCredentials DeviceTokenCredentials MSITokenCredentials (MSIVmTokenCredentials)
CbsClient
DefaultDataTransformer	Der Standarddatentransformator, der vom Azure SDK verwendet wird.
MessagingError	Beschreibt die Basisklasse für Messaging-Fehler.
RequestResponseLink	Beschreibt einen amqp request(sender)-response(receiver)-link, der über eine amqp-Sitzung erstellt wird.
SasTokenProvider
Timeout	Beschreibt eine Timeoutklasse, die auf die angegebene Zeitspanne warten und die Zusage dann mit dem angegebenen Wert auflösen/ablehnen kann.

Schnittstellen

AsyncLockOptions
ConnectionConfig	Beschreibt das Verbindungskonfigurationsobjekt, das nach der Analyse einer EventHub- oder ServiceBus-Verbindungszeichenfolge erstellt wird.
ConnectionContextBase
EventHubConnectionConfig	Beschreibt das Verbindungskonfigurationsobjekt, das nach der Analyse einer EventHub-Verbindungszeichenfolge erstellt wird. Es bietet auch einige Komfortmethoden zum Abrufen der Adresse und Zielgruppe für verschiedene Entitäten.
MessageHeader	Beschreibt den definierten Satz von Standardkopfzeileneigenschaften der Nachricht.
MessageProperties	Beschreibt den definierten Satz von Standardeigenschaften der Nachricht.
AmqpMessage	Beschreibt die AMQP-Nachricht, die an das Netzwerk gesendet oder empfangen wird.
AmqpMessageHeader	Beschreibt den definierten Satz von Standardkopfzeileneigenschaften der Nachricht.
AmqpMessageProperties	Beschreibt den definierten Satz von Standardeigenschaften der Nachricht.
AsyncLockOptions	Beschreibt die Optionen, die zum Erstellen einer asynchronen Sperre bereitgestellt werden können.
CbsResponse	Beschreibt die CBS-Antwort.
ConnectionConfigOptions	Beschreibt die Optionen, die beim Erstellen einer Verbindungskonfiguration bereitgestellt werden können.
ConnectionProperties	Definiert die Eigenschaften, die beim Einrichten der AMQP-Verbindung festgelegt werden müssen.
CreateConnectionContextBaseParameters	Beschreibt die Parameter, die zum Erstellen des Basisverbindungskontexts bereitgestellt werden können.
DataTransformer	Beschreibt die Transformationen, die zum Codieren/Decodieren der Daten ausgeführt werden können, bevor sie an das Kabel gesendet (oder von dem empfangen werden).
Dictionary	Stellt ein Wörterbuch wie struktur <Schlüssel, Wert> vom Typ T bereit.
EventHubConnectionStringModel	Beschreibt das EventHub-Verbindungszeichenfolgenmodell.
IotHubConnectionStringModel	Beschreibt das iothub-Verbindungszeichenfolgenmodell.
RetryConfig	Beschreibt die Parameter, die für den Wiederholungsvorgang konfiguriert werden müssen.
SendRequestOptions	Beschreibt die Optionen, die beim Senden einer Anforderung angegeben werden können.
ServiceBusConnectionStringModel	Beschreibt das Servicebus-Verbindungszeichenfolgenmodell.
StorageConnectionStringModel	Beschreibt das Zeichenfolgenmodell für die Stroageverbindung.
TokenInfo	Stellt Informationen zum Token bereit.
TokenProvider	Beschreibt den Basistokenanbieter.

Typaliase

AsyncLockDoneCallback
Func	Typdeklaration für einen Funktionstyp, wobei T die Eingabe für die Funktion ist und V die Ausgabe der Funktion ist.
ParsedOutput	Definiert ein Objekt mit möglichen Eigenschaften, die in T definiert sind.

Enumerationen

ConditionErrorNameMapper	Ordnet die Amqp-Fehlerbedingungen den Fehlernamen zu.
ConditionStatusMapper	Ordnet die Bedingungen den numerischen AMQP-Antwortstatuscodes zu.
ErrorNameConditionMapper	Ordnet die Fehlernamen den Amqp-Fehlerbedingungen zu.
RetryOperationType	Beschreibt den Wiederholungsvorgangstyp. RetryOperationType
SystemErrorConditionMapper	Ordnet einige SytemErrors den Amqp-Fehlerbedingungen SystemErrorConditionMapper zu
TokenType	Beschreibt den Typ der unterstützten Token. TokenType

Functions

delay<T>(number, T)	Ein Wrapper für setTimeout, der eine Zusage nach t Millisekunden aufgelöst.
executePromisesSequentially(any[], any)
getNewAsyncLock(AsyncLockOptions)	Ruft eine neue Instanz der asynchronen Sperre mit den gewünschten Einstellungen ab.
isAmqpError(any)	Bestimmt, ob das angegebene Fehlerobjekt wie ein AmqpError -Objekt ist.
isIotHubConnectionString(string)	Bestimmt, ob es sich bei der angegebenen Verbindungszeichenfolge um eine iothub-Verbindungszeichenfolge handelt.
isSystemError(any)
parseConnectionString<T>(string)	Analysiert die Verbindungszeichenfolge und gibt ein Objekt vom Typ T zurück. Verbindungszeichenfolgen weisen die folgende Syntax auf: ConnectionString ::= Teil { ";" Teil } [ ";" ] [ Leerzeichen ] Teil ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? eine beliebige Abfolge von Zeichen außer ; oder = oder Leerzeichen ? Leerzeichen ::= ? alle Leerzeichen einschließlich \r und \n?
randomNumberFromInterval(number, number)	Generiert eine Zufallszahl zwischen dem angegebenen Intervall.
retry<T>(RetryConfig<T>)	Es wird versucht, einen Vorgang linear erneut zu versuchen, die angegebene Anzahl von Wiederholungen mit einer angegebenen Verzögerung zwischen jedem Wiederholungsversuch. Die Wiederholungen treten nur auf, wenn der Fehler erneut ausgeführt werden kann.
translate(Error | AmqpError)	Übersetzt den auf der Protokollebene empfangenen AQMP-Fehler oder einen generischen Fehler in einen MessagingError.

Variablen

defaultLock
isNode	Eine Konstante, die angibt, ob die Umgebung node.js oder browserbasiert ist.
retryableErrors	Bietet eine Liste wiederholbarer AMQP-Fehler. "InternalServerError", "ServerBusyError", "ServiceUnavailableError", "OperationCancelledError", "SenderBusyError", "MessagingError", "DetachForcedError", "ConnectionForcedError", "TransferLimitExceededError", "OperationTimeoutError"

Details zur Funktion

delay<T>(number, T)

Ein Wrapper für setTimeout, der eine Zusage nach t Millisekunden aufgelöst.

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

Parameter

t

number

Die Anzahl der zu verzögernden Millisekunden.

value

T

Der Wert, der nach einem Timeout von t Millisekunden aufgelöst werden soll.

Gibt zurück

Promise<T>

• Gelöste Zusage

executePromisesSequentially(any[], any)

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

Parameter

promiseFactories

any[]

kickstart

any

Gibt zurück

Promise<any>

getNewAsyncLock(AsyncLockOptions)

Ruft eine neue Instanz der asynchronen Sperre mit den gewünschten Einstellungen ab.

function getNewAsyncLock(options?: AsyncLockOptions): AsyncLock

Parameter

options

AsyncLockOptions

Die asynchronen Sperroptionen.

Gibt zurück

AsyncLock

AsyncLock

isAmqpError(any)

Bestimmt, ob das angegebene Fehlerobjekt wie ein AmqpError -Objekt ist.

function isAmqpError(err: any): boolean

Parameter

err

any

Das AmqpError-Objekt

Gibt zurück

boolean

ergebnis - true, wenn es sich um einen AMQP-Fehler handelt; andernfalls false.

isIotHubConnectionString(string)

Bestimmt, ob es sich bei der angegebenen Verbindungszeichenfolge um eine iothub-Verbindungszeichenfolge handelt.

function isIotHubConnectionString(connectionString: string): boolean

Parameter

connectionString

string

Die Verbindungszeichenfolge.

Gibt zurück

boolean

boolesch.

isSystemError(any)

function isSystemError(err: any): boolean

Parameter

err

any

Gibt zurück

boolean

parseConnectionString<T>(string)

Analysiert die Verbindungszeichenfolge und gibt ein Objekt vom Typ T zurück.

Verbindungszeichenfolgen weisen die folgende Syntax auf:

ConnectionString ::= Teil { ";" Teil } [ ";" ] [ Leerzeichen ] Teil ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? eine beliebige Abfolge von Zeichen außer ; oder = oder Leerzeichen ? Leerzeichen ::= ? alle Leerzeichen einschließlich \r und \n?

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

Parameter

connectionString

string

Die zu analysierende Verbindungszeichenfolge.

Gibt zurück

ParsedOutput<T>

ParsedOutput<T>.

randomNumberFromInterval(number, number)

Generiert eine Zufallszahl zwischen dem angegebenen Intervall.

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

Parameter

min

number

Min. Anzahl des Bereichs (einschließlich).

max

number

Max. Anzahl des Bereichs (einschließlich).

Gibt zurück

number

retry<T>(RetryConfig<T>)

Es wird versucht, einen Vorgang linear erneut zu versuchen, die angegebene Anzahl von Wiederholungen mit einer angegebenen Verzögerung zwischen jedem Wiederholungsversuch. Die Wiederholungen treten nur auf, wenn der Fehler erneut ausgeführt werden kann.

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

Parameter

config

RetryConfig<T>

Parameter zum Konfigurieren des Wiederholungsvorgangs.

Gibt zurück

Promise<T>

Versprechen<T>.

translate(Error | AmqpError)

Übersetzt den auf der Protokollebene empfangenen AQMP-Fehler oder einen generischen Fehler in einen MessagingError.

function translate(err: Error | AmqpError): MessagingError

Parameter

err

Error | AmqpError

Der amqp-Fehler, der empfangen wurde.

Gibt zurück

MessagingError

MessagingError-Objekt.

Variable Details

defaultLock

defaultLock: AsyncLock

Typ

AsyncLock

isNode

Eine Konstante, die angibt, ob die Umgebung node.js oder browserbasiert ist.

isNode: boolean

Typ

boolean

retryableErrors

Bietet eine Liste wiederholbarer AMQP-Fehler. "InternalServerError", "ServerBusyError", "ServiceUnavailableError", "OperationCancelledError", "SenderBusyError", "MessagingError", "DetachForcedError", "ConnectionForcedError", "TransferLimitExceededError", "OperationTimeoutError"

retryableErrors: string[]

Typ

string[]