@azure/amqp-common package

Sınıflar

AsyncLock
AadTokenProvider	AAD (Azure ActiveDirectory) TokenProvider'ı tanımlar. Bu, `@azure/ms-rest-nodeauth` paketinden aşağıdaki kimlik bilgilerini kabul eder: ApplicationTokenCredentials UserTokenCredentials DeviceTokenCredentials MSITokenCredentials (MSIVmTokenCredentials)
CbsClient
DefaultDataTransformer	Azure SDK tarafından kullanılacak varsayılan veri dönüştürücü.
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.
SasTokenProvider
Timeout	Belirtilen süreyi bekleyebilen ve ardından verilen değerle söz sorununu çözebilen/reddedebilen bir Zaman Aşımı sınıfını açıklar.

Arabirimler

AsyncLockOptions
ConnectionConfig	EventHub veya ServiceBus bağlantı dizesi ayrıştırıldıktan sonra oluşturulan bağlantı yapılandırma nesnesini açıklar.
ConnectionContextBase
EventHubConnectionConfig	Bir EventHub bağlantı dizesi ayrıştırıldıktan sonra oluşturulan bağlantı yapılandırma nesnesini açıklar. Ayrıca, farklı varlıklar için adres ve hedef kitleyi almak için bazı kolaylık yöntemleri sağlar.
MessageHeader	İletinin standart üst bilgi özellikleri kümesini açıklar.
MessageProperties	İletinin tanımlı standart özellikleri kümesini açıklar.
AmqpMessage	Kabloda gönderilen veya alınan AMQP iletisini açıklar.
AmqpMessageHeader	İletinin standart üst bilgi özellikleri kümesini açıklar.
AmqpMessageProperties	İletinin tanımlı standart özellikleri kümesini açıklar.
AsyncLockOptions	Zaman uyumsuz kilit oluşturmak için sağlanacak seçenekleri açıklar.
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.
DataTransformer	Verileri kabloya göndermeden (veya kablodan almadan) önce kodlamak/kodunu çözmek için gerçekleştirilebilecek dönüştürmeleri açıklar.
Dictionary	Yapı <Anahtarı, Değer> T Türü gibi bir Sözlük sağlar.
EventHubConnectionStringModel	eventhub bağlantı dizesi modelini açıklar.
IotHubConnectionStringModel	iothub bağlantı dizesi modelini açıklar.
RetryConfig	Yeniden deneme işlemi için yapılandırılması gereken parametreleri açıklar.
SendRequestOptions	İstek gönderilirken belirtilebilen seçenekleri açıklar.
ServiceBusConnectionStringModel	Servicebus bağlantı dizesi modelini açıklar.
StorageConnectionStringModel	Stroage bağlantı dizesi modelini açıklar.
TokenInfo	Belirteç hakkında bilgi sağlar.
TokenProvider	Temel belirteç sağlayıcısını açıklar.

Tür Diğer Adları

AsyncLockDoneCallback
Func	İşlev türü için tür bildirimi; burada T işlevin girişidir ve V işlevin çıkışıdır.
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.
ConditionStatusMapper	Koşulları sayısal AMQP Yanıt durum kodlarıyla eşler.
ErrorNameConditionMapper	Hata adlarını amqp hata koşullarıyla eşler.
RetryOperationType	Yeniden deneme işlemi türünü açıklar. RetryOperationType
SystemErrorConditionMapper	Bazı SytemError'ları amqp hata koşulları systemErrorConditionMapper ile eşler
TokenType	Desteklenen belirteçlerin türünü açıklar. TokenType

İşlevler

delay<T>(number, T)	t milisaniyeden sonra bir promise'i çözümleyen setTimeout için sarmalayıcı.
executePromisesSequentially(any[], any)
getNewAsyncLock(AsyncLockOptions)	İstenen ayarlarla zaman uyumsuz kilidin yeni bir örneğini alır.
isAmqpError(any)	Verilen hata nesnesinin bir AmqpError nesnesi gibi olup olmadığını belirler.
isIotHubConnectionString(string)	Verilen bağlantı dizesinin bir iothub bağlantı dizesi olup olmadığını belirler.
isSystemError(any)
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 ::= Bölüm { ";" Bölüm } [ ";" ] [ Boşluk ] 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?
randomNumberFromInterval(number, number)	Verilen aralık arasında rastgele bir sayı oluşturur
retry<T>(RetryConfig<T>)	Her yeniden deneme arasında belirli bir gecikmeyle belirtilen sayıda işlemi doğrusal olarak yeniden denemeyi dener. Yeniden denemeler yalnızca hata yeniden denenebilirse gerçekleşir.
translate(Error \| AmqpError)	Protokol katmanında veya genel bir Hatada alınan AQMP hatasını MessagingError'a çevirir.

Değişkenler

defaultLock
isNode	Ortamın node.js mı yoksa tarayıcı mı tabanlı olduğunu gösteren bir sabit.
retryableErrors	Tekrar denenebilir AMQP hatalarının bir listesini sunar. "InternalServerError", "ServerBusyError", "ServiceUnavailableError", "OperationCancelledError", "SenderBusyError", "MessagingError", "DetachForcedError", "ConnectionForcedError", "TransferLimitExceededError", "OperationTimeoutError"

İşlev Ayrıntıları

delay<T>(number, T)

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

function delay<T>(t: number, value?: T): Promise<T>

Parametreler

t: number

Ertelenecek milisaniye sayısı.

value: T

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

Döndürülenler

Promise<T>

Çözümlenen söz

executePromisesSequentially(any[], any)

function executePromisesSequentially(promiseFactories: any[], kickstart?: any): Promise<any>

Parametreler

promiseFactories: any[]

kickstart: any

Döndürülenler

Promise<any>

getNewAsyncLock(AsyncLockOptions)

İstenen ayarlarla zaman uyumsuz kilidin yeni bir örneğini alır.

function getNewAsyncLock(options?: AsyncLockOptions): AsyncLock

Parametreler

options: AsyncLockOptions

Zaman uyumsuz kilit seçenekleri.

Döndürülenler

AsyncLock

isAmqpError(any)

Verilen hata nesnesinin bir AmqpError nesnesi gibi olup olmadığını belirler.

function isAmqpError(err: any): boolean

Parametreler

err: any

AmqpError nesnesi

Döndürülenler

boolean

result - AMQP Hatası olup olmadığını true; false.

isIotHubConnectionString(string)

Verilen bağlantı dizesinin bir iothub bağlantı dizesi olup olmadığını belirler.

function isIotHubConnectionString(connectionString: string): boolean

Parametreler

connectionString: string

Bağlantı dizesi.

Döndürülenler

boolean

Boolean.

isSystemError(any)

function isSystemError(err: any): boolean

Parametreler

err: any

Döndürülenler

boolean

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 ::= Bölüm { ";" Bölüm } [ ";" ] [ Boşluk ] 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>.

randomNumberFromInterval(number, number)

Verilen aralık arasında rastgele bir sayı oluşturur

function randomNumberFromInterval(min: number, max: number): number

Parametreler

min: number

Aralığın en az sayısı (dahil).

max: number

Aralığın en fazla sayısı (dahil).

Döndürülenler

number

retry<T>(RetryConfig<T>)

Her yeniden deneme arasında belirli bir gecikmeyle belirtilen sayıda işlemi doğrusal olarak yeniden denemeyi dener. Yeniden denemeler yalnızca hata yeniden denenebilirse gerçekleşir.

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(Error | AmqpError)

Protokol katmanında veya genel bir Hatada alınan AQMP hatasını MessagingError'a çevirir.

function translate(err: Error | AmqpError): MessagingError

Parametreler

err: Error | AmqpError

Alınan amqp hatası.

Döndürülenler

MessagingError

MessagingError nesnesi.

Variable Details

defaultLock

defaultLock: AsyncLock

Tür

AsyncLock

isNode

Ortamın node.js mı yoksa tarayıcı mı tabanlı olduğunu gösteren bir sabit.

isNode: boolean

Tür

boolean

retryableErrors

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

retryableErrors: string[]

Tür

string[]

Geri Bildirim

Bu sayfayı yararlı buldunuz mu?