ReceiptIn Event
Fires when the class receives a receipt from the server.
Syntax
ANSI (Cross Platform) virtual int FireReceiptIn(STOMPReceiptInEventParams *e);
typedef struct {
const char *ReceiptId; int reserved; } STOMPReceiptInEventParams; Unicode (Windows) virtual INT FireReceiptIn(STOMPReceiptInEventParams *e);
typedef struct {
LPCWSTR ReceiptId; INT reserved; } STOMPReceiptInEventParams;
- (void)onReceiptIn:(NSString*)receiptId;
#define EID_STOMP_RECEIPTIN 9 virtual INT IPWORKSMQ_CALL FireReceiptIn(LPSTR &lpszReceiptId);
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.