Guaranteed Messaging Operation

The following figure shows the basic steps of how Guaranteed messages move from a publishing client, through an event broker, to a consuming client.

Diagram showing the concepts described in the surrounding text.

  1. A client application that is connected to a Message VPN publishes a Guaranteed message to a topic or queue destination.

  2. The ingress message received by the event broker is spooled to a queue or topic endpoint.

  3. The event broker sends an acknowledgment that the message has been successfully spooled back to the publishing client.

  4. The event broker delivers the spooled message to a consuming client if that client:

    • has successfully established a connection to the same Message VPN
    • is authorized to receive Guaranteed messages
    • has created a consumer flow in that session to bind to the endpoint
    • has an active flow bound to the endpoint that can deliver messages. For more information about access types refer to Queue Access Types and Topic Endpoints.

  5. When the consuming client receives the message, it sends an acknowledgment that the message has been successfully delivered back to the event broker.

  6. The event broker deletes the message from the message spool.

For more information about the message spooling and acknowledgment mechanism, see Message Spooling.

Sessions and Consumer Flows

When applications use Solace APIs, a session is used to provide a client connection between an application and an event broker. A session uses a single TCP connection to the event broker. A session is required for all client messaging operations: for example, a session is required to publish Guaranteed messages, and a session is required to create a consumer flow through which Guaranteed messages can be received.

A consumer flow can be created in a session to establish a one‑to‑one mapping of a consumer to a queue or topic endpoint. Consumer flows provide a means of transport for Guaranteed messages from the event broker to the consumer. One or more consumer flows can be created in a session.

Diagram showing the concepts described in the surrounding text.

Consumer flows are not used to receive Direct messages. Instead, clients receive Direct messages published to a topic that matches their client subscriptions directly from the event broker’s message bus through sessions.

Publishing Guaranteed Messages

When clients publish Guaranteed messages, they can either:

  • Publish the messages to a topic
    • Used for publish and subscribe models.
    • A Guaranteed message published to a topic is acknowledged by the event broker's message bus to indicate that the system has received the message. A message that is published to a topic can be received by no clients, a single client, or multiple clients. If there is no subscriber for a message, that message is discarded because in this paradigm the producer and subscriber are decoupled.
  • Publish the messages to a queue
    • Used for point-to-point models.
    • The event broker's message bus also acknowledges a Guaranteed message published to a queue to indicate that the system has received the message. However, messages published to a queue are more tightly coupled than those published to a topic. Therefore, if the queue doesn't exist, or is unable to spool the message (for example, if ingress is disabled or it's over quota), then the message bus rejects the message, and the publishing client application has this immediate feedback. A message that is published to a queue can be consumed by a single consumer.

When a client publishes a Guaranteed messages in a session, a publisher flow to the host event broker is automatically established. The published messages have persistence because they are spooled (that is, they are written to persistent storage) to one of the following types of endpoints provisioned on the event broker:

  • A queue that matches the messages’ queue destination.
  • A topic endpoint that is assigned a topic subscription that matches the message’s topic destination.

Messages Published with a Direct Delivery Mode

It's also possible for messages published with a Direct delivery mode to be spooled to an endpoint when there is a match between the message’s topic destination and the topic subscription set for the endpoint. In this case, when the message is spooled to the endpoint, it's given a non-persistent delivery mode so that a client can consume the message over its established Guaranteed message flow. For more information, see Topic Matching and Message Delivery Modes.

Messages Larger Than the Event Broker's Maximum Message Size

All Solace Message Format (SMF) Guaranteed messages larger than the event broker's maximum guaranteed message size—30MB in most cases—are discarded. The publishing client will be disconnected, and CLIENT_CLIENT_MESSAGE_TOO_BIG event is raised.

Receiving Guaranteed Messages

To receive published Guaranteed messages, a client must create a consumer flow to bind to a queue endpoint or a topic endpoint provisioned on the event broker with the spooled published messages. Once the consumer is bound to the endpoint and it has an active consumer flow (that is, a flow through which messages are being delivered), it can consume Guaranteed messages spooled to that endpoint.

  • Client binds to a queue
  • The client can be an exclusive or non-exclusive consumer of messages spooled to that endpoint. For information on exclusive and non-exclusive consumers, refer to Endpoints.

  • Client binds to a topic endpoint
  • The client provides the topic subscription that it wants the endpoint to spool messages for. The topic subscription that a topic endpoint will spool messages for is not specified when a topic endpoint is provisioned.

When a consuming client successfully receives a Guaranteed message, a corresponding application acknowledgment is required to indicate to the event broker that the client application received the message, so then the message can be removed from the endpoint.