@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.
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.
ConnectionConfigOptions	Popisuje možnosti, které lze poskytnout při vytváření konfigurace připojení.
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 `maxRetriesRetryConfig` 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.

Proměnné

AmqpAnnotatedMessage	Popisuje operace, které lze provést na (nebo získat) AmqpAnnotatedMessage.
AmqpMessageHeader	Popisuje operace, které lze provést na hlavičce zprávy.
AmqpMessageProperties	Popisuje operace, které lze provádět na vlastnostech zprávy amqp.
ConnectionConfig	Popisuje modul ConnectionConfig
ConnectionContextBase
Constants
defaultCancellableLock	Instance zrušitelného asynchronního zámku.
logger	Konfigurace @azure/logger tohoto balíčku. Tím se budou výstupy logů s prefixem `azure:event-hubs` jmenného prostoru.
retryableErrors	Poskytuje seznam opakovatelných chyb AMQP. "InternalServerError", "ServerBusyError", "ServiceUnavailableError", "OperationCancelledError", "SenderBusyError", "SenderNotReadyError", "MessagingError", "DetachForcedError", "ConnectionForcedError", "TransferLimitExceededError"

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

ParsedOutput<T>.

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

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.

Variable Details

AmqpAnnotatedMessage

Popisuje operace, které lze provést na (nebo získat) AmqpAnnotatedMessage.

AmqpAnnotatedMessage: { fromRheaMessage(msg: Message) => AmqpAnnotatedMessage, toRheaMessage(msg: AmqpAnnotatedMessage) => Message }

Typ

{ fromRheaMessage(msg: Message) => AmqpAnnotatedMessage, toRheaMessage(msg: AmqpAnnotatedMessage) => Message }

AmqpMessageHeader

Popisuje operace, které lze provést na hlavičce zprávy.

AmqpMessageHeader: { fromRheaMessageHeader(props: MessageHeader) => AmqpMessageHeader, toRheaMessageHeader(props: AmqpMessageHeader) => MessageHeader }

Typ

{ fromRheaMessageHeader(props: MessageHeader) => AmqpMessageHeader, toRheaMessageHeader(props: AmqpMessageHeader) => MessageHeader }

AmqpMessageProperties

Popisuje operace, které lze provádět na vlastnostech zprávy amqp.

AmqpMessageProperties: { fromRheaMessageProperties(props: MessageProperties) => AmqpMessageProperties, toRheaMessageProperties(props: AmqpMessageProperties) => MessageProperties }

Typ

{ fromRheaMessageProperties(props: MessageProperties) => AmqpMessageProperties, toRheaMessageProperties(props: AmqpMessageProperties) => MessageProperties }

ConnectionConfig

Popisuje modul ConnectionConfig

ConnectionConfig: { create(connectionString: string, path?: string) => ConnectionConfig, validate(config: ConnectionConfig, options?: ConnectionConfigOptions) => void }

Typ

{ create(connectionString: string, path?: string) => ConnectionConfig, validate(config: ConnectionConfig, options?: ConnectionConfigOptions) => void }

ConnectionContextBase

ConnectionContextBase: { create(parameters: CreateConnectionContextBaseParameters) => ConnectionContextBase }

Typ

{ create(parameters: CreateConnectionContextBaseParameters) => ConnectionContextBase }

Constants

Constants: { TCP: "tcp", TLS: "tls", aadEventHubsAudience: "https://eventhubs.azure.net/", aadEventHubsScope: "https://eventhubs.azure.net//.default", aadServiceBusAudience: "https://servicebus.azure.net/", aadServiceBusScope: "https://servicebus.azure.net//.default", aadTokenValidityMarginInMs: 5000, associatedLinkName: "associated-link-name", attachEpoch: "com.microsoft:epoch", cbsEndpoint: "$cbs", cbsReplyTo: "cbs", connectionError: "connection_error", connectionReconnectDelay: 300, dateTimeOffset: "com.microsoft:datetime-offset", deadLetterDescription: "deadletter-description", deadLetterName: "com.microsoft:dead-letter", deadLetterReason: "deadletter-reason", deadLetterSource: "x-opt-deadletter-source", defaultConnectionIdleTimeoutInMs: 60000, defaultConsumerGroup: "$default", defaultDelayBetweenOperationRetriesInMs: 30000, defaultMaxDelayForExponentialRetryInMs: 90000, defaultMaxRetries: 3, defaultMaxRetriesForConnection: 150, defaultOperationTimeoutInMs: 60000, defaultPrefetchCount: 1000, descriptorCodes: { correlationFilterList: 83483426825, falseFilterList: 83483426824, ruleDescriptionList: 1335734829060, sqlFilterList: 83483426822, sqlRuleActionList: 1335734829062, trueFilterList: 83483426823 }, dispositionStatus: "disposition-status", enableReceiverRuntimeMetricName: "com.microsoft:enable-receiver-runtime-metric", enqueueSequenceNumber: "x-opt-enqueue-sequence-number", enqueuedTime: "x-opt-enqueued-time", enqueuedTimeAnnotation: "amqp.annotation.x-opt-enqueued-time", enqueuedTimeUtc: "enqueued-time-utc", ensureContainerAndBlob: "ensureContainerAndBlob", error: "error", errorCondition: "error-condition", establishConnection: "establishConnection", eventHub: "eventhub", fromSequenceNumber: "from-sequence-number", guidSize: 16, lockTokenMapKey: "lock-token", lockTokens: "lock-tokens", lockedUntil: "x-opt-locked-until", management: "$management", managementRequestKey: "managementRequest", maxAbsoluteExpiryTime: number, maxDeadLetterReasonLength: 4096, maxDurationValue: 922337203685477, maxMessageIdLength: 128, maxPartitionKeyLength: 128, maxSessionIdLength: 128, maxUint32Value: 4294967295, maxUserAgentLength: 512, maximumSqlFilterStatementLength: 1024, maximumSqlRuleActionStatementLength: 1024, message: "message", messageCount: "message-count", messageIdMapKey: "message-id", messageState: "x-opt-message-state", minDurationValue: -922337203685477, negotiateCbsKey: "negotiateCbs", negotiateClaim: "negotiateClaim", offset: "x-opt-offset", offsetAnnotation: "amqp.annotation.x-opt-offset", operationPutToken: "put-token", operations: { addRule: "com.microsoft:add-rule", cancelScheduledMessage: "com.microsoft:cancel-scheduled-message", deleteMessages: "com.microsoft:batch-delete-messages", enumerateRules: "com.microsoft:enumerate-rules", enumerateSessions: "com.microsoft:get-message-sessions", getSessionState: "com.microsoft:get-session-state", peekMessage: "com.microsoft:peek-message", putToken: "put-token", read: "READ", receiveBySequenceNumber: "com.microsoft:receive-by-sequence-number", removeRule: "com.microsoft:remove-rule", renewLock: "com.microsoft:renew-lock", renewSessionLock: "com.microsoft:renew-session-lock", scheduleMessage: "com.microsoft:schedule-message", setSessionState: "com.microsoft:set-session-state", updateDisposition: "com.microsoft:update-disposition" }, partition: "partition", partitionId: "partitionId", partitionIdName: "x-opt-partition-id", partitionKey: "x-opt-partition-key", pathDelimiter: "/", propertiesToModify: "properties-to-modify", publisher: "x-opt-publisher-name", readOperation: "READ", receiverError: "receiver_error", receiverIdentifierName: "com.microsoft:receiver-name", receiverSettleMode: "receiver-settle-mode", reconnectLimit: 100, ruleNameMaximumLength: 50, scheduledEnqueueTime: "x-opt-scheduled-enqueue-time", senderError: "sender_error", sequenceNumber: "x-opt-sequence-number", sequenceNumberAnnotation: "amqp.annotation.x-opt-sequence-number", sequenceNumberMapKey: "sequence-number", sequenceNumbers: "sequence-numbers", serverTimeout: "com.microsoft:server-timeout", sessionError: "session_error", sessionFilterName: "com.microsoft:session-filter", sessionIdMapKey: "session-id", statusCode: "status-code", statusDescription: "status-description", timespan: "com.microsoft:timespan", trackingId: "com.microsoft:tracking-id", uri: "com.microsoft:uri", vendorString: "com.microsoft", viaPartitionKey: "x-opt-via-partition-key" }

Typ

{ TCP: "tcp", TLS: "tls", aadEventHubsAudience: "https://eventhubs.azure.net/", aadEventHubsScope: "https://eventhubs.azure.net//.default", aadServiceBusAudience: "https://servicebus.azure.net/", aadServiceBusScope: "https://servicebus.azure.net//.default", aadTokenValidityMarginInMs: 5000, associatedLinkName: "associated-link-name", attachEpoch: "com.microsoft:epoch", cbsEndpoint: "$cbs", cbsReplyTo: "cbs", connectionError: "connection_error", connectionReconnectDelay: 300, dateTimeOffset: "com.microsoft:datetime-offset", deadLetterDescription: "deadletter-description", deadLetterName: "com.microsoft:dead-letter", deadLetterReason: "deadletter-reason", deadLetterSource: "x-opt-deadletter-source", defaultConnectionIdleTimeoutInMs: 60000, defaultConsumerGroup: "$default", defaultDelayBetweenOperationRetriesInMs: 30000, defaultMaxDelayForExponentialRetryInMs: 90000, defaultMaxRetries: 3, defaultMaxRetriesForConnection: 150, defaultOperationTimeoutInMs: 60000, defaultPrefetchCount: 1000, descriptorCodes: { correlationFilterList: 83483426825, falseFilterList: 83483426824, ruleDescriptionList: 1335734829060, sqlFilterList: 83483426822, sqlRuleActionList: 1335734829062, trueFilterList: 83483426823 }, dispositionStatus: "disposition-status", enableReceiverRuntimeMetricName: "com.microsoft:enable-receiver-runtime-metric", enqueueSequenceNumber: "x-opt-enqueue-sequence-number", enqueuedTime: "x-opt-enqueued-time", enqueuedTimeAnnotation: "amqp.annotation.x-opt-enqueued-time", enqueuedTimeUtc: "enqueued-time-utc", ensureContainerAndBlob: "ensureContainerAndBlob", error: "error", errorCondition: "error-condition", establishConnection: "establishConnection", eventHub: "eventhub", fromSequenceNumber: "from-sequence-number", guidSize: 16, lockTokenMapKey: "lock-token", lockTokens: "lock-tokens", lockedUntil: "x-opt-locked-until", management: "$management", managementRequestKey: "managementRequest", maxAbsoluteExpiryTime: number, maxDeadLetterReasonLength: 4096, maxDurationValue: 922337203685477, maxMessageIdLength: 128, maxPartitionKeyLength: 128, maxSessionIdLength: 128, maxUint32Value: 4294967295, maxUserAgentLength: 512, maximumSqlFilterStatementLength: 1024, maximumSqlRuleActionStatementLength: 1024, message: "message", messageCount: "message-count", messageIdMapKey: "message-id", messageState: "x-opt-message-state", minDurationValue: -922337203685477, negotiateCbsKey: "negotiateCbs", negotiateClaim: "negotiateClaim", offset: "x-opt-offset", offsetAnnotation: "amqp.annotation.x-opt-offset", operationPutToken: "put-token", operations: { addRule: "com.microsoft:add-rule", cancelScheduledMessage: "com.microsoft:cancel-scheduled-message", deleteMessages: "com.microsoft:batch-delete-messages", enumerateRules: "com.microsoft:enumerate-rules", enumerateSessions: "com.microsoft:get-message-sessions", getSessionState: "com.microsoft:get-session-state", peekMessage: "com.microsoft:peek-message", putToken: "put-token", read: "READ", receiveBySequenceNumber: "com.microsoft:receive-by-sequence-number", removeRule: "com.microsoft:remove-rule", renewLock: "com.microsoft:renew-lock", renewSessionLock: "com.microsoft:renew-session-lock", scheduleMessage: "com.microsoft:schedule-message", setSessionState: "com.microsoft:set-session-state", updateDisposition: "com.microsoft:update-disposition" }, partition: "partition", partitionId: "partitionId", partitionIdName: "x-opt-partition-id", partitionKey: "x-opt-partition-key", pathDelimiter: "/", propertiesToModify: "properties-to-modify", publisher: "x-opt-publisher-name", readOperation: "READ", receiverError: "receiver_error", receiverIdentifierName: "com.microsoft:receiver-name", receiverSettleMode: "receiver-settle-mode", reconnectLimit: 100, ruleNameMaximumLength: 50, scheduledEnqueueTime: "x-opt-scheduled-enqueue-time", senderError: "sender_error", sequenceNumber: "x-opt-sequence-number", sequenceNumberAnnotation: "amqp.annotation.x-opt-sequence-number", sequenceNumberMapKey: "sequence-number", sequenceNumbers: "sequence-numbers", serverTimeout: "com.microsoft:server-timeout", sessionError: "session_error", sessionFilterName: "com.microsoft:session-filter", sessionIdMapKey: "session-id", statusCode: "status-code", statusDescription: "status-description", timespan: "com.microsoft:timespan", trackingId: "com.microsoft:tracking-id", uri: "com.microsoft:uri", vendorString: "com.microsoft", viaPartitionKey: "x-opt-via-partition-key" }

defaultCancellableLock

Instance zrušitelného asynchronního zámku.

defaultCancellableLock: CancellableAsyncLock

Typ

CancellableAsyncLock

logger

Konfigurace @azure/logger tohoto balíčku. Tím se budou výstupy logů s prefixem azure:event-hubs jmenného prostoru.

logger: AzureLogger

Typ

AzureLogger

retryableErrors

Poskytuje seznam opakovatelných chyb AMQP. "InternalServerError", "ServerBusyError", "ServiceUnavailableError", "OperationCancelledError", "SenderBusyError", "SenderNotReadyError", "MessagingError", "DetachForcedError", "ConnectionForcedError", "TransferLimitExceededError"

retryableErrors: string[]

Typ

string[]

Sdílet prostřednictvím

@azure/core-amqp package

Třídy

Rozhraní

Aliasy typu

Výčty

Funkce

Proměnné

Podrobnosti funkce

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

Parametry

Návraty

isMessagingError(MessagingError | Error)

Parametry

Návraty

isSystemError(unknown)

Parametry

Návraty

parseConnectionString<T>(string)

Parametry

Návraty

retry<T>(RetryConfig<T>)

Parametry

Návraty

translate(unknown)

Parametry

Návraty

Variable Details

AmqpAnnotatedMessage

Typ

AmqpMessageHeader

Typ

AmqpMessageProperties

Typ

ConnectionConfig

Typ

ConnectionContextBase

Typ

Constants

Typ

defaultCancellableLock

Typ

logger

Typ

retryableErrors

Typ