@azure/core-amqp package

Sınıflar

CbsClient	AMQP bağlantısı üzerinden $cbs uç noktasıyla konuşan EventHub/ServiceBus Cbs istemcisini açıklar.
MessagingError	Mesajlaşma Hatası için temel sınıfı açıklar.
RequestResponseLink	Bir amqp oturumu üzerinden oluşturulan bir amqp isteği (gönderen)-yanıt(alıcı) bağlantısını açıklar.

Arabirimler

AcquireLockProperties	Kilit alırken sağlanması gereken özellikleri açıklar.
CancellableAsyncLock	CancellableAsyncLock, aynı 'anahtarı' kullanan görevlerin seri olarak yürütülmesini zorlamak için bir mekanizma sağlar. Bekleyen görevler bir abortSignal aracılığıyla el ile iptal edilebilir veya sağlanan bir zaman aşımı değerine ulaşılarak otomatik olarak iptal edilebilir.
CbsResponse	CBS Yanıtını açıklar.
ConnectionConfigOptions	Bağlantı yapılandırması oluşturulurken sağlanacak seçenekleri açıklar.
ConnectionProperties	AMQP bağlantısı kurulurken ayarlanması gereken özellikleri tanımlar.
CreateConnectionContextBaseParameters	Temel bağlantı bağlamını oluşturmak için sağlanacak parametreleri açıklar.
NetworkSystemError	Node.js SystemError üzerindeki alanları açıklar. Ağ çağrılarıyla (örneğin dosya sistemi çağrıları) ilgili olmayan alanları atlar. Bkz. https://nodejs.org/dist/latest-v12.x/docs/api/errors.html#errors_class_systemerror
RetryConfig	Yeniden deneme işlemi için yapılandırılması gereken parametreleri açıklar.
RetryOptions	Modu, yeniden deneme sayısını, yeniden deneme aralığını vb. belirleyen yeniden deneme ilkesi seçenekleri.
SendRequestOptions	İstek gönderilirken belirtilebilen seçenekleri açıklar.
WebSocketOptions	AMQP bağlantısının Web Yuvaları üzerinden kanalını yapılandırma seçenekleri.

Tür Diğer Adları

ParsedOutput

T'de tanımlanan olası özelliklere sahip bir nesne tanımlar.

Numaralandırmalar

ConditionErrorNameMapper	amqp hata koşullarını Hata adlarına eşler.
ErrorNameConditionMapper	Hata adlarını amqp hata koşullarıyla eşler.
RetryMode	Yeniden Deneme Modu türünü açıklar
RetryOperationType	Yeniden deneme işlemi türünü açıklar.
SystemErrorConditionMapper	Bazı SystemErrors'ı amqp hata koşullarıyla eşler
TokenType	Desteklenen belirteçlerin türünü açıklar.

İşlevler

delay<T>(number, AbortSignalLike, string, T)	t milisaniyeden sonra bir promise'i çözümleyen setTimeout için sarmalayıcı.
isMessagingError(MessagingError \| Error)	Bir hatanın MessagingError olup olmadığını belirler.
isSystemError(unknown)	Sağlanan hatanın systemerror node.js olup olmadığını denetler.
parseConnectionString<T>(string)	Bağlantı dizesini ayrıştırarak T türünde bir nesne döndürür. Bağlantı dizeleri aşağıdaki söz dizimine sahiptir: ConnectionString ::= `Part { ";" Part } [ ";" ] [ WhiteSpace ]` Bölümü ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Değişmez Değer [ Boşluk ] Değişmez Değer ::= ? dışında herhangi bir karakter dizisi; veya = veya WhiteSpace ? Boşluk ::= ? `\r` ve `\n` dahil tüm boşluk karakterleri?
retry<T>(RetryConfig<T>)	Her işlem en az bir kez denenmiştir. Önceki deneme yeniden denenebilir bir hatayla başarısız olursa ek denemeler yapılır. Ek deneme sayısı, `maxRetries` bağımsız değişkeninde sağlanan `RetryConfig` özelliğine tabidir. `mode` seçeneği `Fixed`olarak ayarlanırsa, belirtilen işlemde belirtilen sayıda yeniden deneme yapılır ve her yeniden deneme arasında sabit bir gecikme olur. `mode` seçeneği `Exponential`olarak ayarlanırsa, yeniden denemeler arasındaki gecikme, güç 2'nin geri alma faktörünü kullanarak her denemede katlanarak artacak şekilde ayarlanır.
translate(unknown)	Protokol katmanında veya SystemError'da alınan AMQP hatasını MessagingError'a çevirir. Diğer tüm hatalar değiştirilmeden döndürülür.

Değişkenler

AmqpAnnotatedMessage	AmqpAnnotatedMessage üzerinde yapılabilecek (veya elde edilebilecek) işlemleri tanımlar.
AmqpMessageHeader	Mesaj başlığı üzerinde gerçekleştirilebilecek işlemleri tanımlar.
AmqpMessageProperties	AMQP mesaj özellikleri üzerinde gerçekleştirilebilecek işlemleri tanımlar.
ConnectionConfig	ConnectionConfig modülünü tanımlar
ConnectionContextBase
Constants
defaultCancellableLock	İptal edilebilir asenkron kilit örneği.
logger	@azure/logger Bu paketin yapılandırması. Bu, namespace preeki kullanılarak `azure:event-hubs` loglar çıkarır.
retryableErrors	Tekrar denenebilir AMQP hatalarının bir listesini sunar. "InternalServerError", "ServerBusyError", "ServiceUnavailableError", "OperationCancelledError", "SenderBusyError", "SenderNotReadyError", "MessagingError", "DetachForcedError", "ConnectionForcedError", "TransferLimitExceededError"

İşlev Ayrıntıları

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

t milisaniyeden sonra bir promise'i çözümleyen setTimeout için sarmalayıcı.

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

Parametreler

delayInMs: number

Ertelenecek milisaniye sayısı.

abortSignal: AbortSignalLike

içeren işlemle ilişkili abortSignal.

abortErrorMsg: string

İşlemi içeren işlemle ilişkili durdurma hata iletisi.

value: T

T milisaniyelik zaman aşımından sonra çözümlenecek değer.

Döndürülenler

Promise<T | void>

Çözümlenen söz

isMessagingError(MessagingError | Error)

Bir hatanın MessagingError olup olmadığını belirler.

function isMessagingError(error: MessagingError | Error): error

Parametreler

error: MessagingError | Error

Error veya MessagingError olabilecek bir hata.

Döndürülenler

error

isSystemError(unknown)

Sağlanan hatanın systemerror node.js olup olmadığını denetler.

function isSystemError(err: unknown): err

Parametreler

err: unknown

Hata bilgileri içerebilen bir nesne.

Döndürülenler

err

parseConnectionString<T>(string)

Bağlantı dizesini ayrıştırarak T türünde bir nesne döndürür.

Bağlantı dizeleri aşağıdaki söz dizimine sahiptir:

ConnectionString ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] Bölümü ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Değişmez Değer [ Boşluk ] Değişmez Değer ::= ? dışında herhangi bir karakter dizisi; veya = veya WhiteSpace ? Boşluk ::= ? \r ve \n dahil tüm boşluk karakterleri?

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

Parametreler

connectionString: string

Ayrıştırılacak bağlantı dizesi.

Döndürülenler

ParsedOutput<T>

ParsedOutput<T>.

retry<T>(RetryConfig<T>)

Her işlem en az bir kez denenmiştir. Önceki deneme yeniden denenebilir bir hatayla başarısız olursa ek denemeler yapılır. Ek deneme sayısı, maxRetries bağımsız değişkeninde sağlanan RetryConfig özelliğine tabidir.

mode seçeneği Fixedolarak ayarlanırsa, belirtilen işlemde belirtilen sayıda yeniden deneme yapılır ve her yeniden deneme arasında sabit bir gecikme olur.

mode seçeneği Exponentialolarak ayarlanırsa, yeniden denemeler arasındaki gecikme, güç 2'nin geri alma faktörünü kullanarak her denemede katlanarak artacak şekilde ayarlanır.

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

Parametreler

config: RetryConfig<T>

Yeniden deneme işlemini yapılandırmak için parametreler

Döndürülenler

Promise<T>

Söz<T>.

translate(unknown)

Protokol katmanında veya SystemError'da alınan AMQP hatasını MessagingError'a çevirir. Diğer tüm hatalar değiştirilmeden döndürülür.

function translate(err: unknown): MessagingError | Error

Parametreler

err: unknown

Alınan amqp hatası.

Döndürülenler

MessagingError | Error

MessagingError nesnesi.

Variable Details

AmqpAnnotatedMessage

AmqpAnnotatedMessage üzerinde yapılabilecek (veya elde edilebilecek) işlemleri tanımlar.

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

Tür

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

AmqpMessageHeader

Mesaj başlığı üzerinde gerçekleştirilebilecek işlemleri tanımlar.

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

Tür

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

AmqpMessageProperties

AMQP mesaj özellikleri üzerinde gerçekleştirilebilecek işlemleri tanımlar.

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

Tür

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

ConnectionConfig

ConnectionConfig modülünü tanımlar

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

Tür

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

ConnectionContextBase

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

Tür

{ 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" }

Tür

{ 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

İptal edilebilir asenkron kilit örneği.

defaultCancellableLock: CancellableAsyncLock

Tür

CancellableAsyncLock

logger

@azure/logger Bu paketin yapılandırması. Bu, namespace preeki kullanılarak azure:event-hubs loglar çıkarır.

logger: AzureLogger

Tür

AzureLogger

retryableErrors

Tekrar denenebilir AMQP hatalarının bir listesini sunar. "InternalServerError", "ServerBusyError", "ServiceUnavailableError", "OperationCancelledError", "SenderBusyError", "SenderNotReadyError", "MessagingError", "DetachForcedError", "ConnectionForcedError", "TransferLimitExceededError"

retryableErrors: string[]

Tür

string[]

Aracılığıyla paylaş

@azure/core-amqp package

Sınıflar

Arabirimler

Tür Diğer Adları

Numaralandırmalar

İşlevler

Değişkenler

İşlev Ayrıntıları

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

Parametreler

Döndürülenler

isMessagingError(MessagingError | Error)

Parametreler

Döndürülenler

isSystemError(unknown)

Parametreler

Döndürülenler

parseConnectionString<T>(string)

Parametreler

Döndürülenler

retry<T>(RetryConfig<T>)

Parametreler

Döndürülenler

translate(unknown)

Parametreler

Döndürülenler

Variable Details

AmqpAnnotatedMessage

Tür

AmqpMessageHeader

Tür

AmqpMessageProperties

Tür

ConnectionConfig

Tür

ConnectionContextBase

Tür

Constants

Tür

defaultCancellableLock

Tür

logger

Tür

retryableErrors

Tür