Detecting Event Broker Capabilities

Configuration changes that affect event broker capabilities made after a client has successfully connected to the event broker are not communicated to the client asynchronously. A client will only learn of the changed capabilities if it disconnects and reconnects to the event broker.

To Get a Specific Event Broker Capability and Value
PubSub+ Messaging API Use

Java RTO

  • SessionHandle.getCapability(...)

  • SessionHandle.isCapable(...)

C

  • solClient_session_getCapability(...)

  • solClient_session_isCapable(...)

.NET

  • ISession.GetCapability(...)

  • ISession.IsCapable(...)

JavaScript and Node.js

  • solace.Session.getCapability(capability)

    Returns the value for the given capability type.

  • solace.Session.isCapable(capability)

    Checks if a capability is set on the connected session.

Related Samples

For an example of how to get specific event broker capabilities and values, see the eventMonitor sample for the appropriate messaging API.

The table below lists some of the event broker features that may be available to PubSub+ Messaging APIs for handling messages. It also indicates how to enable these features on the event broker so that the capability is available to the APIs. For a complete list of event broker features, see PubSub+ Messaging APIs.

Possible Event Broker Capabilities for PubSub+ Messaging APIs
Capability Available to clients if...

JNDI—The event broker allows clients to perform Java naming and directory interface (JNDI) queries.

JNDI is enabled on the Solace event broker for the Message VPN that the clients connect to.

Compression—The event broker allows clients to send and receive compressed data. See Enabling Channel Compression for a Session for the API details.

The event broker is running software version 4.4 or higher.

Guaranteed subscription flow—The event broker allows clients to bind flows to endpoints for receiving Guaranteed messages. See Creating Flows for details.
  • Guaranteed messaging and message spooling are enabled on the event broker.
  • The client profile assigned to clients allows Guaranteed messages to be received through the enabled message spool.

Temporary endpoints—The event broker allows clients to create temporary endpoints. See Creating Temporary Endpoints for the API details.
  • Guaranteed messaging and message spooling are enabled on the event broker.
  • The client profile assigned to clients allows them to create Guaranteed topic endpoints or queues.

Guaranteed publishing flow—The event broker allows clients to publish Guaranteed messages.

See Publishing Guaranteed Messages for the API details.
  • Guaranteed messaging and message spooling are enabled on the event broker.
  • The client profile assigned to clients allows them to publish Guaranteed messages.

Queue browser—The event broker allows clients to use queue browsers. See Browsing Guaranteed Messages for the API details.
  • The event broker is running software version 4.6 or higher.
  • Guaranteed messaging and message spooling are enabled on the event broker.

Endpoint management—The event broker allows clients to dynamically create and delete durable endpoints. See Defining Endpoint Properties for the API details.
  • The event broker is running software version 4.6 or higher.
  • Guaranteed messaging and message spooling are enabled on the event broker.
  • The client profile assigned to clients allows them to create queues or topic endpoints.

Selectors—The event broker allows clients to use message selectors on flows. See Using Selectors for the API details.
  • The event broker is running software version 4.6 or higher.
  • Guaranteed messaging and message spooling are enabled on the event broker.

Endpoint message TTL—The event broker allows clients to use Guaranteed message time‑to-live (TTL) values and dead message queues (DMQs). See Setting Message Properties and Defining Endpoint Properties for the API details.
  • The event broker is running software version 4.6.1 or higher.
  • Guaranteed messaging, message spooling, message expiry and DMQs are all enabled on the event broker.

Topic subscriptions for queues—The event broker allows clients to add topic subscriptions to queue endpoints. See Adding Subscriptions to Endpoints for the API details.
  • The event broker is running software version 4.6 or higher.
  • Guaranteed messaging and message spooling are enabled on the event broker.

Subscription manager—The event broker allows clients to add or remove topic subscriptions on behalf of other clients. See Managing Topic Subscriptions on Behalf of Other Clients for the API details.
  • The event broker is running software version 5.0 or higher.
  • The client username allow the client to act as subscription manager.

Eliding—The event broker allows clients to use message eliding. See Message Eliding Eligibility for the API details.
  • The appliance used is a 3560.

    Message eliding is not supported on appliances with Network Acceleration Blade-0401EM, as NAB-0401EM does not support eliding.

  • The Solace PubSub+ software event broker used is version 7.2.2 or higher.
  • The client profile assigned to clients allows message eliding.

Transacted sessions—The event broker allows clients to use local transacted sessions and XA transactions (JMS only).

For the Java RTO, C, and .NET APIs, seeUsing Local Transactions for the API details.

For the JMS API, see Using Transacted Sessions and Using XA Transactions.
  • The event broker is running software version 5.1 or higher.
  • Guaranteed messaging and message spooling are enabled on the event broker.
  • The client profile assigned to clients allows them to use transacted sessions with the C, .NET, or JMS messaging APIs.

No local—The event broker allows the no local API property for both Direct and Guaranteed messages.

For Direct messaging, see Enabling No Local Delivery for a Session for the API details.

For Guaranteed messaging, see No Local Delivery for the API details.

The event broker is running software version 5.1 or higher.

Sequenced topics—The event broker allows per topic sequence numbering for Guaranteed messages. Clients can obtain topic sequence numbers through get calls. See Getting Message Properties for the API details.
  • The event broker is running software version 5.2 or higher.
  • Guaranteed messaging and message spooling are enabled on the event broker.
  • One or more sequenced topics are created.

Discard behavior—The event broker allows clients to configure the message discard behavior when provisioning endpoints. See Defining Endpoint Properties for the API details.
  • The event broker is running software version 5.3 or higher.
  • Guaranteed messaging and message spooling are enabled on the event broker.

System information capabilities—Some event broker capabilities provide system information, such as the maximum Guaranteed and Direct message sizes, the software version used, the software release date, and the type and speed of the port on the event broker that the client connects to.

For a complete list of event broker capabilities that provide system information, see PubSub+ Messaging APIs.

Always provided.