ServiceBusReceiver Třída

Opusťte zprávu.

Tato zpráva se vrátí do fronty a zpřístupní se k opětovnému přijetí.

abandon_message(message: ServiceBusReceivedMessage) -> None

Parametry

Návratový typ

Výjimky

Příklady

Opuštění přijaté zprávy

       messages = servicebus_receiver.receive_messages(max_wait_time=5)
       for message in messages:
           servicebus_receiver.abandon_message(message)

close() -> None

Výjimky

Dokončete zprávu.

Tím se zpráva odebere z fronty.

complete_message(message: ServiceBusReceivedMessage) -> None

Parametry

Návratový typ

Výjimky

Příklady

Dokončete přijatou zprávu.

       messages = servicebus_receiver.receive_messages(max_wait_time=5)
       for message in messages:
           servicebus_receiver.complete_message(message)

Přesuňte zprávu do fronty Nedoručených zpráv.

Fronta nedoručených zpráv je podsepis, kterou lze použít k ukládání zpráv, které se nepodařilo správně zpracovat nebo jinak vyžadují další kontrolu nebo zpracování. Frontu lze také nakonfigurovat tak, aby odesílala zprávy s prošlou platností do fronty nedoručených zpráv.

dead_letter_message(message: ServiceBusReceivedMessage, reason: str | None = None, error_description: str | None = None) -> None

Parametry

Návratový typ

Výjimky

Příklady

Nedoručených zpráv přijaté zprávy.

       messages = servicebus_receiver.receive_messages(max_wait_time=5)
       for message in messages:
           servicebus_receiver.dead_letter_message(message)

Odsudí zprávu.

Tato zpráva zůstane ve frontě, ale aby byla přijata, musí být požadována konkrétně podle jejího pořadového čísla.

defer_message(message: ServiceBusReceivedMessage) -> None

Parametry

Návratový typ

Výjimky

Příklady

Odložení přijaté zprávy

       messages = servicebus_receiver.receive_messages(max_wait_time=5)
       for message in messages:
           servicebus_receiver.defer_message(message)

next()

Výjimky

Umožňuje procházet zprávy, které čekají ve frontě.

Náhledy zpráv se z fronty neodeberou, ani nejsou uzamčené. Nelze je dokončit, odložit ani nedoručovat.

peek_messages(max_message_count: int = 1, *, sequence_number: int = 0, timeout: float | None = None, **kwargs: Any) -> List[ServiceBusReceivedMessage]

Parametry

Návraty

Seznam ~azure.servicebus.ServiceBusReceivedMessage.

Návratový typ

Výjimky

Příklady

Podívejte se na čekající zprávy ve frontě.

   with servicebus_receiver:
       messages = servicebus_receiver.peek_messages()
       for message in messages:
           print(str(message))

Příjem zpráv, které byly dříve odloženy.

Při přijímání odložených zpráv z dělené entity musí být všechna zadaná pořadová čísla zprávy ze stejného oddílu.

receive_deferred_messages(sequence_numbers: int | List[int], *, timeout: float | None = None, **kwargs: Any) -> List[ServiceBusReceivedMessage]

Parametry

Návraty

Seznam požadovaných instancí ~azure.servicebus.ServiceBusReceivedMessage

Návratový typ

Výjimky

Příklady

Příjem zpráv s odloženým odkladem ze služby ServiceBus

   with servicebus_receiver:
       deferred_sequenced_numbers = []
       messages = servicebus_receiver.receive_messages(max_wait_time=5)
       for message in messages:
           deferred_sequenced_numbers.append(message.sequence_number)
           print(str(message))
           servicebus_receiver.defer_message(message)

       received_deferred_msg = servicebus_receiver.receive_deferred_messages(
           sequence_numbers=deferred_sequenced_numbers
       )

       for msg in received_deferred_msg:
           servicebus_receiver.complete_message(msg)

Příjem dávky zpráv najednou

Tento přístup je optimální, pokud chcete zpracovat více zpráv současně nebo provést ad hoc příjem jako jedno volání.

Všimněte si, že počet zpráv načtených v jedné dávce bude záviset na tom, jestli byla pro příjemce nastavena prefetch_count. Pokud prefetch_count není nastavena pro příjemce, příjemce se pokusí uložit do mezipaměti max_message_count (pokud jsou k dispozici) zprávy v rámci požadavku na službu.

Toto volání upřednostní rychlé vrácení před schůzkou se zadanou velikostí dávky, a tak se vrátí, jakmile se přijme alespoň jedna zpráva a v příchozích zprávách bude mezera bez ohledu na zadanou velikost dávky.

receive_messages(max_message_count: int | None = 1, max_wait_time: float | None = None) -> List[ServiceBusReceivedMessage]

Parametry

Návraty

Seznam přijatých zpráv. Pokud nejsou k dispozici žádné zprávy, bude to prázdný seznam.

Návratový typ

Výjimky

Příklady

Příjem zpráv ze služby ServiceBus

   with servicebus_receiver:
       messages = servicebus_receiver.receive_messages(max_wait_time=5)
       for message in messages:
           print(str(message))
           servicebus_receiver.complete_message(message)

Obnovte zámek zprávy.

Tím se zachová zámek zprávy, aby se zajistilo, že se nevrátí do fronty, která se má znovu zpracovat.

Chcete-li dokončit (nebo jinak vyrovnat) zprávu, musí být zámek zachován a již nemůže mít platnost; zámek, jehož platnost vypršela, nelze obnovit.

Zprávy přijaté prostřednictvím režimu RECEIVE_AND_DELETE nejsou uzamčeny, a proto je nelze obnovit. Tato operace je dostupná jenom pro zprávy, které nejsou v relaci.

renew_message_lock(message: ServiceBusReceivedMessage, *, timeout: float | None = None, **kwargs: Any) -> datetime

Parametry

Návraty

Datum UTC a čas, na který je zámek nastavený tak, aby vypršel.

Návratový typ

Výjimky

Příklady

Obnovte zámek u přijaté zprávy.

       messages = servicebus_receiver.receive_messages(max_wait_time=5)
       for message in messages:
           servicebus_receiver.renew_message_lock(message)

Získejte client_identifier ServiceBusReceiver přidružené k instanci příjemce.

Návratový typ

Získejte objekt ServiceBusSession propojený s příjemcem. Relace je dostupná pouze pro entity s povolenými relacemi. Pokud by byla volána na přijímači bez relace, vrátila by hodnotu None.

Návratový typ

Příklady

Získání relace od příjemce

       with servicebus_client.get_queue_receiver(queue_name=queue_name, session_id=session_id) as receiver:
           session = receiver.session