ReceiptOut Event

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

Syntax

ANSI (Cross Platform)
virtual int FireReceiptOut(STOMPReceiptOutEventParams *e);

typedef struct {
  const char *ReceiptId;
  int reserved;
} STOMPReceiptOutEventParams;

Unicode (Windows)
virtual INT FireReceiptOut(STOMPReceiptOutEventParams *e);

typedef struct {
  LPCWSTR ReceiptId;
  INT reserved;
} STOMPReceiptOutEventParams;
- (void)onReceiptOut:(NSString*)receiptId;
#define EID_STOMP_RECEIPTOUT 10

virtual INT IPWORKSMQ_CALL FireReceiptOut(LPSTR &lpszReceiptId);

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 C++ Edition - Version 20.0 [Build 8155]