ReceiptIn Event
Fires when the class receives a receipt from the server.
Syntax
stomp.on('ReceiptIn', [callback])
Callback
The 'callback' is called when the 'ReceiptIn' event is emited.
function(e){ }
The argument 'e' has the following properties:
e.receiptId
Remarks
This event fires anytime the class receives a receipt (that is, a confirmation that the server has received one or more frames) from the server. The ReceiptId parameter reflects the value of the receipt-id header in the incoming RECEIPT frame.
Note that receipts are cumulative, and a STOMP server is not required to send back discrete receipts for each frame it receives that has a receipt header. For example, if the class has sent four message frames with the following receipt header values (in chronological order):
- SEND-3
- SEND-4
- SEND-5
- SEND-6
Refer to RequestReceipts for more information about receipts.