TsgcWSPClient_STOMP_ActiveMQ › Events › OnActiveMQReceipt

OnActiveMQReceipt Event

Fires when a RECEIPT frame is received, confirming that a prior client frame requesting a receipt has been processed by ActiveMQ.

Syntax

property OnActiveMQReceipt: TsgcWSActiveMQSTOMPReceiptEvent;
// TsgcWSActiveMQSTOMPReceiptEvent = procedure(Connection: TsgcWSConnection; Headers: TsgcWSActiveMQSTOMPHeadersReceipt) of object

Default Value

—

Remarks

Raised when the ActiveMQ broker acknowledges a client frame (SEND, SUBSCRIBE, UNSUBSCRIBE, ACK, NACK, BEGIN, COMMIT, ABORT, DISCONNECT) that included a "receipt" header. Because STOMP is stream-based, a RECEIPT is a cumulative acknowledgment — all previous frames have also been received by the broker. Parameters:

• Headers — a TsgcWSActiveMQSTOMPHeadersReceipt object exposing the ReceiptId (value of the "receipt-id" header, matching the "receipt" header sent with the originating client frame; use it to correlate the acknowledgment with the request) plus the complete RawHeaders string with any ActiveMQ-specific fields.

Example

procedure TForm1.ActiveMQReceipt(Connection: TsgcWSConnection;
  Headers: TsgcWSActiveMQSTOMPHeadersReceipt);
begin
  Memo1.Lines.Add('Receipt confirmed: ' + Headers.ReceiptId);
end;

Back to Events