IPWorks MQ 2020 Python Edition

Questions / Feedback?

on_receipt_out Event

Fires when the class sends a STOMP frame that includes a 'receipt' header.

Syntax

class STOMPReceiptOutEventParams(object):
  @property
  def receipt_id() -> str: ...

# In class STOMP:
@property
def on_receipt_out() -> Callable[[STOMPReceiptOutEventParams], None]: ...
@on_receipt_out.setter
def on_receipt_out(event_hook: Callable[[STOMPReceiptOutEventParams], None]) -> None: ...

Remarks

This event fires anytime the class sends any STOMP frame that includes a receipt header on it. The ReceiptId parameter reflects the value of the receipt header.

Having a receipt header on an outgoing frame indicates to the server that it should send back a receipt to confirm that it has received the frame (though it is not required to do so immediately; see on_receipt_in for details). Anytime the server sends back a receipt, the on_receipt_in event will fire.

Refer to request_receipts for more information about receipts.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks MQ 2020 Python Edition - Version 20.0 [Build 8155]