vertx / io.vertx.ext.stomp

Package io.vertx.ext.stomp

Types

Acknowledgement

interface Acknowledgement

Structure passed to acknowledgement handler called when a ACK or NACK frame is received. The handler receives an instance of Acknowledgement with the subscription Frame and the impacted messages. The list of messages depends on the type of acknowledgment used by the subscription. Subscriptions using the client mode receives all messages that were waiting for acknowledgment that were sent before the acknowledged messages. The list also contains the acknowledged message. This is a cumulative acknowledgement. Subscriptions using the client-individual mode receives a singleton list containing only the acknowledged message.

DefaultAbortHandler

open class DefaultAbortHandler : Handler<ServerFrame>

STOMP compliant actions executed when receiving a ABORT frame. This handler is thread safe.

DefaultAckHandler

open class DefaultAckHandler : Handler<ServerFrame>

STOMP compliant actions executed when receiving a ACK frame. It removes the acknowledges messages from the list of messages waiting for acknowledgment. If the ACK frame specifies a transaction id, the acknowledgment is delayed until the transaction commit. This handler is thread safe.

DefaultBeginHandler

open class DefaultBeginHandler : Handler<ServerFrame>

STOMP compliant actions executed when receiving a BEGIN frame. This handler is thread safe.

DefaultCommitHandler

open class DefaultCommitHandler : Handler<ServerFrame>

STOMP compliant actions executed when receiving a COMMIT frame. All frames that are part of the transactions are processed (ACK/NACK and SEND frames). If the COMMIT frame defines a receipt, the RECEIPT frame is sent once all frames have been replayed. This handler is thread safe.

DefaultConnectHandler

open class DefaultConnectHandler : Handler<ServerFrame>

STOMP compliant actions executed when receiving a CONNECT frame. It may also be called when receiving a STOMP frame depending on the io.vertx.ext.stomp.StompServerHandler configuration. This handler manages the STOMP version negotiation and authentication (if enabled). Once all the checks have been passed, the CONNECTED frame is sent to the client. This handler is thread safe.

DefaultNackHandler

open class DefaultNackHandler : Handler<ServerFrame>

STOMP compliant actions executed when receiving a NACK sf.frame(). It removes the acknowledges messages from the list of messages waiting for acknowledgment and trigger an StompServerHandler#onNack(Subscription, List) calls. If the NACK frame specifies a transaction id, the acknowledgment is delayed until the transaction commit. This handler is thread safe.

DefaultSendHandler

open class DefaultSendHandler : Handler<ServerFrame>

STOMP compliant actions executed when receiving a SEND sf.frame(). If the SEND frame specifies a transaction, the message delivery is postponed until the transaction commit. The handler computes the MESSAGE frame from the SEND sf.frame(). It computes a message-id and ack id if needed. If requested the RECEIPT frame is sent once the MESSAGE frame has been sent to all matching subscriptions. If the SEND frame requires an acknowledgment, the message-id is added to the list of messages waiting for acknowledgment. This handler is thread safe.

DefaultSubscribeHandler

open class DefaultSubscribeHandler : Handler<ServerFrame>

STOMP compliant actions executed when receiving a SUBSCRIBE frame. This handler is thread safe.

DefaultUnsubscribeHandler

open class DefaultUnsubscribeHandler : Handler<ServerFrame>

STOMP compliant actions executed when receiving a UNSUBSCRIBE frame. This handler is thread safe.

Destination

interface Destination : Shareable

Represents a STOMP destination. Depending on the implementation, the message delivery is different. Queue are sending message to only one subscribers, while topics are broadcasting the message to all subscribers. Implementations must be thread-safe.

DestinationFactory

interface DestinationFactory

Interface implemented to customize the destination creation.

FrameConverter

open class FrameConverter

Converter for io.vertx.ext.stomp.Frame. NOTE: This class has been automatically generated from the io.vertx.ext.stomp.Frame original class using Vert.x codegen.

Frames

interface Frames

Utility methods to build common Frames. It defines a non-STOMP frame (PING) that is used for heartbeats. When such frame is written on the wire it is just the 0 byte. This class is thread-safe.

StompClientConnection

interface StompClientConnection

Once a connection to the STOMP server has been made, client receives a StompClientConnection, that let send and receive STOMP frames.

StompClientOptionsConverter

open class StompClientOptionsConverter

Converter for io.vertx.ext.stomp.StompClientOptions. NOTE: This class has been automatically generated from the io.vertx.ext.stomp.StompClientOptions original class using Vert.x codegen.

StompServer

interface StompServer

Defines a STOMP server. STOMP servers delegates to a StompServerHandler that let customize the behavior of the server. By default, it uses a handler compliant with the STOMP specification, but let you change anything.

StompServerOptionsConverter

open class StompServerOptionsConverter

Converter for io.vertx.ext.stomp.StompServerOptions. NOTE: This class has been automatically generated from the io.vertx.ext.stomp.StompServerOptions original class using Vert.x codegen.