Classes, interfaces and traits

Acknowledgement

Structure passed to acknowledgement handler called when a <code>ACK</code> or <code>NACK</code> frame is received. The handler receives an instance of @see \io\vertx\jphp\ext\stomp\Acknowledgement with the subscription @see \io\vertx\jphp\ext\stomp\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.

« More »

BridgeOptions

Specify the event bus bridge options.

« More »

Destination

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.

« More »

DestinationFactory

Interface implemented to customize the destination creation.

« More »

Frame

Represents a STOMP frame. STOMP frames are structured as follows. It starts by a <code>command</code>, followed by a set of headers. Then the frame may have a body and is finished by a <code>0</code> byte. This class represents this structure and provide access to the different parts.

This class is NOT thread-safe.

« More »

Frames

Utility methods to build common @see \io\vertx\jphp\ext\stomp\Frames. It defines a non-STOMP frame (<code>PING</code>) that is used for heartbeats. When such frame is written on the wire it is just the <code>0</code> byte.

This class is thread-safe.

« More »

ServerFrame

Structure passed to server handler when receiving a frame. It provides a reference on the received @see \io\vertx\jphp\ext\stomp\Frame but also on the @see \io\vertx\jphp\ext\stomp\StompServerConnection.

« More »

StompClient

Defines a STOMP client.

« More »

StompClientConnection

Once a connection to the STOMP server has been made, client receives a @see \io\vertx\jphp\ext\stomp\StompClientConnection, that let send and receive STOMP frames.

« More »

StompClientOptions

Options used to configure a STOMP client. As a STOMP client wraps a Net client, you can also configure the underlying NET client.

« More »

StompServer

Defines a STOMP server. STOMP servers delegates to a @see \io\vertx\jphp\ext\stomp\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.

« More »

StompServerConnection

Class representing a connection between a STOMP client a the server. It keeps a references on the client socket, so let write to this socket.

« More »

StompServerHandler

STOMP server handler implements the behavior of the STOMP server when a specific event occurs. For instance, if let customize the behavior when specific STOMP frames arrives or when a connection is closed. This class has been designed to let you customize the server behavior. The default implementation is compliant with the STOMP specification. In this default implementation, not acknowledge frames are dropped.

« More »

StompServerOptions

STOMP Server options. You can also configure the Net Server used by the STOMP server from these options.

« More »