ReceiptIn Event

Fires when the component receives a receipt from the server.

Syntax

• C#
• VB.NET

public event OnReceiptInHandler OnReceiptIn;

public delegate void OnReceiptInHandler(object sender, StompReceiptInEventArgs e);

public class StompReceiptInEventArgs : EventArgs {
  public string ReceiptId { get; }
}

Public Event OnReceiptIn As OnReceiptInHandler

Public Delegate Sub OnReceiptInHandler(sender As Object, e As StompReceiptInEventArgs)

Public Class StompReceiptInEventArgs Inherits EventArgs
  Public ReadOnly Property ReceiptId As String
End Class

Remarks

This event fires anytime the component 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 component has sent four message frames with the following receipt header values (in chronological order):

1. SEND-3
2. SEND-4
3. SEND-5
4. SEND-6

Refer to RequestReceipts for more information about receipts.