ServiceBusReceiverOptions interface
Alıcı oluştururken kullanılacak seçenekler.
Özellikler
| identifier | Alıcıyı tanımlamak için adı ayarlar. Bu, günlükleri ve özel durumları ilişkilendirmek için kullanılabilir. Belirtilmezse veya boşsa rastgele benzersiz bir tane kullanılır. |
| max |
İletideki kilidin istemci tarafından otomatik olarak yenilenmesi için milisaniye cinsinden en uzun süre. İleti tamamlandıktan sonra bu otomatik yenileme durdurulur.
Örnek: İleti kilidinin süresi 2 dakika içinde dolarsa ve ileti işleme süreniz 8 dakikaysa... maxAutoLockRenewalDurationInMs değerini 10 dakika olarak ayarlayın ve ileti kilidi 4 kez otomatik olarak yenilenir (kilit yenilemelerinden yararlanarak iletinin kilit süresinin 4 katı boyunca kilitlenmesine eşdeğerdir). |
| receive |
Alıcı için alma modunu temsil eder. receiveAndDelete modunda iletiler alındıkça Service Bus'tan silinir. PeekLock modunda, alıcının kuyrukta/abonelikte belirtilen süre boyunca iletide bir kilidi vardır. Kilit süresi içinde tamamlanmamış iletiler, kuyrukta/abonelikte ayarlanan maksimum teslim sayısı kadar tekrar teslim edilir ve ardından ayrı bir teslim edilemeyen ileti kuyruğuna gönderilir. İletide complete(), abandon(), defer() veya deadletter() yöntemlerini çağırarak iletiyi çözebilirsiniz. PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgi için buraya bakın: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock |
| skip |
İletiyi alırken ileti ek açıklamalarının veya uygulama özelliklerinin özelliklerindeki Tarih türünün sayılara dönüştürülmesinin atlanıp atlanmadığı. Varsayılan olarak, Tarih türünün özellikleri uyumluluk için UNIX dönem numarasına dönüştürülür. |
| skip |
İstemcinin, iletiyi alırken ileti gövdesinde JSON.parse() çalıştırmasını devre dışı bırakma seçeneği. İleti AMQP gövde türü değeri veya dizisiyle gönderildiyse geçerli değildir. İstemcinin bunu ayrıştırmaya çalışmasındansa ileti gövdesinde bulunan baytlarla doğrudan çalışmayı tercih ettiğinizde bu seçeneği kullanın. |
| sub |
Herhangi bir kuyruk veya abonelik için geçerli olan alt kuyruğu temsil eder. Geçerli değerler "deadLetter" ve "transferDeadLetter" değerleridir. Teslim edilemeyen ileti kuyrukları hakkında daha fazla bilgi edinmek için bkz. https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues |
Özellik Ayrıntıları
identifier
Alıcıyı tanımlamak için adı ayarlar. Bu, günlükleri ve özel durumları ilişkilendirmek için kullanılabilir. Belirtilmezse veya boşsa rastgele benzersiz bir tane kullanılır.
identifier?: string
Özellik Değeri
string
maxAutoLockRenewalDurationInMs
İletideki kilidin istemci tarafından otomatik olarak yenilenmesi için milisaniye cinsinden en uzun süre. İleti tamamlandıktan sonra bu otomatik yenileme durdurulur.
-
Varsayılan:
300 * 1000milisaniye (5 dakika). -
Yenilemeyiotomatik kilitlemeyi devre dışı bırakmak için bunu
0olarak ayarlayın.
Örnek:
İleti kilidinin süresi 2 dakika içinde dolarsa ve ileti işleme süreniz 8 dakikaysa...
maxAutoLockRenewalDurationInMs değerini 10 dakika olarak ayarlayın ve ileti kilidi 4 kez otomatik olarak yenilenir (kilit yenilemelerinden yararlanarak iletinin kilit süresinin 4 katı boyunca kilitlenmesine eşdeğerdir).
maxAutoLockRenewalDurationInMs?: number
Özellik Değeri
number
receiveMode
Alıcı için alma modunu temsil eder.
receiveAndDelete modunda iletiler alındıkça Service Bus'tan silinir.
PeekLock modunda, alıcının kuyrukta/abonelikte belirtilen süre boyunca iletide bir kilidi vardır.
Kilit süresi içinde tamamlanmamış iletiler, kuyrukta/abonelikte ayarlanan maksimum teslim sayısı kadar tekrar teslim edilir ve ardından ayrı bir teslim edilemeyen ileti kuyruğuna gönderilir.
İletide complete(), abandon(), defer() veya deadletter() yöntemlerini çağırarak iletiyi çözebilirsiniz.
PeekLock ve ileti düzenlemenin nasıl çalıştığı hakkında daha fazla bilgi için buraya bakın: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
receiveMode?: "peekLock" | "receiveAndDelete"
Özellik Değeri
"peekLock" | "receiveAndDelete"
skipConvertingDate
İletiyi alırken ileti ek açıklamalarının veya uygulama özelliklerinin özelliklerindeki Tarih türünün sayılara dönüştürülmesinin atlanıp atlanmadığı. Varsayılan olarak, Tarih türünün özellikleri uyumluluk için UNIX dönem numarasına dönüştürülür.
skipConvertingDate?: boolean
Özellik Değeri
boolean
skipParsingBodyAsJson
İstemcinin, iletiyi alırken ileti gövdesinde JSON.parse() çalıştırmasını devre dışı bırakma seçeneği. İleti AMQP gövde türü değeri veya dizisiyle gönderildiyse geçerli değildir. İstemcinin bunu ayrıştırmaya çalışmasındansa ileti gövdesinde bulunan baytlarla doğrudan çalışmayı tercih ettiğinizde bu seçeneği kullanın.
skipParsingBodyAsJson?: boolean
Özellik Değeri
boolean
subQueueType
Herhangi bir kuyruk veya abonelik için geçerli olan alt kuyruğu temsil eder. Geçerli değerler "deadLetter" ve "transferDeadLetter" değerleridir. Teslim edilemeyen ileti kuyrukları hakkında daha fazla bilgi edinmek için bkz. https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues
subQueueType?: "deadLetter" | "transferDeadLetter"
Özellik Değeri
"deadLetter" | "transferDeadLetter"