@azure/amqp-common package

الفصول

AsyncLock
AadTokenProvider	تعريف AAD (Azure ActiveDirectory) TokenProvider. يقبل هذا بيانات الاعتماد التالية من حزمة `@azure/ms-rest-nodeauth`: ApplicationTokenCredentials UserTokenCredentials DeviceTokenCredentials MSITokenCredentials (MSIVmTokenCredentials)
CbsClient
DefaultDataTransformer	محول البيانات الافتراضي الذي سيتم استخدامه بواسطة Azure SDK.
MessagingError	يصف الفئة الأساسية لخطأ المراسلة.
RequestResponseLink	يصف ارتباط amqp request(sender)-response(receiver) الذي تم إنشاؤه عبر جلسة amqp.
SasTokenProvider
Timeout	توضح هذه المقالة فئة المهلة التي يمكنها الانتظار لفترة زمنية محددة ثم حل/رفض الوعد بالقيمة المحددة.

الواجهات

AsyncLockOptions
ConnectionConfig	يصف كائن تكوين الاتصال الذي تم إنشاؤه بعد تحليل سلسلة اتصال EventHub أو ServiceBus.
ConnectionContextBase
EventHubConnectionConfig	يصف كائن تكوين الاتصال الذي تم إنشاؤه بعد تحليل سلسلة اتصال EventHub. كما يوفر بعض الطرق الملائمة للحصول على العنوان والجمهور لكيانات مختلفة.
MessageHeader	توضح هذه المقالة مجموعة محددة من خصائص الرأس القياسية للرسالة.
MessageProperties	توضح هذه المقالة مجموعة محددة من الخصائص القياسية للرسالة.
AmqpMessage	توضح هذه المقالة رسالة AMQP التي يتم إرسالها أو تلقيها على السلك.
AmqpMessageHeader	توضح هذه المقالة مجموعة محددة من خصائص الرأس القياسية للرسالة.
AmqpMessageProperties	توضح هذه المقالة مجموعة محددة من الخصائص القياسية للرسالة.
AsyncLockOptions	توضح هذه المقالة الخيارات التي يمكن توفيرها لإنشاء تأمين غير متزامن.
CbsResponse	يصف استجابة CBS.
ConnectionConfigOptions	توضح هذه المقالة الخيارات التي يمكن توفيرها أثناء إنشاء تكوين اتصال.
ConnectionProperties	تعريف الخصائص التي يجب تعيينها أثناء إنشاء اتصال AMQP.
CreateConnectionContextBaseParameters	يصف المعلمات التي يمكن توفيرها لإنشاء سياق الاتصال الأساسي.
DataTransformer	يصف التحويلات التي يمكن إجراؤها لترميز/فك ترميز البيانات قبل إرسالها على (أو تلقيها من) السلك.
Dictionary	يوفر قاموسا مثل البنية <Key و Value> من النوع T.
EventHubConnectionStringModel	يصف نموذج سلسلة اتصال eventhub.
IotHubConnectionStringModel	يصف نموذج سلسلة اتصال iothub.
RetryConfig	يصف المعلمات التي تحتاج إلى تكوين لعملية إعادة المحاولة.
SendRequestOptions	توضح هذه المقالة الخيارات التي يمكن تحديدها أثناء إرسال طلب.
ServiceBusConnectionStringModel	يصف نموذج سلسلة اتصال servicebus.
StorageConnectionStringModel	يصف نموذج سلسلة اتصال stroage.
TokenInfo	يوفر معلومات حول الرمز المميز.
TokenProvider	يصف موفر الرمز المميز الأساسي.

النوع أسماء مستعارة

AsyncLockDoneCallback
Func	تعريف النوع لنوع الدالة حيث T هو الإدخال إلى الدالة وV هو إخراج الدالة.
ParsedOutput	تعريف كائن بخصائص محتملة محددة في T.

التعدادات

ConditionErrorNameMapper	تعيين شروط الخطأ amqp إلى أسماء الأخطاء.
ConditionStatusMapper	تعيين الشروط إلى رموز حالة استجابة AMQP الرقمية.
ErrorNameConditionMapper	تعيين أسماء الأخطاء إلى شروط الخطأ amqp.
RetryOperationType	يصف نوع عملية إعادة المحاولة. نوع إعادة المحاولة
SystemErrorConditionMapper	تعيين بعض SytemErrors لشروط الخطأ amqp SystemErrorConditionMapper
TokenType	يصف نوع الرموز المميزة المدعومة. نوع الرمز المميز

الوظائف

delay<T>(number, T)	برنامج تضمين ل setTimeout الذي يحل الوعد بعد t مللي ثانية.
executePromisesSequentially(any[], any)
getNewAsyncLock(AsyncLockOptions)	يحصل على مثيل جديد من التأمين غير المتزامن مع الإعدادات المطلوبة.
isAmqpError(any)	تحديد ما إذا كان كائن الخطأ المحدد مثل كائن AmqpError.
isIotHubConnectionString(string)	تحديد ما إذا كانت سلسلة الاتصال المحددة سلسلة اتصال iothub.
isSystemError(any)
parseConnectionString<T>(string)	تحليل سلسلة الاتصال وإرجاع كائن من النوع T. سلاسل الاتصال لها بناء الجملة التالي: ConnectionString ::= الجزء { ";" الجزء } [ ";" ] [ مسافة بيضاء ] Part ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? أي تسلسل من الأحرف باستثناء ؛ أو = أو WhiteSpace؟ WhiteSpace ::= ؟ جميع أحرف المسافة البيضاء بما في ذلك \r \n؟
randomNumberFromInterval(number, number)	إنشاء رقم عشوائي بين الفاصل الزمني المحدد
retry<T>(RetryConfig<T>)	سيحاول إعادة محاولة عملية عدد محدد من المرات خطيا مع تأخير محدد بين كل إعادة محاولة. لن تحدث إعادة المحاولة إلا إذا كان الخطأ قابلا لإعادة المحاولة.
translate(Error \| AmqpError)	يترجم خطأ AQMP المستلم في طبقة البروتوكول أو خطأ عام إلى MessagingError.

المتغيرات

defaultLock
isNode	ثابت يشير إلى ما إذا كانت البيئة node.js أو تعتمد على المتصفح.
retryableErrors	يوفر قائمة بأخطاء AMQP القابلة لإعادة المحاولة. "إنترنالسيرفيرورور"، "سيرفربوزي إيرور"، "سيرسيريوناليسرور"، "أوشيونشلدإرورور"، "سيندر بوزي إيرور"، "رسالة"، "ديتلافجبر إيرور"، "كونكشنجفرود إيرور"، "ترانسليتمايت إيكسيدد رور"، "أوريشتايمايتوت إيرور"

تفاصيل الوظيفة

delay<T>(number, T)

برنامج تضمين ل setTimeout الذي يحل الوعد بعد t مللي ثانية.

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

المعلمات

t: number

عدد المللي ثانية التي سيتم تأخيرها.

value: T

القيمة التي سيتم حلها بعد انتهاء مهلة ميلي ثانية.

المرتجعات

Promise<T>

الوعد الذي تم حله

executePromisesSequentially(any[], any)

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

المعلمات

promiseFactories: any[]

kickstart: any

المرتجعات

Promise<any>

getNewAsyncLock(AsyncLockOptions)

يحصل على مثيل جديد من التأمين غير المتزامن مع الإعدادات المطلوبة.

function getNewAsyncLock(options?: AsyncLockOptions): AsyncLock

المعلمات

options: AsyncLockOptions

خيارات التأمين غير المتزامن.

المرتجعات

AsyncLock

isAmqpError(any)

تحديد ما إذا كان كائن الخطأ المحدد مثل كائن AmqpError.

function isAmqpError(err: any): boolean

المعلمات

err: any

كائن AmqpError

المرتجعات

boolean

result - true إذا كان خطأ AMQP؛ false خلاف ذلك.

isIotHubConnectionString(string)

تحديد ما إذا كانت سلسلة الاتصال المحددة سلسلة اتصال iothub.

function isIotHubConnectionString(connectionString: string): boolean

المعلمات

connectionString: string

سلسلة الاتصال.

المرتجعات

boolean

منطقيه.

isSystemError(any)

function isSystemError(err: any): boolean

المعلمات

err: any

المرتجعات

boolean

parseConnectionString<T>(string)

تحليل سلسلة الاتصال وإرجاع كائن من النوع T.

سلاسل الاتصال لها بناء الجملة التالي:

ConnectionString ::= الجزء { ";" الجزء } [ ";" ] [ مسافة بيضاء ] Part ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? أي تسلسل من الأحرف باستثناء ؛ أو = أو WhiteSpace؟ WhiteSpace ::= ؟ جميع أحرف المسافة البيضاء بما في ذلك \r \n؟

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

المعلمات

connectionString: string

سلسلة الاتصال التي سيتم تحليلها.

المرتجعات

ParsedOutput<T>

تحليل الإخراج<ت>.

randomNumberFromInterval(number, number)

إنشاء رقم عشوائي بين الفاصل الزمني المحدد

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

المعلمات

min: number

الحد الأدنى لعدد النطاق (شامل).

max: number

الحد الأقصى لعدد النطاق (شامل).

المرتجعات

number

retry<T>(RetryConfig<T>)

سيحاول إعادة محاولة عملية عدد محدد من المرات خطيا مع تأخير محدد بين كل إعادة محاولة. لن تحدث إعادة المحاولة إلا إذا كان الخطأ قابلا لإعادة المحاولة.

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

المعلمات

config: RetryConfig<T>

معلمات لتكوين عملية إعادة المحاولة.

المرتجعات

Promise<T>

وعد<ت.>

translate(Error | AmqpError)

يترجم خطأ AQMP المستلم في طبقة البروتوكول أو خطأ عام إلى MessagingError.

function translate(err: Error | AmqpError): MessagingError

المعلمات

err: Error | AmqpError

خطأ amqp الذي تم تلقيه.

المرتجعات

MessagingError

كائن MessagingError.

Variable Details

defaultLock

defaultLock: AsyncLock

النوع

AsyncLock

isNode

ثابت يشير إلى ما إذا كانت البيئة node.js أو تعتمد على المتصفح.

isNode: boolean

النوع

boolean

retryableErrors

يوفر قائمة بأخطاء AMQP القابلة لإعادة المحاولة. "إنترنالسيرفيرورور"، "سيرفربوزي إيرور"، "سيرسيريوناليسرور"، "أوشيونشلدإرورور"، "سيندر بوزي إيرور"، "رسالة"، "ديتلافجبر إيرور"، "كونكشنجفرود إيرور"، "ترانسليتمايت إيكسيدد رور"، "أوريشتايمايتوت إيرور"

retryableErrors: string[]

النوع

string[]

الملاحظات

هل كانت هذه الصفحة مفيدة؟