ServiceBusReceiverOptions interface

Csomag:

@azure/service-bus

A fogadó létrehozásakor használandó beállítások.

Tulajdonságok

identifier	Beállítja a nevet a fogadó azonosításához. Ez a naplók és kivételek korrelálásához használható. Ha nincs megadva vagy üres, a rendszer egy véletlenszerű egyedit használ.
maxAutoLockRenewalDurationInMs	Az üzenet zárolásának maximális időtartama ezredmásodpercben az ügyfél automatikusan megújul. Az automatikus megújítás az üzenet véglegesítését követően leáll. Alapértelmezett: 300 * 1000 ezredmásodperc (5 perc). Az automatikus zárolás megújításának letiltásához állítsa a következőre: 0. Példa Ha az üzenetzár 2 perc múlva lejár, és az üzenetfeldolgozási idő 8 perc... Állítsa a maxAutoLockRenewalDurationInMs értéket 10 percre, és az üzenet zárolása automatikusan meg lesz újítva 4 alkalommal (ami azzal egyenértékű, hogy az üzenet a zárolás megújításával 4-szer zárolva van).
receiveMode	A fogadó fogadási módját jelöli. A receiveAndDelete módban az üzenetek a fogadásukkor törlődnek a Service Busból. PeekLock módban a fogadó zárolja az üzenetet az üzenetsoron/előfizetésben megadott időtartamig. A zárolási időtartamon belül nem rendezett üzeneteket a rendszer annyiszor rendezi újra, mint az üzenetsoron/előfizetésen beállított maximális kézbesítési szám, amely után a rendszer egy külön kézbesítetlen levelek várólistájára küldi őket. Az üzenet rendezéséhez hívja meg a complete(), a abandon(), a defer() vagy a deadletter() metódust az üzeneten. A peekLock és az üzenetegyenlítés működéséről itt talál további információt: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
skipConvertingDate	Az üzenet fogadásakor kihagyhatja-e az üzenetjegyzetek vagy alkalmazástulajdonságok dátumtípusának számmá alakítását. Alapértelmezés szerint a Dátum típusú tulajdonságok UNIX-epoch számmá alakulnak a kompatibilitás érdekében.
skipParsingBodyAsJson	A JSON.parse() futtatásának letiltása az ügyfél számára az üzenet érkezésekor az üzenet törzsén. Nem alkalmazható, ha az üzenetet AMQP törzstípus-értékkel vagy sorozattal küldték el. Akkor használja ezt a lehetőséget, ha inkább közvetlenül az üzenet törzsében található bájtokkal dolgozik, mint amikor az ügyfél megkísérli elemezni.
subQueueType	Azt az alsort jelöli, amely bármely üzenetsorhoz vagy előfizetéshez alkalmazható. Az érvényes értékek a "deadLetter" és a "transferDeadLetter". A kézbesítetlen levelek üzenetsorairól további információt a következő témakörben talál: https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Tulajdonság adatai

identifier

Beállítja a nevet a fogadó azonosításához. Ez a naplók és kivételek korrelálásához használható. Ha nincs megadva vagy üres, a rendszer egy véletlenszerű egyedit használ.

identifier?: string

Tulajdonság értéke

string

maxAutoLockRenewalDurationInMs

Az üzenet zárolásának maximális időtartama ezredmásodpercben az ügyfél automatikusan megújul. Az automatikus megújítás az üzenet véglegesítését követően leáll.

• Alapértelmezett: 300 * 1000 ezredmásodperc (5 perc).
• Az automatikus zárolás megújításának letiltásához állítsa a következőre: 0.

Példa

Ha az üzenetzár 2 perc múlva lejár, és az üzenetfeldolgozási idő 8 perc...

Állítsa a maxAutoLockRenewalDurationInMs értéket 10 percre, és az üzenet zárolása automatikusan meg lesz újítva 4 alkalommal (ami azzal egyenértékű, hogy az üzenet a zárolás megújításával 4-szer zárolva van).

maxAutoLockRenewalDurationInMs?: number

Tulajdonság értéke

number

receiveMode

A fogadó fogadási módját jelöli.

A receiveAndDelete módban az üzenetek a fogadásukkor törlődnek a Service Busból.

PeekLock módban a fogadó zárolja az üzenetet az üzenetsoron/előfizetésben megadott időtartamig.

A zárolási időtartamon belül nem rendezett üzeneteket a rendszer annyiszor rendezi újra, mint az üzenetsoron/előfizetésen beállított maximális kézbesítési szám, amely után a rendszer egy külön kézbesítetlen levelek várólistájára küldi őket.

Az üzenet rendezéséhez hívja meg a complete(), a abandon(), a defer() vagy a deadletter() metódust az üzeneten.

A peekLock és az üzenetegyenlítés működéséről itt talál további információt: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

receiveMode?: "peekLock" | "receiveAndDelete"

Tulajdonság értéke

"peekLock" | "receiveAndDelete"

skipConvertingDate

Az üzenet fogadásakor kihagyhatja-e az üzenetjegyzetek vagy alkalmazástulajdonságok dátumtípusának számmá alakítását. Alapértelmezés szerint a Dátum típusú tulajdonságok UNIX-epoch számmá alakulnak a kompatibilitás érdekében.

skipConvertingDate?: boolean

Tulajdonság értéke

boolean

skipParsingBodyAsJson

A JSON.parse() futtatásának letiltása az ügyfél számára az üzenet érkezésekor az üzenet törzsén. Nem alkalmazható, ha az üzenetet AMQP törzstípus-értékkel vagy sorozattal küldték el. Akkor használja ezt a lehetőséget, ha inkább közvetlenül az üzenet törzsében található bájtokkal dolgozik, mint amikor az ügyfél megkísérli elemezni.

skipParsingBodyAsJson?: boolean

Tulajdonság értéke

boolean

subQueueType

Azt az alsort jelöli, amely bármely üzenetsorhoz vagy előfizetéshez alkalmazható. Az érvényes értékek a "deadLetter" és a "transferDeadLetter". A kézbesítetlen levelek üzenetsorairól további információt a következő témakörben talál: https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

subQueueType?: "deadLetter" | "transferDeadLetter"

Tulajdonság értéke

"deadLetter" | "transferDeadLetter"