IPWorks IoT 2020 Kotlin Edition

Questions / Feedback?

ReceiptOut Event

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

Syntax

public open class DefaultStompEventListener : StompEventListener {
  ...
  public override fun receiptOut(e: StompReceiptOutEvent) {}
  ...
}

public class StompReceiptOutEvent {
  val receiptId: String?
}

Remarks

This event fires anytime the component 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) 2021 /n software inc. - All rights reserved.
IPWorks IoT 2020 Kotlin Edition - Version 20.0 [Build 7941]