= STOMP
:idprefix:
:idseparator: -
:docinfo: shared

https://stomp.github.io/[STOMP] is a text-orientated wire protocol that allows STOMP clients to communicate with STOMP Brokers.
{project-name-full} supports STOMP 1.0, 1.1 and 1.2.

STOMP clients are available for several languages and platforms, making it a good choice for interoperability.

By default, there are `acceptor` elements configured to accept STOMP connections on ports `61616` and `61613`.

See the general xref:protocols-interoperability.adoc#protocols-and-interoperability[Protocols and Interoperability] chapter for details on configuring an `acceptor` for STOMP.

Refer to the STOMP xref:examples.adoc[examples] for a look at some of this functionality in action.

== Limitations

=== Transactional Acknowledgements

The STOMP specification identifies *transactional acknowledgements* as an optional feature.
Support for transactional acknowledgements is not implemented.
The `ACK` frame cannot be part of a transaction.
It will be ignored if its `transaction` header is set.

=== Virtual Hosting

Virtual hosting isn't supported which means the `host` header in `CONNECT` frame will be ignored.

== Mapping STOMP destinations to addresses and queues

STOMP clients deal with _destinations_ when sending messages and subscribing.
Destination names are simply strings that are mapped to some form of destination on the server - how the server translates this is left to the implementation.

These destinations are mapped to _addresses_ and _queues_ depending on the operation being done and the desired semantics (e.g. anycast or multicast).

== Logging

Incoming and outgoing STOMP frames can be logged by enabling `DEBUG` for `org.apache.activemq.artemis.core.protocol.stomp.StompConnection`.
This can be extremely useful for debugging or simply monitoring client activity.
Along with the STOMP frame itself, the remote IP address of the client is logged as well as the internal connection ID so that frames from the same client can be correlated.

Follow xref:logging.adoc#configuring-a-specific-level-for-a-logger[these steps] to configure logging appropriately.

== Routing Semantics

The STOMP specification is intentionally ambiguous about message routing semantics.
When providing an overview of the protocol the STOMP 1.2 specification https://stomp.github.io/stomp-specification-1.2.html#Protocol_Overview[says]:

____
A STOMP server is modelled as a set of destinations to which messages can be sent.
The STOMP protocol treats destinations as opaque string and their syntax is server implementation specific.
Additionally STOMP does not define what the delivery semantics of destinations should be.
The delivery, or "message exchange", semantics of destinations can vary from server to server and even from destination to destination.
This allows servers to be creative with the semantics that they can support with STOMP.
____

Therefore, there are a handful of different ways to specify which semantics are desired both on the client-side and broker-side.

=== Configuring Routing Semantics from the Client Side

==== Sending

When a STOMP client sends a message (using a `SEND` frame), the protocol manager looks at the `destination-type` header to determine where to route it and potentially how to create the address and/or queue to which it is being sent.
Valid values are `ANYCAST` and `MULTICAST` (case sensitive).
If no indication of routing type is supplied (either by the client or the broker) then the default defined in the corresponding `default-address-routing-type` & `default-queue-routing-type` address-settings will be used as necessary.

The `destination` header maps to an address of the same name if `MULTICAST` is used and additionally to a queue of the same name if `ANYCAST` is used.

==== Subscribing

When a STOMP client subscribes to a destination (using a `SUBSCRIBE` frame), the protocol manager looks at the `subscription-type` header frame to determine what subscription semantics to use and potentially how to create the address and/or queue for the subscription.
If no indication of routing type is supplied (either by the client or the broker) then the default defined in the corresponding `default-address-routing-type` & `default-queue-routing-type` address-settings will be used as necessary.

The `destination` header maps to an address of the same name if `MULTICAST` is used and additionally to a queue of the same name if `ANYCAST` is used.

=== Configuring Routing Semantics from the Broker side

On the broker-side there are two main options for specifying routing semantics - prefixes and address settings

==== Prefixes

Using prefixes involves specifying the `anycastPrefix` and/or the `multicastPrefix` on the acceptor which the STOMP client is using.
For the STOMP use-case these prefixes tell the broker that destinations using them should be treated as anycast or multicast.
For example, if the acceptor has `anycastPrefix=queue/` then when a STOMP client sends a message to `destination:queue/foo` the broker will auto-create the address `foo` and queue `foo` appropriately as anycast and the message will be placed in that queue.
Additionally, if the acceptor has `multicastPrefix=topic/` then when a STOMP client sends a message to `destination:topic/bar` the broker will auto-create the address bar as multicast, but it won't create a queue since multicast (i.e. pub/sub) semantics require a client to explicitly create a subscription to receive those messages.

NOTE: The `anycastPrefix` and/or `multicastPrefix` on the acceptor will be stripped from the `destination` value.

==== Address Settings

Using address settings involves defining address-setting elements whose `match` corresponds with the destination names the clients will use along with the proper `delimiter` to enabled matching.
For example, broker.xml could use the following:

[,xml]
----
<address-settings>
   <address-setting match="queue/#">
      <default-address-routing-type>ANYCAST</default-address-routing-type>
      <default-queue-routing-type>ANYCAST</default-queue-routing-type>
   </address-setting>
   <address-setting match="topic/#">
      <default-address-routing-type>MULTICAST</default-address-routing-type>
      <default-queue-routing-type>MULTICAST</default-queue-routing-type>
   </address-setting>
</address-settings>
<wildcard-addresses>
   <delimiter>/</delimiter>
</wildcard-addresses>
----

Then if a STOMP client sends a message to `destination:queue/foo` the broker will auto-create the address `queue/foo` and queue `queue/foo` appropriately as anycast and the message will be placed in that queue.
Additionally, if a STOMP client sends a message to `destination:topic/bar` the broker will auto-create the address `topic/bar` as multicast, but it won't create a queue as previously explained.

== STOMP heart-beating and connection-ttl

Well behaved STOMP clients will always send a `DISCONNECT` frame before closing their connections.
In this case the server will clear up any server side resources such as sessions and consumers synchronously.
However if STOMP clients exit without sending a `DISCONNECT` frame or if they crash the server will have no way of knowing immediately whether the client is still alive or not.
STOMP connections therefore default to a `connection-ttl` value of 1 minute (see chapter on xref:connection-ttl.adoc#detecting-dead-connections[connection-ttl] for more information.
This value can be overridden using the `connection-ttl-override` property or if you need a specific connectionTtl for your stomp connections without affecting the broker-wide `connection-ttl-override` setting, you can configure your stomp acceptor with the `connectionTtl` property, which is used to set the ttl for connections that are created from that acceptor.
For example:

[,xml]
----
<acceptor name="stomp-acceptor">tcp://localhost:61613?protocols=STOMP;connectionTtl=20000</acceptor>
----

The above configuration will make sure that any STOMP connection that is created from that acceptor and does not include a `heart-beat` header or disables client-to-server heart-beats by specifying a `0` value will have its `connection-ttl` set to 20 seconds.
The `connectionTtl` set on an acceptor will take precedence over `connection-ttl-override`.
The default `connectionTtl` is 60,000 milliseconds.

Since STOMP 1.0 does not support heart-beating then all connections from STOMP 1.0 clients will have a connection TTL imposed upon them by the broker based on the aforementioned configuration options.
Likewise, any STOMP 1.1 or 1.2 clients that don't specify a `heart-beat` header or disable client-to-server heart-beating (e.g. by sending `0,X` in the `heart-beat` header) will have a connection TTL imposed upon them by the broker.

For STOMP 1.1 and 1.2 clients which send a non-zero client-to-server `heart-beat` header value then their connection TTL will be set accordingly.
However, the broker will not strictly set the connection TTL to the same value as the specified in the `heart-beat` since even small network delays could then cause spurious disconnects.
Instead, the client-to-server value in the `heart-beat` will be multiplied by the `heartBeatToConnectionTtlModifier` specified on the acceptor.
The `heartBeatToConnectionTtlModifier` is a decimal value that defaults to `2.0` so for example, if a client sends a `heart-beat` header of `1000,0` the connection TTL will be set to `2000` so that the data or ping frames sent every 1000 milliseconds will have a sufficient cushion so as not to be considered late and trigger a disconnect.
This is also in accordance with the STOMP 1.1 and 1.2 specifications which both state, "because of timing inaccuracies, the receiver SHOULD be tolerant and take into account an error margin."

The minimum and maximum connection TTL allowed can also be specified on the acceptor via the `connectionTtlMin` and `connectionTtlMax` properties respectively.
The default `connectionTtlMin` is 1000 and the default `connectionTtlMax` is Java's `Long.MAX_VALUE` meaning there essentially is no max connection TTL by default.
Keep in mind that the `heartBeatToConnectionTtlModifier` is relevant here.
For example, if a client sends a `heart-beat` header of `20000,0` and the acceptor is using a `connectionTtlMax` of `30000` and a default `heartBeatToConnectionTtlModifier` of `2.0` then the connection TTL would be `40000` (i.e. `20000` * `2.0`) which would exceed the `connectionTtlMax`.
In this case the server would respond to the client with a `heart-beat` header of `0,15000` (i.e. `30000` / `2.0`).
As described previously, this is to make sure there is a sufficient cushion for the client heart-beats in accordance with the STOMP 1.1 and 1.2 specifications.
The same kind of calculation is done for `connectionTtlMin`.

The minimum server-to-client heart-beat value is 500ms.

[NOTE]
====


Please note that the STOMP protocol version 1.0 does not contain any heart-beat frame.
It is therefore the user's responsibility to make sure data is sent within connection-ttl or the server will assume the client is dead and clean up server side resources.
With STOMP 1.1 users can use heart-beats to maintain the life cycle of stomp connections.
====

== Selector/Filter expressions

STOMP subscribers can specify an expression used to select or filter what the subscriber receives using the `selector` header.
The filter expression syntax follows the _core filter syntax_ described in the xref:filter-expressions.adoc#filter-expressions[Filter Expressions] documentation.

== STOMP and JMS interoperability

=== Sending and consuming STOMP message from JMS or Core API

STOMP is mainly a text-orientated protocol.
To make it simpler to interoperate with JMS and Core API, our STOMP implementation checks for presence of the `content-length` header to decide how to map a STOMP 1.0 message to a JMS Message or a Core message.

If the STOMP 1.0 message does _not_ have a `content-length` header, it will be mapped to a JMS _TextMessage_ or a Core message with a _single nullable SimpleString in the body buffer_.

Alternatively, if the STOMP 1.0 message _has_ a `content-length` header, it will be mapped to a JMS _BytesMessage_ or a Core message with a _byte[] in the body buffer_.

The same logic applies when mapping a JMS message or a Core message to STOMP.
A STOMP 1.0 client can check the presence of the `content-length` header to determine the type of the message body (String or bytes).

=== Message IDs for STOMP messages

When receiving STOMP messages via a JMS consumer or a QueueBrowser, the messages have no properties like JMSMessageID by default.
However this may bring some inconvenience to clients who wants an ID for their purpose.
The broker STOMP provides a parameter to enable message ID on each incoming STOMP message.
If you want each STOMP message to have a unique ID, just set the `stompEnableMessageId` to true.
For example:

[,xml]
----
<acceptor name="stomp-acceptor">tcp://localhost:61613?protocols=STOMP;stompEnableMessageId=true</acceptor>
----

When the server starts with the above setting, each stomp message sent through this acceptor will have an extra property added.
The property key is `amqMessageId` and the value is a String representation of a long type internal message id prefixed with `STOMP`, like:

----
amqMessageId : STOMP12345
----

The default `stompEnableMessageId` value is `false`.

== Durable Subscriptions

The `SUBSCRIBE` and `UNSUBSCRIBE` frames can be augmented with special headers to create and destroy durable subscriptions respectively.

To create a durable subscription the `client-id` header must be set on the `CONNECT` frame and the `durable-subscription-name` must be set on the `SUBSCRIBE` frame.
The combination of these two headers will form the identity of the durable subscription.

To delete a durable subscription the `client-id` header must be set on the `CONNECT` frame and the `durable-subscription-name` must be set on the `UNSUBSCRIBE` frame.
The values for these headers should match what was set on the `SUBSCRIBE` frame to delete the corresponding durable subscription.

Aside from `durable-subscription-name`, the broker also supports `durable-subscriber-name` (a deprecated property used before `durable-subscription-name`) as well as `activemq.subscriptionName` from ActiveMQ Classic.
This is the order of precedence if the frame contains more than one of these:

. `durable-subscription-name`
. `durable-subscriber-name`
. `activemq.subscriptionName`

It is possible to pre-configure durable subscriptions since the STOMP implementation creates the queue used for the durable subscription in a deterministic way (i.e. using the format of `client-id`.`subscription-name`).
For example, if you wanted to configure a durable subscription on the address `myAddress` with a client-id of `myclientid` and a subscription name of `mysubscription` then configure the durable subscription:

[,xml]
----
<addresses>
   <address name="myAddress">
      <multicast>
         <queue name="myclientid.mysubscription"/>
      </multicast>
   </address>
</addresses>
----

== Handling of Large Messages with STOMP

STOMP clients may send very large frame bodies which can exceed the size of the broker's internal buffer, causing unexpected errors.
To prevent this situation from happening, the broker provides a STOMP configuration attribute `stompMinLargeMessageSize`.
This attribute can be configured inside a stomp acceptor, as a parameter.
For example:

[,xml]
----
<acceptor name="stomp-acceptor">tcp://localhost:61613?protocols=STOMP;stompMinLargeMessageSize=10240</acceptor>
----

The type of this attribute is integer.
When this attributed is configured, the broker will check the size of the body of each STOMP frame arrived from connections established with this acceptor.
If the size of the body is equal or greater than the value of `stompMinLargeMessageSize`, the message will be persisted as a large message.
When a large message is delivered to a STOMP consumer, the broker will automatically handle the conversion from a large message to a normal message, before sending it to the client.

If a large message is compressed, the server will uncompressed it before sending it to stomp clients.
The default value of `stompMinLargeMessageSize` is the same as the default value of xref:large-messages.adoc#configuring-the-core-client[minLargeMessageSize].

== WebSockets

STOMP over https://html.spec.whatwg.org/multipage/web-sockets.html[WebSockets] is also supported.
Modern web browsers which support WebSockets can send and receive STOMP messages.

STOMP over WebSockets is supported via the normal STOMP acceptor:

[,xml]
----
<acceptor name="stomp-ws-acceptor">tcp://localhost:61614?protocols=STOMP</acceptor>
----

With this configuration, the broker will accept STOMP connections over WebSockets on the port `61614`.
Web browsers can then connect to `ws://<server>:61614` using a Web Socket to send and receive STOMP messages.
WebSockets per-message deflate is supported but not enabled by default, to enable it add the `webSocketCompressionSupported=true` option to the acceptor URI.
The client must also support per-message deflate and request it via the standard WebSockets extension.

A companion JavaScript library to ease client-side development is available from https://github.com/jmesnil/stomp-websocket[GitHub] (please see its http://jmesnil.net/stomp-websocket/doc/[documentation] for a complete description).

The payload length of Web Socket frames can vary between client implementations.
By default the broker will accept frames with a payload length of 65,536.
If the client needs to send payloads longer than this in a single frame this length can be adjusted by using the `webSocketMaxFramePayloadLength` URL parameter on the acceptor.
In previous version this was configured via the similarly named `stompMaxFramePayloadLength` acceptor URL parameter.

Web Socket frames can be encoded as either https://datatracker.ietf.org/doc/html/rfc6455#section-11.8[binary or text].
By default the broker encodes them as binary.
However, this can be changed by using the `webSocketEncoderType` acceptor URL parameter.
Valid values are `binary` and `text`.

The `stomp-websockets` xref:examples.adoc[example] shows how to configure a broker to have web browsers and Java applications exchanges messages.

== Flow Control

STOMP clients can use the `consumer-window-size` header on the `SUBSCRIBE` frame to control the flow of messages to clients.
This is broadly discussed in the xref:flow-control.adoc#flow-control[Flow Control] chapter.

This ability is similar to the `activemq.prefetchSize` header supported by ActiveMQ Classic.
However, that header specifies the size in terms of _messages_ whereas `consumer-window-size` specifies the size in terms of _bytes_.
The `activemq.prefetchSize` header is supported for backwards compatibility, but the value will be interpreted as _bytes_ just like `consumer-window-size` would be.
If both `activemq.prefetchSize` and `consumer-window-size` are set then the value for `consumer-window-size` will be used.

Setting `consumer-window-size` to `0` will ensure that once a STOMP client receives a message that it will _not_ receive another one until it sends the appropriate `ACK` or `NACK` frame for the message it already has.

Setting `consumer-window-size` to a value _greater than_ `0` will allow it to receive messages until the cumulative bytes of those messages reaches the configured size.
Once that happens the client will not receive any more messages until it sends the appropriate `ACK` or `NACK` frame for the messages it already has.

Setting `consumer-window-size` to `-1` means there is no flow control and the broker will dispatch messages to clients as fast as it can.

Flow control can be configured at the `acceptor` as well using the `stompConsumerWindowSize` URL parameter.
This value is `10240` (i.e. 10K) by default for clients using `client` and `client-individual` acknowledgement modes.
It is `-1` for clients using the `auto` acknowledgement mode.
Even if `stompConsumerWindowSize` is set on the STOMP `acceptor` it will be overriden by the value provided by individual clients using the `consumer-window-size` header on their `SUBSCRIBE` frame.

[NOTE]
====


The `stompConsumerWindowSize` URL parameter used to be called `stompConsumerCredits` but was changed to be more consistent with the new header name (i.e. `consumer-window-size`).
The `stompConsumerCredits` parameter is deprecated but it will still work for the time being.
====

Using the <<logging,DEBUG logging>> mentioned earlier it is possible to see the size of the `MESSAGE` frames dispatched to clients.
This can help when trying to determine the best `consumer-window-size` setting.
