@azure/core-amqp package

Klassen

CbsClient	Beschrijft de EventHub/ServiceBus Cbs-client die met het $cbs-eindpunt praat via AMQP-verbinding.
MessagingError	Beschrijft de basisklasse voor berichtfout.
RequestResponseLink	Beschrijft een amqp-aanvraag(afzender)-antwoordkoppeling (ontvanger) die is gemaakt via een amqp-sessie.

Interfaces

AcquireLockProperties	Beschrijft de eigenschappen die moeten worden opgegeven tijdens het verkrijgen van een vergrendeling.
AmqpAnnotatedMessage	Beschrijft de AmqpAnnotatedMessage, onderdeel van de eigenschap ServiceBusReceivedMessage(als amqpAnnotatedMessage).
AmqpMessageHeader	Beschrijft de gedefinieerde set standaardheadereigenschappen van het bericht.
AmqpMessageProperties	Beschrijft de gedefinieerde set standaardeigenschappen van het bericht.
CancellableAsyncLock	CancellableAsyncLock biedt een mechanisme voor het afdwingen van taken die gebruikmaken van dezelfde sleutel die serieel moet worden uitgevoerd. Taken die in behandeling zijn, kunnen handmatig worden geannuleerd via een abortSignal of automatisch worden geannuleerd door een opgegeven time-outwaarde te bereiken.
CbsResponse	Beschrijft het CBS-antwoord.
ConnectionConfig	Beschrijft het verbindingsconfiguratieobject dat is gemaakt na het parseren van een EventHub- of ServiceBus-verbindingsreeks.
ConnectionConfigOptions	Beschrijft de opties die kunnen worden opgegeven tijdens het maken van een verbindingsconfiguratie.
ConnectionContextBase	Biedt contextuele informatie zoals de onderliggende amqp-verbinding, cbs-sessie, tokenProvider, verbindingsconfiguratie, gegevenstransformatie, enzovoort.
ConnectionProperties	Definieert de eigenschappen die moeten worden ingesteld tijdens het tot stand brengen van de AMQP-verbinding.
CreateConnectionContextBaseParameters	Beschrijft de parameters die kunnen worden opgegeven om de context van de basisverbinding te maken.
NetworkSystemError	Beschrijft de velden in een Node.js SystemError. Hiermee worden velden weggelaten die niet zijn gerelateerd aan netwerkoproepen (bijvoorbeeld bestandssysteemoproepen). Zie https://nodejs.org/dist/latest-v12.x/docs/api/errors.html#errors_class_systemerror
RetryConfig	Beschrijft de parameters die moeten worden geconfigureerd voor de bewerking voor opnieuw proberen.
RetryOptions	Beleidsopties voor opnieuw proberen die de modus, het aantal nieuwe pogingen, het interval voor opnieuw proberen, enzovoort bepalen.
SendRequestOptions	Beschrijft de opties die kunnen worden opgegeven tijdens het verzenden van een aanvraag.
WebSocketOptions	Opties voor het configureren van de kanaalling van de AMQP-verbinding via Web Sockets.

Type-aliassen

ParsedOutput

Hiermee definieert u een object met mogelijke eigenschappen die zijn gedefinieerd in T.

Enums

ConditionErrorNameMapper	Wijst de voorwaarden voor amqp-fouten toe aan de foutnamen.
ErrorNameConditionMapper	Wijst de foutnamen toe aan de voorwaarden van de amqp-fout.
RetryMode	Beschrijft het type Modus voor opnieuw proberen
RetryOperationType	Beschrijft het bewerkingstype voor opnieuw proberen.
SystemErrorConditionMapper	Wijst sommige SystemErrors toe aan amqp-foutvoorwaarden
TokenType	Beschrijft het type ondersteunde tokens.

Functies

delay<T>(number, AbortSignalLike, string, T)	Een wrapper voor setTimeout waarmee een belofte na t milliseconden wordt omgezet.
isMessagingError(MessagingError | Error)	Bepaalt of een fout een MessagingError is.
isSystemError(unknown)	Controleert of de opgegeven fout een node.js SystemError is.
parseConnectionString<T>(string)	Parseert de verbindingsreeks en retourneert een object van het type T. Verbindingsreeksen hebben de volgende syntaxis: ConnectionString ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] Deel ::= [ PartLiteral [ "=" PartLiteral ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Letterlijk ::= ? elke reeks tekens behalve ; or = of WhiteSpace? Witruimte ::= ? alle witruimtetekens, inclusief \r en \n?
retry<T>(RetryConfig<T>)	Elke bewerking wordt ten minste één keer uitgevoerd. Er worden extra pogingen gedaan als de vorige poging is mislukt met een fout die opnieuw kan worden geprobeerd. Het aantal extra pogingen wordt bepaald door de eigenschap maxRetries die is opgegeven in het argument RetryConfig. Als mode optie is ingesteld op Fixed, worden de nieuwe pogingen voor de opgegeven bewerking gedurende een bepaald aantal keren uitgevoerd, met een vaste vertraging tussen elke nieuwe poging elke keer. Als mode optie is ingesteld op Exponential, wordt de vertraging tussen nieuwe pogingen aangepast om exponentieel te toenemen met elke poging met behulp van de back-off factor van macht 2.
translate(unknown)	Vertaalt de AMQP-fout die is ontvangen op de protocollaag of een SystemError in een MessagingError. Alle andere fouten worden ongewijzigd geretourneerd.

Functiedetails

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

Een wrapper voor setTimeout waarmee een belofte na t milliseconden wordt omgezet.

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

Parameters

delayInMs

number

Het aantal milliseconden dat moet worden vertraagd.

abortSignal

AbortSignalLike

De abortSignal die is gekoppeld aan de bewerking die het bevat.

abortErrorMsg

string

Het afgebroken foutbericht dat is gekoppeld aan de bewerking die is gekoppeld aan de bewerking.

value

T

De waarde waarmee moet worden omgezet na een time-out van t milliseconden.

Retouren

Promise<T | void>

• Opgeloste belofte

isMessagingError(MessagingError | Error)

Bepaalt of een fout een MessagingError is.

function isMessagingError(error: MessagingError | Error): error

Parameters

error

MessagingError | Error

Een fout die een fout of een MessagingError kan zijn.

Retouren

error

isSystemError(unknown)

Controleert of de opgegeven fout een node.js SystemError is.

function isSystemError(err: unknown): err

Parameters

err

unknown

Een object dat mogelijk foutinformatie bevat.

Retouren

err

parseConnectionString<T>(string)

Parseert de verbindingsreeks en retourneert een object van het type T.

Verbindingsreeksen hebben de volgende syntaxis:

ConnectionString ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] Deel ::= [ PartLiteral [ "=" PartLiteral ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Letterlijk ::= ? elke reeks tekens behalve ; or = of WhiteSpace? Witruimte ::= ? alle witruimtetekens, inclusief \r en \n?

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

Parameters

connectionString

string

De verbindingsreeks die moet worden geparseerd.

Retouren

ParsedOutput<T>

ParsedOutput.

retry<T>(RetryConfig<T>)

Elke bewerking wordt ten minste één keer uitgevoerd. Er worden extra pogingen gedaan als de vorige poging is mislukt met een fout die opnieuw kan worden geprobeerd. Het aantal extra pogingen wordt bepaald door de eigenschap maxRetries die is opgegeven in het argument RetryConfig.

Als mode optie is ingesteld op Fixed, worden de nieuwe pogingen voor de opgegeven bewerking gedurende een bepaald aantal keren uitgevoerd, met een vaste vertraging tussen elke nieuwe poging elke keer.

Als mode optie is ingesteld op Exponential, wordt de vertraging tussen nieuwe pogingen aangepast om exponentieel te toenemen met elke poging met behulp van de back-off factor van macht 2.

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

Parameters

config

RetryConfig<T>

Parameters voor het configureren van bewerking voor opnieuw proberen

Retouren

Promise<T>

Beloven.

translate(unknown)

Vertaalt de AMQP-fout die is ontvangen op de protocollaag of een SystemError in een MessagingError. Alle andere fouten worden ongewijzigd geretourneerd.

function translate(err: unknown): MessagingError | Error

Parameters

err

unknown

De amqp-fout die is ontvangen.

Retouren

MessagingError | Error

MessagingError-object.