ServiceBusReceiverOptions interface
خيارات لاستخدامها عند إنشاء جهاز استقبال.
الخصائص
| identifier | تعيين الاسم لتعريف المتلقي. يمكن استخدام هذا لربط السجلات والاستثناءات. إذا لم يتم تحديده أو إفراغه، استخدام واحد فريد عشوائي. |
| max |
الحد الأقصى للمدة، بالمللي ثانية، التي سيتم فيها تجديد التأمين على الرسالة تلقائيا من قبل العميل. يتوقف هذا التجديد التلقائي بمجرد تسوية الرسالة.
مثال : إذا انتهت صلاحية تأمين الرسالة في دقيقتين وكان وقت معالجة الرسائل 8 دقائق... قم بتعيين maxAutoLockRenewalDurationInMs إلى 10 دقائق، وسيتم تجديد قفل الرسالة تلقائيا لمدة 4 مرات (ما يعادل تأمين الرسالة لمدة 4 أضعاف مدة تأمينها من خلال الاستفادة من تجديدات التأمين). |
| receive |
يمثل وضع الاستلام للمتلقي. في وضع receiveAndDelete، يتم حذف الرسائل من ناقل خدمة Microsoft Azure عند تلقيها. في وضع peekLock، يكون لدى المتلقي تأمين على الرسالة للمدة المحددة في قائمة الانتظار/الاشتراك. ستتم إعادة تسليم الرسائل التي لم تتم تسويتها خلال مدة التأمين عدة مرات مثل الحد الأقصى لعدد التسليم المحدد في قائمة الانتظار/الاشتراك، وبعد ذلك يتم إرسالها إلى قائمة انتظار منفصلة غير مستخدمة. يمكنك تسوية رسالة عن طريق استدعاء أساليب complete() أو abandon() أو defer() أو deadletter() على الرسالة. مزيد من المعلومات حول كيفية عمل peekLock وتسوية الرسائل هنا: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock |
| skip |
ما إذا كان يجب تخطي تحويل نوع التاريخ على خصائص التعليقات التوضيحية للرسالة أو خصائص التطبيق إلى أرقام عند تلقي الرسالة. بشكل افتراضي، يتم تحويل خصائص نوع التاريخ إلى رقم فترة UNIX للتوافق. |
| skip |
خيار تعطيل العميل من تشغيل JSON.parse() على نص الرسالة عند تلقي الرسالة. لا ينطبق إذا تم إرسال الرسالة بقيمة أو تسلسل نوع نص AMQP. استخدم هذا الخيار عندما تفضل العمل مباشرة مع وحدات البايت الموجودة في نص الرسالة بدلا من محاولة العميل تحليلها. |
| sub |
يمثل قائمة الانتظار الفرعية التي تنطبق على أي قائمة انتظار أو اشتراك. القيم الصالحة هي "deadLetter" و"transferDeadLetter". لمعرفة المزيد حول قوائم انتظار الرسائل غير المستخدمة، راجع https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues |
تفاصيل الخاصية
identifier
تعيين الاسم لتعريف المتلقي. يمكن استخدام هذا لربط السجلات والاستثناءات. إذا لم يتم تحديده أو إفراغه، استخدام واحد فريد عشوائي.
identifier?: string
قيمة الخاصية
string
maxAutoLockRenewalDurationInMs
الحد الأقصى للمدة، بالمللي ثانية، التي سيتم فيها تجديد التأمين على الرسالة تلقائيا من قبل العميل. يتوقف هذا التجديد التلقائي بمجرد تسوية الرسالة.
-
الافتراضي:
300 * 1000مللي ثانية (5 دقائق). -
لتعطيل تجديد القفل التلقائي، قم بتعيين هذا إلى
0.
مثال :
إذا انتهت صلاحية تأمين الرسالة في دقيقتين وكان وقت معالجة الرسائل 8 دقائق...
قم بتعيين maxAutoLockRenewalDurationInMs إلى 10 دقائق، وسيتم تجديد قفل الرسالة تلقائيا لمدة 4 مرات (ما يعادل تأمين الرسالة لمدة 4 أضعاف مدة تأمينها من خلال الاستفادة من تجديدات التأمين).
maxAutoLockRenewalDurationInMs?: number
قيمة الخاصية
number
receiveMode
يمثل وضع الاستلام للمتلقي.
في وضع receiveAndDelete، يتم حذف الرسائل من ناقل خدمة Microsoft Azure عند تلقيها.
في وضع peekLock، يكون لدى المتلقي تأمين على الرسالة للمدة المحددة في قائمة الانتظار/الاشتراك.
ستتم إعادة تسليم الرسائل التي لم تتم تسويتها خلال مدة التأمين عدة مرات مثل الحد الأقصى لعدد التسليم المحدد في قائمة الانتظار/الاشتراك، وبعد ذلك يتم إرسالها إلى قائمة انتظار منفصلة غير مستخدمة.
يمكنك تسوية رسالة عن طريق استدعاء أساليب complete() أو abandon() أو defer() أو deadletter() على الرسالة.
مزيد من المعلومات حول كيفية عمل peekLock وتسوية الرسائل هنا: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
receiveMode?: "peekLock" | "receiveAndDelete"
قيمة الخاصية
"peekLock" | "receiveAndDelete"
skipConvertingDate
ما إذا كان يجب تخطي تحويل نوع التاريخ على خصائص التعليقات التوضيحية للرسالة أو خصائص التطبيق إلى أرقام عند تلقي الرسالة. بشكل افتراضي، يتم تحويل خصائص نوع التاريخ إلى رقم فترة UNIX للتوافق.
skipConvertingDate?: boolean
قيمة الخاصية
boolean
skipParsingBodyAsJson
خيار تعطيل العميل من تشغيل JSON.parse() على نص الرسالة عند تلقي الرسالة. لا ينطبق إذا تم إرسال الرسالة بقيمة أو تسلسل نوع نص AMQP. استخدم هذا الخيار عندما تفضل العمل مباشرة مع وحدات البايت الموجودة في نص الرسالة بدلا من محاولة العميل تحليلها.
skipParsingBodyAsJson?: boolean
قيمة الخاصية
boolean
subQueueType
يمثل قائمة الانتظار الفرعية التي تنطبق على أي قائمة انتظار أو اشتراك. القيم الصالحة هي "deadLetter" و"transferDeadLetter". لمعرفة المزيد حول قوائم انتظار الرسائل غير المستخدمة، راجع https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues
subQueueType?: "deadLetter" | "transferDeadLetter"
قيمة الخاصية
"deadLetter" | "transferDeadLetter"