PubSub+ Messaging API For C  7.29.0.6
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Session Capabilities

The capabilities of the Session after connecting to a peer. More...

Macros

#define SOLCLIENT_SESSION_CAPABILITY_PUB_GUARANTEED   "SESSION_CAPABILITY_PUB_GUARANTEED"
 Boolean - The Session allows publishing of Guaranteed messages. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_SUB_FLOW_GUARANTEED   "SESSION_CAPABILITY_SUB_FLOW_GUARANTEED"
 Boolean - The Session allows binding a Guaranteed Flow to an endpoint. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_BROWSER   "SESSION_CAPABILITY_BROWSER"
 Boolean - The Session allows binding to a Queue as a Browser. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_TEMP_ENDPOINT   "SESSION_CAPABILITY_TEMP_ENDPOINT"
 Boolean - The Session allows the creation of temporary endpoints (Queues / TopicEndpoints). More...
 
#define SOLCLIENT_SESSION_CAPABILITY_JNDI   "SESSION_CAPABILITY_JNDI"
 Boolean - The Session accepts JNDI queries. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_COMPRESSION   "SESSION_CAPABILITY_COMPRESSION"
 Boolean - The Session accepts compressed (DEFLATE) data. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_SELECTOR   "SESSION_CAPABILITY_SELECTOR"
 Boolean - The Session supports a selector on Flows. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_ENDPOINT_MANAGEMENT   "SESSION_CAPABILITY_ENDPOINT_MANAGEMENT"
 The Session is allowed to create/delete durable endpoints dynamically. More...
 
#define SOLCLIENT_SESSION_PEER_PLATFORM   "SESSION_PEER_PLATFORM"
 String - A broker/peer returned string that describes the hardware platform. More...
 
#define SOLCLIENT_SESSION_PEER_SOFTWARE_DATE   "SESSION_PEER_SOFTWARE_DATE"
 String - A broker/peer returned string that contains the release date for the broker software. More...
 
#define SOLCLIENT_SESSION_PEER_SOFTWARE_VERSION   "SESSION_PEER_SOFTWARE_VERSION"
 String - A broker/peer returned string that contains the version information. More...
 
#define SOLCLIENT_SESSION_PEER_PORT_SPEED   "SESSION_PEER_PORT_SPEED"
 Uint32 - The maximum rate (in Megabits/second) supported by the broker/peer port. More...
 
#define SOLCLIENT_SESSION_PEER_PORT_TYPE   "SESSION_PEER_PORT_TYPE"
 String - The broker/peer port type. More...
 
#define SOLCLIENT_SESSION_PEER_ROUTER_NAME   "SESSION_PEER_ROUTER_NAME"
 String - The broker/peer Appliance Name, typically used to direct management requests. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_MAX_GUARANTEED_MSG_SIZE   "SESSION_CAPABILITY_MAX_GUARANTEED_MSG_SIZE"
 Uint32 - The maximum size (in bytes) of a Guaranteed message, including all optional message headers and data. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_MAX_DIRECT_MSG_SIZE   "SESSION_CAPABILITY_MAX_DIRECT_MSG_SIZE"
 Uint32 - The maximum size (in bytes) of a Direct message, including all optional message headers and data. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_ENDPOINT_MESSAGE_TTL   "SESSION_CAPABILITY_ENDPOINT_MESSAGE_TTL"
 Boolean - The Session supports message Time-to-Live (TTL) (this only applies to messages that are spooled) in published messages. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_QUEUE_SUBSCRIPTIONS   "SESSION_CAPABILITY_QUEUE_SUBSCRIPTIONS"
 Boolean - The Session supports adding subscription to durable and non-durable queues on the peer. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_SUBSCRIPTION_MANAGER   "SESSION_CAPABILITY_SUBSCRIPTION_MANAGER"
 Boolean - The broker supports adding subscriptions on behalf of other client names. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_MESSAGE_ELIDING   "SESSION_CAPABILITY_MESSAGE_ELIDING"
 Boolean - The Session supports message eliding. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_NO_LOCAL   "SESSION_CAPABILITY_NO_LOCAL"
 Boolean - The Session supports No Local. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_PER_TOPIC_SEQUENCE_NUMBERING   "SESSION_CAPABILITY_PER_TOPIC_SEQUENCE_NUMBERING"
 Boolean - The peer can insert per Topic sequence numbers. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_ENDPOINT_DISCARD_BEHAVIOR   "SESSION_CAPABILITY_ENDPOINT_DISCARD_BEHAVIOR"
 Boolean - The peer endpoints can be provisioned with discard behavior. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_ACTIVE_FLOW_INDICATION   "SESSION_CAPABILITY_ACTIVE_FLOW_INDICATION"
 Boolean - TRUE if session supports active flow indication parameter. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_TRANSACTED_SESSION   "SESSION_CAPABILITY_TRANSACTED_SESSION"
 Boolean - The Session allows Guaranteed Data Transacted Sessions. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_OPENMAMA   "SESSION_CAPABILITY_OPENMAMA"
 Boolean - The Session allows the OpenMAMA API to be used. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_MESSAGE_REPLAY   "SESSION_CAPABILITY_MESSAGE_REPLAY"
 Boolean - The Session allow Message Replay on flow create. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_COMPRESSED_SSL   "SESSION_CAPABILITY_COMPRESSED_SSL"
 Boolean - The peer can support ssl downgrade to compression. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_LONG_SELECTORS   "SESSION_CAPABILITY_LONG_SELECTORS"
 Boolean - The peer can support selectors longer than 1023 bytes. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_SHARED_SUBSCRIPTIONS   "SESSION_CAPABILITY_SHARED_SUBSCRIPTIONS"
 Boolean - The peer can support #shared and #noexport subscriptions. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_BR_REPLAY_ERRORID   "SESSION_CAPABILITY_BR_REPLAY_ERRORID"
 Boolean - The peer can support the endpoint error id parameter on the flow bind response during message replay. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_AD_APP_ACK_FAILED   "SESSION_CAPABILITY_AD_APP_ACK_FAILED"
 Boolean - The broker supports FAILED and REJECTED message settlement outcomes. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_AD_APP_ACK_FAILED   "SESSION_CAPABILITY_AD_APP_ACK_FAILED"
 Boolean - The broker supports FAILED and REJECTED message settlement outcomes. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_VAR_LEN_EXT_PARAM   "SESSION_CAPABILITY_VAR_LEN_EXT_PARAM"
 Boolean - The peer can support variable length extended parameters. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_ADCTRL_VERSION_MIN   "SESSION_CAPABILITY_ADCTRL_VERSION_MIN"
 Uint32 - Lowest AdCtrl version supported by the broker. More...
 
#define SOLCLIENT_SESSION_CAPABILITY_ADCTRL_VERSION_MAX   "SESSION_CAPABILITY_ADCTRL_VERSION_MAX"
 Uint32 - Highest AdCtrl version supported by the broker. More...
 

Detailed Description

The capabilities of the Session after connecting to a peer.

Capabilities can vary depending on the broker platform or peer connection. Capabilities can be retrieved with the solClient_session_getCapability function.

Macro Definition Documentation

#define SOLCLIENT_SESSION_CAPABILITY_ACTIVE_FLOW_INDICATION   "SESSION_CAPABILITY_ACTIVE_FLOW_INDICATION"

Boolean - TRUE if session supports active flow indication parameter.

Examples:
ex/activeFlowIndication.c.
#define SOLCLIENT_SESSION_CAPABILITY_AD_APP_ACK_FAILED   "SESSION_CAPABILITY_AD_APP_ACK_FAILED"

Boolean - The broker supports FAILED and REJECTED message settlement outcomes.

Boolean - The broker supports Consumer Redelivery Flows, which support FAIL and REJECT message settlement outcomes.

#define SOLCLIENT_SESSION_CAPABILITY_AD_APP_ACK_FAILED   "SESSION_CAPABILITY_AD_APP_ACK_FAILED"

Boolean - The broker supports FAILED and REJECTED message settlement outcomes.

Boolean - The broker supports Consumer Redelivery Flows, which support FAIL and REJECT message settlement outcomes.

#define SOLCLIENT_SESSION_CAPABILITY_ADCTRL_VERSION_MAX   "SESSION_CAPABILITY_ADCTRL_VERSION_MAX"

Uint32 - Highest AdCtrl version supported by the broker.

#define SOLCLIENT_SESSION_CAPABILITY_ADCTRL_VERSION_MIN   "SESSION_CAPABILITY_ADCTRL_VERSION_MIN"

Uint32 - Lowest AdCtrl version supported by the broker.

#define SOLCLIENT_SESSION_CAPABILITY_BR_REPLAY_ERRORID   "SESSION_CAPABILITY_BR_REPLAY_ERRORID"

Boolean - The peer can support the endpoint error id parameter on the flow bind response during message replay.

#define SOLCLIENT_SESSION_CAPABILITY_BROWSER   "SESSION_CAPABILITY_BROWSER"

Boolean - The Session allows binding to a Queue as a Browser.

Examples:
ex/simpleBrowserFlow.c.
#define SOLCLIENT_SESSION_CAPABILITY_COMPRESSED_SSL   "SESSION_CAPABILITY_COMPRESSED_SSL"

Boolean - The peer can support ssl downgrade to compression.

#define SOLCLIENT_SESSION_CAPABILITY_COMPRESSION   "SESSION_CAPABILITY_COMPRESSION"

Boolean - The Session accepts compressed (DEFLATE) data.

#define SOLCLIENT_SESSION_CAPABILITY_ENDPOINT_DISCARD_BEHAVIOR   "SESSION_CAPABILITY_ENDPOINT_DISCARD_BEHAVIOR"

Boolean - The peer endpoints can be provisioned with discard behavior.

#define SOLCLIENT_SESSION_CAPABILITY_ENDPOINT_MANAGEMENT   "SESSION_CAPABILITY_ENDPOINT_MANAGEMENT"

The Session is allowed to create/delete durable endpoints dynamically.

Examples:
ex/activeFlowIndication.c, ex/queueProvision.c, ex/RRGuaranteedReplier.c, ex/transactions.c, and Intro/HelloWorldQueueSub.c.
#define SOLCLIENT_SESSION_CAPABILITY_ENDPOINT_MESSAGE_TTL   "SESSION_CAPABILITY_ENDPOINT_MESSAGE_TTL"

Boolean - The Session supports message Time-to-Live (TTL) (this only applies to messages that are spooled) in published messages.

Examples:
ex/messageTTLAndDeadMessageQueue.c.
#define SOLCLIENT_SESSION_CAPABILITY_JNDI   "SESSION_CAPABILITY_JNDI"

Boolean - The Session accepts JNDI queries.

#define SOLCLIENT_SESSION_CAPABILITY_LONG_SELECTORS   "SESSION_CAPABILITY_LONG_SELECTORS"

Boolean - The peer can support selectors longer than 1023 bytes.

#define SOLCLIENT_SESSION_CAPABILITY_MAX_DIRECT_MSG_SIZE   "SESSION_CAPABILITY_MAX_DIRECT_MSG_SIZE"

Uint32 - The maximum size (in bytes) of a Direct message, including all optional message headers and data.

#define SOLCLIENT_SESSION_CAPABILITY_MAX_GUARANTEED_MSG_SIZE   "SESSION_CAPABILITY_MAX_GUARANTEED_MSG_SIZE"

Uint32 - The maximum size (in bytes) of a Guaranteed message, including all optional message headers and data.

#define SOLCLIENT_SESSION_CAPABILITY_MESSAGE_ELIDING   "SESSION_CAPABILITY_MESSAGE_ELIDING"

Boolean - The Session supports message eliding.

#define SOLCLIENT_SESSION_CAPABILITY_MESSAGE_REPLAY   "SESSION_CAPABILITY_MESSAGE_REPLAY"

Boolean - The Session allow Message Replay on flow create.

#define SOLCLIENT_SESSION_CAPABILITY_NO_LOCAL   "SESSION_CAPABILITY_NO_LOCAL"

Boolean - The Session supports No Local.

Flows may be created to Queues and Topic Endpoints that will not receive messages published on the same Session.

Examples:
ex/noLocalPubSub.c.
#define SOLCLIENT_SESSION_CAPABILITY_OPENMAMA   "SESSION_CAPABILITY_OPENMAMA"

Boolean - The Session allows the OpenMAMA API to be used.

#define SOLCLIENT_SESSION_CAPABILITY_PER_TOPIC_SEQUENCE_NUMBERING   "SESSION_CAPABILITY_PER_TOPIC_SEQUENCE_NUMBERING"

Boolean - The peer can insert per Topic sequence numbers.

#define SOLCLIENT_SESSION_CAPABILITY_PUB_GUARANTEED   "SESSION_CAPABILITY_PUB_GUARANTEED"

Boolean - The Session allows publishing of Guaranteed messages.

#define SOLCLIENT_SESSION_CAPABILITY_QUEUE_SUBSCRIPTIONS   "SESSION_CAPABILITY_QUEUE_SUBSCRIPTIONS"

Boolean - The Session supports adding subscription to durable and non-durable queues on the peer.

Examples:
ex/topicToQueueMapping.c.
#define SOLCLIENT_SESSION_CAPABILITY_SELECTOR   "SESSION_CAPABILITY_SELECTOR"

Boolean - The Session supports a selector on Flows.

#define SOLCLIENT_SESSION_CAPABILITY_SHARED_SUBSCRIPTIONS   "SESSION_CAPABILITY_SHARED_SUBSCRIPTIONS"

Boolean - The peer can support #shared and #noexport subscriptions.

#define SOLCLIENT_SESSION_CAPABILITY_SUB_FLOW_GUARANTEED   "SESSION_CAPABILITY_SUB_FLOW_GUARANTEED"

Boolean - The Session allows binding a Guaranteed Flow to an endpoint.

#define SOLCLIENT_SESSION_CAPABILITY_SUBSCRIPTION_MANAGER   "SESSION_CAPABILITY_SUBSCRIPTION_MANAGER"

Boolean - The broker supports adding subscriptions on behalf of other client names.

Examples:
ex/ios/examples/SubscribeOnBehalfOfClientExample.m, and ex/subscribeOnBehalfOfClient.c.
#define SOLCLIENT_SESSION_CAPABILITY_TEMP_ENDPOINT   "SESSION_CAPABILITY_TEMP_ENDPOINT"

Boolean - The Session allows the creation of temporary endpoints (Queues / TopicEndpoints).

#define SOLCLIENT_SESSION_CAPABILITY_TRANSACTED_SESSION   "SESSION_CAPABILITY_TRANSACTED_SESSION"

Boolean - The Session allows Guaranteed Data Transacted Sessions.

Examples:
ex/transactions.c.
#define SOLCLIENT_SESSION_CAPABILITY_VAR_LEN_EXT_PARAM   "SESSION_CAPABILITY_VAR_LEN_EXT_PARAM"

Boolean - The peer can support variable length extended parameters.

#define SOLCLIENT_SESSION_PEER_PLATFORM   "SESSION_PEER_PLATFORM"

String - A broker/peer returned string that describes the hardware platform.

#define SOLCLIENT_SESSION_PEER_PORT_SPEED   "SESSION_PEER_PORT_SPEED"

Uint32 - The maximum rate (in Megabits/second) supported by the broker/peer port.

#define SOLCLIENT_SESSION_PEER_PORT_TYPE   "SESSION_PEER_PORT_TYPE"

String - The broker/peer port type.

#define SOLCLIENT_SESSION_PEER_ROUTER_NAME   "SESSION_PEER_ROUTER_NAME"

String - The broker/peer Appliance Name, typically used to direct management requests.

Examples:
ex/eventMonitor.c, ex/ios/examples/EventMonitorExample.m, ex/ios/examples/SempGetOverMbExample.m, and ex/sempGetOverMb.c.
#define SOLCLIENT_SESSION_PEER_SOFTWARE_DATE   "SESSION_PEER_SOFTWARE_DATE"

String - A broker/peer returned string that contains the release date for the broker software.

#define SOLCLIENT_SESSION_PEER_SOFTWARE_VERSION   "SESSION_PEER_SOFTWARE_VERSION"

String - A broker/peer returned string that contains the version information.