IPWorks MQ 2020 Node.js Edition

Questions / Feedback?

ReceiptOut Event

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

Syntax

stomp.on('ReceiptOut', [callback])

Callback

The 'callback' is called when the 'ReceiptOut' event is emited.

function(e){ }

The argument 'e' has the following properties:

e.receiptId

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 ReceiptIn for details). Anytime the server sends back a receipt, the ReceiptIn event will fire.

Refer to RequestReceipts for more information about receipts.

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