An ACK frame is a client frame used to acknowledge consumption of a message from a subscription using client or client-individual acknowledgment. Any messages received from such a subscription will not be considered to have been consumed until the message has been acknowledged via an ACK.

Begin

data class Begin(val headers: StompBeginHeaders) : StompFrame

A BEGIN frame is a client frame used to start a transaction.

Commit

data class Commit(val headers: StompCommitHeaders) : StompFrame

A COMMIT frame is a client frame used to commit a transaction in progress.

Companion

object Companion

Connect

data class Connect(val headers: StompConnectHeaders) : StompFrame

A CONNECT frame is a client frame used to start a STOMP session on a web socket connection.

Connected

data class Connected(val headers: StompConnectedHeaders) : StompFrame

A CONNECTED frame is a server frame received upon successful connection at the STOMP protocol level.

Disconnect

data class Disconnect(val headers: StompDisconnectHeaders) : StompFrame

A DISCONNECT frame is a client frame used to gracefully disconnect from the server. Waiting for a RECEIPT on DISCONNECT ensures that all previously sent messages have been received by the server.

Error

data class Error(val headers: StompErrorHeaders, val body: FrameBody?) : StompFrame

An ERROR frame is a server frame sent in case of error. Receiving an ERROR frame implies that the connection should be closed and no further messages can be sent or received.

Message

data class Message(val headers: StompMessageHeaders, val body: FrameBody?) : StompFrame

A MESSAGE frame is a server frame used to convey a message from a subscription to the client. A MESSAGE frame must be part of a subscription.

Nack

data class Nack(val headers: StompNackHeaders) : StompFrame

A NACK frame is a client frame used to tell the server that the client did not consume the message. The server can then either send the message to a different client, discard it, or put it in a dead letter queue.

Receipt

data class Receipt(val headers: StompReceiptHeaders) : StompFrame

A RECEIPT frame is sent from the server to the client once the server has successfully processed a client frame that requests a receipt. It is expected from the server when the client frame has a receipt header.

Send

data class Send(val headers: StompSendHeaders, val body: FrameBody?) : StompFrame

A SEND frame is a client frame used to send a message to a destination in the messaging system. The optional body of the SEND frame is the message to be sent.

Stomp