@azure/core-amqp package

Osztályok

CbsClient	Ismerteti az EventHub/ServiceBus Cbs-ügyfelet, amely az AMQP-kapcsolaton keresztül kommunikál a $cbs végponttal.
MessagingError	Az üzenetküldési hiba alaposztályát ismerteti.
RequestResponseLink	A cikk egy amqp-munkamenet során létrehozott amqp-request(sender)-response(receiver) hivatkozást ismerteti.

Interfészek

AcquireLockProperties	A zárolás beszerzésekor megadandó tulajdonságokat ismerteti.
AmqpAnnotatedMessage	Az AmqpAnnotatedMessage, a ServiceBusReceivedMessage(as amqpAnnotatedMessage tulajdonság) része.
AmqpMessageHeader	Az üzenet szabványos fejléctulajdonságainak definiált készletét ismerteti.
AmqpMessageProperties	Az üzenet szabványos tulajdonságainak definiált készletét ismerteti.
CancellableAsyncLock	A CancellableAsyncLock olyan mechanizmust biztosít, amely kényszeríti a feladatokat ugyanazzal a "kulccsal" a soros végrehajtáshoz. A függőben lévő tevékenységek manuálisan megszakíthatók az abortSignal használatával, vagy automatikusan megszakíthatók egy megadott időtúllépési érték elérésével.
CbsResponse	A CBS-válasz leírása.
ConnectionConfig	Az EventHub vagy ServiceBus kapcsolati sztring elemzése után létrehozott kapcsolatkonfigurálási objektumot ismerteti.
ConnectionConfigOptions	A kapcsolatkonfiguráció létrehozásakor megadható beállítások ismertetése.
ConnectionContextBase	Olyan környezeti információkat biztosít, mint a mögöttes amqp-kapcsolat, a CBS-munkamenet, a tokenProvider, a Kapcsolat konfigurációja, az adatátalakító stb.
ConnectionProperties	Meghatározza az AMQP-kapcsolat létrehozásakor beállítandó tulajdonságokat.
CreateConnectionContextBaseParameters	Az alapkapcsolati környezet létrehozásához megadható paraméterek ismertetése.
NetworkSystemError	Egy Node.js SystemError mezőit ismerteti. Kihagyja azokat a mezőket, amelyek nem kapcsolódnak hálózati hívásokhoz (például fájlrendszerbeli hívásokhoz). Lásd: https://nodejs.org/dist/latest-v12.x/docs/api/errors.html#errors_class_systemerror
RetryConfig	Az újrapróbálkozási művelethez konfigurálni kívánt paramétereket ismerteti.
RetryOptions	Újrapróbálkozási szabályzatbeállítások, amelyek meghatározzák az üzemmódot, az újrapróbálkozések számát, az újrapróbálkozási időközt stb.
SendRequestOptions	A kérés elküldése során megadható beállításokat ismerteti.
WebSocketOptions	Az AMQP-kapcsolat webes szoftvercsatornákon keresztüli csatornázásának konfigurálásának beállításai.

Típusaliasok

ParsedOutput

A T-ben definiált lehetséges tulajdonságokkal rendelkező objektumot definiál.

Enumerációk

ConditionErrorNameMapper	Az amqp hibafeltételeinek leképezése a Hibanevekre.
ErrorNameConditionMapper	A Hibanevek leképezése az amqp hibafeltételeihez.
RetryMode	Az újrapróbálkozási mód típusát ismerteti
RetryOperationType	Az újrapróbálkozási művelet típusát ismerteti.
SystemErrorConditionMapper	Leképz néhány SystemErrort a hibafeltételek amqp-hoz való leképezéséhez
TokenType	A támogatott jogkivonatok típusát ismerteti.

Függvények

delay<T>(number, AbortSignalLike, string, T)	A setTimeout burkolója, amely ezredmásodperc után felold egy ígéretet.
isMessagingError(Error | MessagingError)	Meghatározza, hogy a hiba MessagingError-e.
isSystemError(unknown)	Ellenőrzi, hogy a megadott hiba a SystemError node.js-e.
parseConnectionString<T>(string)	Elemzi a kapcsolati sztring, és egy T típusú objektumot ad vissza. A kapcsolati sztringek szintaxisa a következő: ConnectionString ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] Part ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literál [ WhiteSpace ] Literál ::= ? bármely karaktersorozat, kivéve; vagy = vagy WhiteSpace? WhiteSpace ::= ? az összes szóközkarakter karakter, beleértve a és \n a karaktert is\r?
retry<T>(RetryConfig<T>)	Minden műveletet legalább egyszer megkísérlünk. Ha az előző kísérlet újrapróbálkozási hibával meghiúsult, további kísérletek történnek. A további kísérletek számát az maxRetries argumentumban RetryConfig megadott tulajdonság szabályozza. Ha mode a Fixedbeállítás értéke , akkor az újrapróbálkozások adott számú alkalommal történnek az adott műveleten, és minden újrapróbálkozás között rögzített késleltetés van. Ha mode a Exponentialbeállítás értéke , akkor az újrapróbálkozások közötti késleltetés exponenciálisan növekszik minden egyes kísérletnél a 2. teljesítmény visszakapcsolási tényezőjével.
translate(unknown)	Lefordítja a protokollrétegben vagy a SystemErrorban kapott AMQP-hibát egy MessagingError-ra. A rendszer minden más hibát változatlanul ad vissza.

Függvény adatai

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

A setTimeout burkolója, amely ezredmásodperc után felold egy ígéretet.

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

Paraméterek

delayInMs

number

A késleltetendő ezredmásodpercek száma.

abortSignal

AbortSignalLike

A tartalmú művelethez társított abortSignal.

abortErrorMsg

string

A műveletet tartalmazó művelettel társított megszakítási hibaüzenet.

value

T

Ezredmásodperc időtúllépés után feloldandó érték.

Válaszok

Promise<T | void>

• Megoldott ígéret

isMessagingError(Error | MessagingError)

Meghatározza, hogy a hiba MessagingError-e.

function isMessagingError(error: Error | MessagingError): error

Paraméterek

error

Error | MessagingError

Hiba, amely lehet hiba vagy MessagingError.

Válaszok

error

isSystemError(unknown)

Ellenőrzi, hogy a megadott hiba a SystemError node.js-e.

function isSystemError(err: unknown): err

Paraméterek

err

unknown

Hibainformációkat tartalmazó objektum.

Válaszok

err

parseConnectionString<T>(string)

Elemzi a kapcsolati sztring, és egy T típusú objektumot ad vissza. A kapcsolati sztringek szintaxisa a következő:

ConnectionString ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] Part ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literál [ WhiteSpace ] Literál ::= ? bármely karaktersorozat, kivéve; vagy = vagy WhiteSpace? WhiteSpace ::= ? az összes szóközkarakter karakter, beleértve a és \n a karaktert is\r?

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

Paraméterek

connectionString

string

Az elemezni kívánt kapcsolati sztring.

Válaszok

ParsedOutput<T>

ParsedOutput.

retry<T>(RetryConfig<T>)

Minden műveletet legalább egyszer megkísérlünk. Ha az előző kísérlet újrapróbálkozási hibával meghiúsult, további kísérletek történnek. A további kísérletek számát az maxRetries argumentumban RetryConfig megadott tulajdonság szabályozza. Ha mode a Fixedbeállítás értéke , akkor az újrapróbálkozások adott számú alkalommal történnek az adott műveleten, és minden újrapróbálkozás között rögzített késleltetés van.

Ha mode a Exponentialbeállítás értéke , akkor az újrapróbálkozások közötti késleltetés exponenciálisan növekszik minden egyes kísérletnél a 2. teljesítmény visszakapcsolási tényezőjével.

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

Paraméterek

config

RetryConfig<T>

Az újrapróbálkozási művelet konfigurálásához szükséges paraméterek

Válaszok

Promise<T>

Ígéret.

translate(unknown)

Lefordítja a protokollrétegben vagy a SystemErrorban kapott AMQP-hibát egy MessagingError-ra. A rendszer minden más hibát változatlanul ad vissza.

function translate(err: unknown): MessagingError | Error

Paraméterek

err

unknown

A kapott amqp hiba.

Válaszok

MessagingError | Error

MessagingError objektum.