Sdílet prostřednictvím


@azure/core-amqp package

Třídy

CbsClient

Popisuje klienta EventHub/ServiceBus Cbs, který komunikuje s koncovým bodem $cbs přes připojení AMQP.

MessagingError

Popisuje základní třídu chyby zasílání zpráv.

RequestResponseLink

Popisuje odkaz amqp request(sender)-response(receiver) vytvořený v relaci amqp.

Rozhraní

AcquireLockProperties

Popisuje vlastnosti, které musí být poskytnuty při získání zámku.

AmqpAnnotatedMessage

Popisuje AmqpAnnotatedMessage, součást ServiceBusReceivedMessage(as amqpAnnotatedMessage vlastnost).

AmqpMessageHeader

Popisuje definovanou sadu standardních vlastností záhlaví zprávy.

AmqpMessageProperties

Popisuje definovanou sadu standardních vlastností zprávy.

CancellableAsyncLock

CancellableAsyncLock poskytuje mechanismus pro vynucení úloh pomocí stejného klíče, který se má spustit sériově.

Čekající úkoly je možné ručně zrušit prostřednictvím abortSignal nebo automaticky zrušit dosažením zadané hodnoty časového limitu.

CbsResponse

Popisuje odpověď CBS.

ConnectionConfig

Popisuje objekt konfigurace připojení vytvořený po analýze připojovacího řetězce EventHub nebo ServiceBus.

ConnectionConfigOptions

Popisuje možnosti, které lze poskytnout při vytváření konfigurace připojení.

ConnectionContextBase

Poskytuje kontextové informace, jako je základní připojení amqp, relace cbs, tokenProvider, konfigurace připojení, datový transformátor atd.

ConnectionProperties

Definuje vlastnosti, které je potřeba nastavit při navazování připojení AMQP.

CreateConnectionContextBaseParameters

Popisuje parametry, které lze poskytnout k vytvoření kontextu základního připojení.

NetworkSystemError

Popisuje pole v Node.js SystemError. Vynechá pole, která nesouvisí se síťovými voláními (např. volání systému souborů). Viz https://nodejs.org/dist/latest-v12.x/docs/api/errors.html#errors_class_systemerror

RetryConfig

Popisuje parametry, které je potřeba nakonfigurovat pro operaci opakování.

RetryOptions

Možnosti zásad opakování, které určují režim, počet opakování, interval opakování atd.

SendRequestOptions

Popisuje možnosti, které lze zadat při odesílání požadavku.

WebSocketOptions

Možnosti konfigurace kanálu připojení AMQP přes webové sokety

Aliasy typu

ParsedOutput

Definuje objekt s možnými vlastnostmi definovanými v T.

Výčty

ConditionErrorNameMapper

Mapuje chybové podmínky amqp na názvy chyb.

ErrorNameConditionMapper

Mapuje názvy chyb na chybové stavy amqp.

RetryMode

Popisuje typ režimu opakování.

RetryOperationType

Popisuje typ operace opakování.

SystemErrorConditionMapper

Mapuje některé chyby systému na chybové stavy amqp.

TokenType

Popisuje typ podporovaných tokenů.

Funkce

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

Obálka pro setTimeout, která vyřeší příslib po milisekundách.

isMessagingError(MessagingError | Error)

Určuje, jestli se jedná o chybu MessagingError.

isSystemError(unknown)

Zkontroluje, jestli je zadanou chybou node.js SystemError.

parseConnectionString<T>(string)

Analyzuje připojovací řetězec a vrátí objekt typu T.

Připojovací řetězce mají následující syntaxi:

ConnectionString ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] Část ::= [ PartLiteral [ "=" PartLiteral ] ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? libovolná posloupnost znaků s výjimkou ; nebo = nebo prázdné znaky? Prázdné znaky ::= ? všechny prázdné znaky včetně \r a \n?

retry<T>(RetryConfig<T>)

Každá operace se pokusí aspoň jednou. Další pokusy se provádějí v případě, že předchozí pokus selhal s chybou opakovatelnou. Počet dalšíchpokusůch RetryConfigmaxRetries ch

Pokud je mode možnost nastavena na Fixed, pak se opakování provádí na dané operaci pro zadaný početkrát, s pevným zpožděním mezi jednotlivými opakováními pokaždé.

Pokud je možnost mode nastavená na Exponential, pak se zpoždění mezi opakovanými pokusy upraví tak, aby se exponenciálně zvýšilo s každým pokusem pomocí faktoru zpětného vypnutí výkonu 2.

translate(unknown)

Přeloží chybu AMQP přijatou ve vrstvě protokolu nebo systemError na chybu zasílání zpráv. Všechny ostatní chyby se vrátí beze chyby.

Podrobnosti funkce

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

Obálka pro setTimeout, která vyřeší příslib po milisekundách.

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

Parametry

delayInMs

number

Počet milisekund, které mají být zpožděny.

abortSignal
AbortSignalLike

AbortSignal přidružený k obsahující operaci.

abortErrorMsg

string

Chybová zpráva o přerušení přidružené k operaci obsahující.

value

T

Hodnota, se kterou se má vyřešit po vypršení časového limitu t milisekund.

Návraty

Promise<T | void>

  • Vyřešený slib

isMessagingError(MessagingError | Error)

Určuje, jestli se jedná o chybu MessagingError.

function isMessagingError(error: MessagingError | Error): error

Parametry

error

MessagingError | Error

Chyba, která může být chyba nebo chyba zasílání zpráv.

Návraty

error

isSystemError(unknown)

Zkontroluje, jestli je zadanou chybou node.js SystemError.

function isSystemError(err: unknown): err

Parametry

err

unknown

Objekt, který může obsahovat informace o chybě.

Návraty

err

parseConnectionString<T>(string)

Analyzuje připojovací řetězec a vrátí objekt typu T.

Připojovací řetězce mají následující syntaxi:

ConnectionString ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] Část ::= [ PartLiteral [ "=" PartLiteral ] ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? libovolná posloupnost znaků s výjimkou ; nebo = nebo prázdné znaky? Prázdné znaky ::= ? všechny prázdné znaky včetně \r a \n?

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

Parametry

connectionString

string

Připojovací řetězec, který se má analyzovat.

Návraty

ParsedOutput.

retry<T>(RetryConfig<T>)

Každá operace se pokusí aspoň jednou. Další pokusy se provádějí v případě, že předchozí pokus selhal s chybou opakovatelnou. Počet dalšíchpokusůch RetryConfigmaxRetries ch

Pokud je mode možnost nastavena na Fixed, pak se opakování provádí na dané operaci pro zadaný početkrát, s pevným zpožděním mezi jednotlivými opakováními pokaždé.

Pokud je možnost mode nastavená na Exponential, pak se zpoždění mezi opakovanými pokusy upraví tak, aby se exponenciálně zvýšilo s každým pokusem pomocí faktoru zpětného vypnutí výkonu 2.

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

Parametry

config

RetryConfig<T>

Parametry pro konfiguraci operace opakování

Návraty

Promise<T>

Slib.

translate(unknown)

Přeloží chybu AMQP přijatou ve vrstvě protokolu nebo systemError na chybu zasílání zpráv. Všechny ostatní chyby se vrátí beze chyby.

function translate(err: unknown): MessagingError | Error

Parametry

err

unknown

Byla přijata chyba amqp.

Návraty

MessagingError | Error

Objekt MessagingError.