## A Top

AbstractQueueDescriptor — class in namespace solace

  This class is not exposed for construction by API users.

  This is a base class for solace.QueueDescriptor. API users should access the methods described here through a solace.QueueDescriptor.

acknowledge — public method in class solace.Message

  Acknowledges this message.

  If the solace.MessageConsumer on which this message was received is configured to use solace.MessageConsumerAckMode.CLIENT, then when a message is received by an application, the application must call this method to explicitly acknowledge reception of the message. This frees local and router resources associated with an unacknowledged message.

  The API does not send acknowledgments immediately. It stores the state for acknowledged messages internally and acknowledges messages, in bulk, when a threshold or timer is reached.

ACKNOWLEDGED_MESSAGE — event triggered in class solace.SessionEventCode

  A message was acknowledged by the router.

ACTIVE — event triggered in class solace.MessageConsumerEventName

  The message consumer has become active.

addField — public method in class solace.SDTMapContainer

  Adds a field to this map. If a key:value mapping already exists for this key, it is replaced.

addField — public method in class solace.SDTStreamContainer

  Appends a field to this stream.

addSubscription — public method in class solace.MessageConsumer

  Subscribe the queue to a topic, always requesting confirmation from the router.

  solace.MessageConsumerEventName.SUBSCRIPTION_OK is generated when subscription is added successfully; otherwise, session event solace.MessageConsumerEventName.SUBSCRIPTION_ERROR is generated.

  When the application receives the event solace.MessageConsumerEventName.SUBSCRIPTION_ERROR, it can obtain the failed topic subscription by calling solace.MessageConsumerEvent#reason. The returned string is in the format of "Topic: <failed topic subscription>".

AuthenticationScheme — namespace

  Represents authentication schemes that can be used. The corresponding session property is solace.SessionProperties#authenticationScheme.

## C Top

CacheCBInfo — class in namespace solace

  Encapsulates a solace.CacheSession's request listener callback function and optional application-specified context object.

  Instances of this class are required as a parameter to solace.CacheSession#sendCacheRequest when creating a CacheSession request.

CacheLiveDataAction — namespace

  solace.CacheLiveDataAction Enumeration of CacheLiveDataAction values, specifying how the CacheSession should handle live data associated with a cache request in progress.

cacheRequestCallback — static public method in class solace.CacheCBInfo

  This callback is called by a cache session when a cache request completes.

CacheRequestResult — class in namespace solace

  This class is not exposed for construction by API users. A CacheRequestResult object is provided on the callback (see solace.CacheCBInfo.cacheRequestCallback when a cache request completes.

  An object that indicates the termination of a cache request, and provides details how it concluded.

CacheReturnCode — namespace

  Enumeration of CacheReturnCode types. The method solace.CacheRequestResult#getReturnCode returns on of these basic results of a cache request. More details are available in the associated solace.CacheReturnSubcode, retrieved by solace.CacheRequestResult#getReturnSubcode.

CacheReturnSubcode — namespace

  Enumeration of CacheReturnSubcode types.

CacheSession — class in namespace solace

  This class is not exposed for construction by API users. Users should obtain an instance from solace.Session#createCacheSession

  A session for performing cache requests.

  Applications must use solace.Session#createCacheSession to construct this class.

  The supplied solace.CacheSessionProperties will be copied. Subsequent modifications to the passed properties will not modify the session. The properties may be reused.

CacheSessionProperties — class in namespace solace

  Encapsulates the properties of a cache session.

CAN_ACCEPT_DATA — event triggered in class solace.SessionEventCode

  The session transport can accept data again. This event will occur after an solace.OperationError is thrown from an API call with a subcode of solace.ErrorSubcode.INSUFFICIENT_SPACE to indicate the operation can be retried. This event is used both after session-level transport buffer exhaustion, and Guaranteed Messaging Window exhaustion.

CapabilityType — namespace

  Represents an enumeration of peer capabilities.

clearStats — inherited public method in class solace.MessageConsumer

  Clears all statistics for this Guaranteed Message Connection. All previous Guaranteed Message Connection statistics are lost when this is called.

ClientCapabilityType — namespace

  Represents an enumeration of client capabilities. These are sent in the ClientCtrl login messages.

compare — public method in class solace.ReplicationGroupMessageId

  Compares with other ReplicationGroupMessageId

connect — public method in class solace.Session

  Connects the session to the Solace Message Router as configured in the solace.SessionProperties#url.

  When the session is successfully connected to the Solace Message Router, the solace.SessionEventCode#UP_NOTICE event is emitted if a listener has been registered.

  If solace.SessionProperties#reapplySubscriptions is set to true, this operation re-registers previously registered subscriptions. The connected session event (solace.SessionEventCode#event:UP_NOTICE) is emitted only when all the subscriptions are successfully added to the router.

  If the API is unable to connect within solace.SessionProperties#connectTimeoutInMsecs or due to login failures, the session's state transitions back to 'disconnected' and an event is generated.

  Note: Before the session's state transitions to 'connected', a client application cannot use the session; any attempt to call functions will throw solace.OperationError.

connect — public method in class solace.QueueBrowser

  Connects the queue browser immediately. The application should add event listeners (see solace.QueueBrowserEventName). If there is no listener added for solace.QueueBrowserEventName#event:MESSAGE then up to a window solace.QueueBrowserProperties.windowSize of messages can be queued internally. before calling this method.

connect — public method in class solace.MessageConsumer

  Connects the consumer immediately. The application should add event listeners (see solace.MessageConsumerEventName). If there is no listener added for solace.MessageConsumerEventName#event:MESSAGE then up to a window solace.MessageConsumerProperties.windowSize of messages can be queued internally. to the solace.MessageConsumer before calling this method.

CONNECT_FAILED_ERROR — event triggered in class solace.MessageConsumerEventName

  The message consumer attempted to connect but was unsuccessful. The message consumer is disabled.

CONNECT_FAILED_ERROR — event triggered in class solace.QueueBrowserEventName

  The queue browser attempted to connect but was unsuccessful. The queue browser is disabled.

CONNECT_FAILED_ERROR — event triggered in class solace.SessionEventCode

  The session attempted to connect but was unsuccessful.

create — static public method in class solace.SDTField

  Create a new SDTField instance representing a Value of a given Type.

createCacheSession — public method in class solace.Session

  Creates a solace.CacheSession object that uses this Session to service its cache requests.

  It should be disposed when the application no longer requires a CacheSession, by calling solace.CacheSession#dispose.

createDurableQueueDestination — static public method in class solace.SolclientFactory

  Creates a durable queue solace.Destination instance. When the returned Destination is set as the destination of a message via solace.Message#setDestination, the message will be delivered to the Guaranteed Message queue on the Solace Message Router of the same name.

createMessage — static public method in class solace.SolclientFactory

  Creates a solace.Message instance.

createMessageConsumer — public method in class solace.Session

  Creates a solace.MessageConsumer to receive Guaranteed Messages in this Session.

  Consumer characteristics and behavior are defined by properties. The consumer properties are supplied as an object; the pertinent fields are exposed in solace.MessageConsumerProperties; other property names are ignored. If the Message Consumer creation specifies a non-durable endpoint, solace.QueueProperties can be used to change the default properties on the non-durable endpoint. Any values not supplied are set to default values.

  When the consumer is created, a consumer object is returned to the caller. This is the object from which events are emitted, and upon which operations (for example, starting and stopping the consumer) are performed.

  If this session does not support Guaranteed Messaging, this method will throw. The following must be true in order to create a MessageConsumer:

  - The transport protocol list does not contain any HTTP transport protocols. See solace.SessionProperties#transportProtocol and solace.FactoryProfile#cometEnabled
  - The Solace Messaging Router must support Guaranteed Messaging
createQueueBrowser — public method in class solace.Session

  Creates a solace.QueueBrowser to browse Guaranteed Messages on a specified queue in this Session.

  Browser characteristics and behavior are defined by properties. The browser properties are supplied as an object; the pertinent fields are exposed in solace.QueueBrowserProperties; other property names are ignored. Any values not supplied are set to default values.

  Delivery restrictions imposed by the queue’s Access type (exclusive or non-exclusive), do not apply when browsing messages with a Browser.

  When the queue browser is created, a queue browser object is returned to the caller. This is the object from which events are emitted, and upon which operations (for example, starting and stopping the browser) are performed.

  If this session does not support Guaranteed Messaging, this method will throw. The following must be true in order to create a QueueBrowser:

  - The transport protocol list does not contain any HTTP transport protocols. See solace.SessionProperties#transportProtocol and solace.FactoryProfile#cometEnabled
  - The Solace Messaging Router must support Guaranteed Messaging
createReplayStartLocationBeginning — static public method in class solace.SolclientFactory

  Creates a ReplayStartLocation solace.ReplayStartLocation instance that when set in MessageConsumerProperties indicates that all messages available in the replay log should be retrieved.

createReplayStartLocationDate — static public method in class solace.SolclientFactory

  Creates a ReplayStartLocation solace.ReplayStartLocation instance that when set in MessageConsumerProperties indicates that only messages spooled in the replay log since the given Date should be retrieved.

createReplicationGroupMessageId — static public method in class solace.SolclientFactory

  Creates a solace.ReplicationGroupMessageId instance from string. A ReplicationGroupMessageId is also a solace.ReplayStartLocation instance that when set in MessageConsumerProperties indicates that only messages spooled in the replay log since the message after the given ReplicationGroupMesageId should be replayed.

createSession — static public method in class solace.SolclientFactory

  Creates a session instance.

createTopicDestination — static public method in class solace.SolclientFactory

  Creates a topic solace.Destination instance. When the returned Destination is set as the destination of a message via solace.Message#setDestination, the message will be delivered to direct subscribers or topic endpoints subscribed to the given topic.

## D Top

DEFAULT_CIPHER_SUITES — constant in solace.SessionProperties

  The default comma separated list of cipher suites in order of preference used for SSL connections.

deleteField — public method in class solace.SDTMapContainer

  Delete an SDTField with the given key.

describe — public method in class solace.Enum

  Create a human-readable string describing the given enumeration value. This result is informational and may vary between SDK versions.

  Currently, it either returns the value provided (if the associated key is the same), or a string of the form `key (value)`.

Destination — class in namespace solace

  This class is not exposed for construction by API users. Users should obtain an instances from one of the following:

  - solace.SolclientFactory.createTopicDestination
  - solace.SolclientFactory.createDurableQueueDestination
  - solace.MessageConsumer#getDestination
  - solace.SDTField#getValue when solace.SDTField#getType returns solace.SDTFieldType.DESTINATION.

  Represents a message destination.

  Publishers can send messages to topics or queues, to which subscribers can subscribe or bind. A Destination specifies the target of such an operation.

DestinationType — namespace

  Enumerates destination types for destination objects.

disconnect — public method in class solace.MessageConsumer

  Initiates an orderly disconnection of the Message Consumer. The API will send any pending client acknowledgements on the Message Consumer, then send an unbind request. Any messages subsequently received are discarded silently. When the unbind message is acknowledged, the application receives a solace.MessageConsumerEventName#event:DOWN event if it has set a listener for that event.

disconnect — public method in class solace.Session

  Disconnects the session. The session attempts to disconnect cleanly, concluding all operations in progress. The disconnected session event solace.SessionEventCode#event:DISCONNECTED is emitted when these operations complete and the session has completely disconnected.

disconnect — public method in class solace.QueueBrowser

  Initiates an orderly disconnection of the queue browser. The API will send an unbind request. Any messages subsequently received are discarded silently. When the unbind message is acknowledged, the application receives a solace.QueueBrowserEventName#event:DOWN event if it has set a listener for that event.

DISCONNECTED — event triggered in class solace.SessionEventCode

  The session connect operation failed, or the session that was once up, is now disconnected.

dispose — inherited public method in class solace.MessageConsumer

  Disposes the Guaranteed Message connection, removing all listeners and releasing references.

dispose — public method in class solace.Session

  Release all resources associated with the session. It is recommended to call disconnect() first for proper handshake with the message-router.

dispose — public method in class solace.CacheSession

  Disposes the session. No cache requests will be sent by this CacheSession after it is _disposed.

  Any subsequent operations on the session will throw {OperationError}.

  Any pending operations will immediately terminate, returning

  - solace.CacheRequestResult
    - #returnCode === solace.CacheReturnCode.INCOMPLETE
    - #subcode === solace.CacheReturnSubcode.CACHE_SESSION_DISPOSED
DISPOSED — event triggered in class solace.MessageConsumerEventName

  The message consumer is being disposed. No further events will be emitted.

DISPOSED — event triggered in class solace.QueueBrowserEventName

  The queue browser is being disposed. No further events will be emitted.

DOWN — event triggered in class solace.QueueBrowserEventName

  The queue browser is successfully disconnected. The queue browser is disabled.

DOWN — event triggered in class solace.MessageConsumerEventName

  The message consumer is successfully disconnected. The message consumer is disabled.

DOWN_ERROR — event triggered in class solace.QueueBrowserEventName

  The queue browser was established and then disconnected by the router, likely due to operator intervention. The queue browser is disabled.

DOWN_ERROR — event triggered in class solace.SessionEventCode

  The session was established and then went down.

DOWN_ERROR — event triggered in class solace.MessageConsumerEventName

  The message consumer was established and then disconnected by the router, likely due to operator intervention. The message consumer is disabled.

dump — public method in class solace.Message

  Produces a human-readable dump of the message's properties and contents. Applications must not parse the output, as its format is not a defined part of the API and subject to change.

  Output can be controlled by the `flags` parameter. The values are:

  - MessageDumpFlag.MSGDUMP_BRIEF Display only the length of the binary attachment, xml attachment, and user property map
  - MessageDumpFlag.MSGDUMP_FULL Display the entire message.

## E Top

Enum — mixin in namespace solace

  Creates an Enum with the given key-value mapping.

ErrorSubcode — namespace

  Defines an error subcode enumeration which is returned as a property of the errors/exceptions thrown by the API. The subcode provides more detailed error information.

  The following subcodes can apply to error responses resulting from any API method.

  - solace.ErrorSubcode.PARAMETER_OUT_OF_RANGE
  - solace.ErrorSubcode.PARAMETER_CONFLICT
  - solace.ErrorSubcode.INTERNAL_ERROR

## G Top

getApplicationMessageId — public method in class solace.Message

  Gets the application-provided message ID.

getApplicationMessageType — public method in class solace.Message

  Gets the application message type. This value is used by applications only, and is passed through the API and Solace Message Router untouched.

getBinaryAttachment — public method in class solace.Message

  Gets the binary attachment part of the message.

  Backward compatibility note: Using the version10 factory profile or older, the binary attachment is returned as a 'latin1' String: Each character has a code in the range * 0-255 representing the value of a single received byte at that position.

getCacheName — public method in class solace.CacheSessionProperties

  Gets the cache name to which solace.CacheSession requests should be sent, for sessions constructed using these properties.

getCacheRequestId — public method in class solace.Message

  Given a Message containing a cached message, return the cache Request Id that the application set in the call to solace.CacheSession#sendCacheRequest.

getCacheStatus — public method in class solace.Message

  Gets the cache status of this message.

getCapability — public method in class solace.Session

  Get the value of an router capability, or null if unknown. This function must be called after connecting the session.

  SDT Type conversions:

  - {string} values are returned as solace.SDTFieldType.STRING.
  - {boolean} values are returned as solace.SDTFieldType.BOOL.
  - All numeric values are returned as solace.SDTFieldType.INT64.
getCorrelationId — public method in class solace.Message

  Gets the correlation ID. The message Correlation Id is carried in the Solace message headers unmodified by the API and the Solace Message Router. This field may be used for peer-to-peer message synchronization and is commonly used for correlating a request to a reply. See solace.Session#sendRequest.

getCorrelationKey — public method in class solace.Message

  Gets the correlation Key. A correlation key is used to correlate a message with its acknowledgement or rejection. The correlation key is an object that is passed back to the client during the router acknowledgement or rejection.

  The correlation key is a local reference used by applications generating Guaranteed messages. Messages that are sent in either solace.MessageDeliveryModeType.PERSISTENT or solace.MessageDeliveryModeType.NON_PERSISTENT mode may set the correlation key.

getDeliveryCount — public method in class solace.Message

  Returns the delivery count.

getDeliveryMode — public method in class solace.Message

  Gets the delivery mode of the message.

getDestination — public method in class solace.MessageConsumer

  Returns the destination that should be used to publish messages that this consumer will receive.

  - For topic endpoints, this is the topic to which the topic endpoint is subscribed.
  - For queues, this is the associated queue destination.

  The destination returned can be used to set the ReplyTo field in a message, or otherwise communicated to partners that need to send messages to this Message Consumer. This is especially useful for temporary endpoints (Queues and Topic Endpoints), as the destination is unknown before the endpoint is created.

  This method will succeed after solace.MessageConsumerEventName#event:UP for temporaries with generated destinations.

getDestination — public method in class solace.Message

  Gets the destination to which the message was published.

getError — public method in class solace.CacheRequestResult

  Gets the error, if any, associated with the returned result.

getField — public method in class solace.SDTMapContainer

  Return the SDTField with the given key.

getGMExpiration — public method in class solace.Message
getGuaranteedMessageId — public method in class solace.Message

  This message ID is NOT a universal unique identifier for the message. There is no use for this message ID in an application. Internally this message ID is used when a message is acknowledged calling Message.acknowledge(). No other meaning should be inferred from the value of this message ID.

getKeys — public method in class solace.SDTMapContainer

  Get the list of keys in this map, in unspecified order.

getLogLevel — static public method in class solace.SolclientFactory

  Gets the current log level, which was set by solace.SolclientFactory.init or a subsequent call to solace.SolclientFactory.setLogLevel.

getMaxMessageAgeSec — public method in class solace.CacheSessionProperties

  Gets the maximum allowable message age for messages to be delivered in response to a request made on a solace.CacheSession that was constructed using these properties. 0 means no restriction on age.

getMaxMessages — public method in class solace.CacheSessionProperties

  Gets the maximum count of messages to be delivered, per solace.Destination, in response to a request issued on a solace.CacheSession constructed using these properties. 0 means no restriction on the number of messages.

getMessageConsumer — public method in class solace.Message
getName — public method in class solace.Destination
getName — public method in class solace.QueueDescriptor

  Gets/sets the remote name to which this descriptor refers.

getName — inherited public method in class solace.Topic
getNext — public method in class solace.SDTStreamContainer

  Returns the next field in the stream and advances the read pointer. If the end of the stream is reached, it returns undefined.

getPriority — public method in class solace.Message

  Gets the Message Priority Parameter (JMS Priority) value for the message. Numerical values between 0 and 255 are valid return values, undefined means the parameter is not present.

  If destination queues and topic endpoints for this message are configured to respect message priority, the values 0 through 9 can be used to affect the priority of delivery to consumers of those queues or topic endpoints. For the purposes of prioritized message delivery, values larger than 9 are treated the same as 9.

getProperties — public method in class solace.CacheSession

  Gets the cache session properties.

getProperties — public method in class solace.MessageConsumer

  Creates and returns copy of the properties for this MessageConsumer.

  If the object was constructed using an solace.AbstractQueueDescriptor, and the queue descriptor was subsequently connected to an endpoint, the `MessageConsumerProperties` returned will include a solace.QueueDescriptor that contains the resolved name.

  A new copy of the properties object is returned each time this property is accessed. The returned object cannot be polled for mutations such as the one described above.

getReceiverTimestamp — public method in class solace.Message

  Gets the receive timestamp (in milliseconds, from midnight, January 1, 1970 UTC).

getReplicationGroupMessageId — public method in class solace.Message

  Returns the Replication Group Message Id

getReplyTo — public method in class solace.Message

  Gets the replyTo destination

getReturnCode — public method in class solace.CacheRequestResult

  Gets the return code from the cache request result.

getReturnSubcode — public method in class solace.CacheRequestResult

  Gets the return subcode from the cache request result.

getSdtContainer — public method in class solace.Message

  Gets the message's structured data container, if this is a structured data message.

getSenderId — public method in class solace.Message

  Returns the Sender's ID.

getSenderTimestamp — public method in class solace.Message

  Gets the send timestamp (in milliseconds, from midnight, January 1, 1970 UTC).

getSequenceNumber — public method in class solace.Message

  Gets the sequence number.

  This is an application-defined field, see `solace.Message#setSequenceNumber()`.

getSessionProperties — public method in class solace.Session

  Returns a clone of the properties for this session.

getStat — inherited public method in class solace.MessageConsumer

  Returns a statistic for this Guaranteed Message connection.

getStat — public method in class solace.Session

  Returns the value of a given solace.StatType.

getTimeoutMsec — public method in class solace.CacheSessionProperties

  Gets the timeout for requests issued on a solace.CacheSession constructed using these properties.

  - The valid range is >= 3000.
getTimeToLive — public method in class solace.Message
getTopic — public method in class solace.CacheRequestResult

  Gets the topic object associated with the cache request.

getTopicSequenceNumber — public method in class solace.Message

  Returns the Topic Sequence Number. If there is no topic sequence number undefined is returned.

getTransportInfo — public method in class solace.Session

  Gets a transport session information string. This string is informative only, and applications should not attempt to parse it.

getType — public method in class solace.SDTField

  Gets the type of field represented.

getType — public method in class solace.AbstractQueueDescriptor

  Gets the queue type to which this descriptor refers.

getType — public method in class solace.Message

  Gets the payload type (solace.MessageType) of the message. A message has a structured payload if one was attached via solace.Message#setSdtContainer otherwise if the payload is attached via Message@setBinaryAttachment then it is unstructured (solace.MessageType#BINARY)

getType — inherited public method in class solace.Topic
getType — public method in class solace.Destination
getUserCos — public method in class solace.Message

  Gets the Class of Service (CoS) value for the message. The Class of Service has different semantics for direct and guaranteed messages.

  For messages published with solace.MessageDeliveryModeType.DIRECT, the class of service selects the weighted round-robin delivery queue when the message is forwarded to a consumer. solace.MessageUserCosType.COS1 are the lowest priority messages and will use the Solace Message Router D-1 delivery queues.

  For messages published as guaranteed messages (solace.MessageDeliveryModeType.PERSISTENT or solace.solace.MessageDeliveryModeType.NON_PERSISTENT), messages published with solace.MessageUserCosType.COS1 can be rejected by the Solace Message Router if that message would cause any queue or topic-endpoint to exceed its configured low-priority-max-msg-count.

getUserData — public method in class solace.Message

  Gets the user data part of the message.

getUserPropertyMap — public method in class solace.Message

  Gets the user property map carried in the message binary metadata.

getValue — public method in class solace.SDTField

  Gets the field value.

getXmlContent — public method in class solace.Message

  Gets the XML content part of the message. Notice that the content is encoded as UTF-8 characters, it needs to be decoded as JavaScript surrogate pair: decodeURIComponent(escape(value))

getXmlContentDecoded — public method in class solace.Message

  Gets the XML content part of the message decoded from UTF-8 encoding of the characters.

getXmlMetadata — public method in class solace.Message

  Gets the message's XML metadata section.

GM_DISABLED — event triggered in class solace.MessageConsumerEventName

  The message consumer will not connect because the current session is incompatible with Guaranteed Messaging. The message consumer is disabled until a compatible session is available.

GM_DISABLED — event triggered in class solace.QueueBrowserEventName

  The queue browser will not connect because the current session is incompatible with Guaranteed Messaging. The queue browser is disabled until a compatible session is available.

GUARANTEED_MESSAGE_PUBLISHER_DOWN — event triggered in class solace.SessionEventCode

  Guaranteed Messaging Publisher has been closed by the Solace message router. This usually indicates an operator has disabled the message spool.

## H Top

hasNext — public method in class solace.SDTStreamContainer

  Returns true if the stream has at least one more solace.SDTField at the current position.

## I Top

INACTIVE — event triggered in class solace.MessageConsumerEventName

  The message consumer has become inactive.

init — static public method in class solace.SolclientFactory

  Initialize global properties. This function must be called before any other API call is made.

  Note: After the first call to this method, subsequent calls have no effect.

isAcknowledgeImmediately — public method in class solace.Message

  Test if the Acknowledge Immediately message property is set or not. When the Acknowledge Immediately property is set to true on an outgoing Guaranteed Message, it indicates that the Solace Message Router should Acknowledge this message immediately upon receipt.

  This property, when set by a publisher, may or may not be removed by the Solace Message Router prior to delivery to a consumer, so message consumers must not expect the property value indicates how the message was originally published

isCapable — public method in class solace.Session

  Check the value of a boolean router capability.

  This function is a shortcut for solace.Session#getCapability. It performs the same operation, but instead of returning a solace.SDTField wrapping a capability value, it just returns the boolean value.

  Attempting to query a non-boolean capability will return `null`.

isDeliverToOne — public method in class solace.Message

  Gets whether the message is configured for delivering to one client only.

isDiscardIndication — public method in class solace.Message

  Indicates whether one or more messages have been discarded prior to the current message. This indicates congestion discards only and is not affected by message eliding.

isDMQEligible — public method in class solace.Message
isDurable — public method in class solace.AbstractQueueDescriptor

  Gets whether this descriptor refers to a durable queue.

isElidingEligible — public method in class solace.Message

  Returns whether the message is eligible for eliding.

  Message eliding enables filtering of data to avoid transmitting every single update to a subscribing client.

  This property does not indicate whether the message was elided.

isRedelivered — public method in class solace.Message

  Indicates whether the message has been marked as redelivered by the Solace Message Router.

isReplyMessage — public method in class solace.Message

  Returns whether the message's reply field is set, indicating that this message is a reply to a previous request. See solace.Session#sendRequest.

## L Top

loggingCallback — static public method in class solace.LogImpl

  A logging callback. It must accept any valid number of arguments of any type. It must not throw.

LogImpl — class in namespace solace

  A class that provides a binding to a log implementation. Applications that need to control API logging must construct a LogImpl instance, a log implementation that can be set in solace.SolclientFactoryProperties#logger. The binding will call the supplied log methods with the parameters supplied to each.

LogLevel — namespace

  Represents a log level enumeration.

## M Top

Message — class in namespace solace

  This class is not exposed for construction by API users. Users should obtain an instance from solace.SolclientFactory.createMessage

  A message is a container that can be used to store and send messages to and from the Solace Message Router.

  Applications manage the lifecycle of a message; a message is created by calling solace.SolclientFactory.createMessage and is freed by dereferencing it.

  API operations that cache or mutate messages always take a copy. A message may be created, mutated by the API user, and sent multiple times.

  The Message Object provides methods to manipulate the common Solace message header fields that are optionally sent in the binary metadata portion of the Solace message.

  Applications can also use the structured data API solace.Message#setSdtContainer to add containers (maps or streams) and their fields to the binary payload or to the User Property map contained within the binary metadata.

  This does not prevent applications from ignoring these methods and sending payload in the binary payload as an opaque binary field for end-to-end communications

MESSAGE — event triggered in class solace.MessageConsumerEventName

  A message was received on the message consumer.

  If the application throws an exception in this listener, and the consumer was configured to automatically acknowledge messages (see solace.MessageConsumerProperties#acknowledgeMode), the API will not acknowledge the message, since it may not have been successfully processed by the application. Such a message must be acknowledged manually. If the application did not retain a reference to the message, it may be redelivered by calling solace.MessageConsumer#disconnect followed by solace.MessageConsumer#connect depending on the configuration of the queue.

  When there is no listener for MESSAGE on a MessageConsumer, messages are queued internally until a listener is added.

MESSAGE — event triggered in class solace.SessionEventCode

  A Direct message was received on the session. This event code is only used on the EventEmitter session interface. If using the deprecated callback interface, messages are received via the callback provided in solace.MessageRxCBInfo.

MESSAGE — event triggered in class solace.QueueBrowserEventName

  A message was received on the queue browser.

  If the application did not retain a reference to the message, it may be redelivered by calling solace.QueueBrowser#disconnect followed by solace.QueueBrowser#connect depending on the configuration of the queue.

  When there is no listener for MESSAGE on a QueueBrowser, messages are queued internally until a listener is added.

MessageCacheStatus — namespace

  An attribue of a solace.Message. Applications receive messages due to subscriptions on topics, or consumers connected to durable objects. The MessageCacheStatus of such messages is: solace.MessageCacheStatus.LIVE.

  Message are also delivered to an application as a result of a cache request (see solace.CacheSession#sendCacheRequest) which have a MessageCacheStatus that is solace.MessageCacheStatus.CACHED or solace.MessageCacheStatus.SUSPECT.

  The MessageCacheStatus is retrieved with solace.Message#getCacheStatus.

MessageConsumer — class in namespace solace

  This class is not exposed for construction by API users. A Message Consumer is created by calling solace.Session#createMessageConsumer.

  A MessageConsumer controls Guaranteed Message delivery to this client.

  Consumer characteristics and behavior are defined by solace.MessageConsumerProperties. The properties can also be supplied as a simple key-value {Object}. The queue descriptor, solace.MessageConsumerProperties#queueDescriptor must be specified to identify the Guaranteed Message Queue or Guaranteed Message Topic Endpoint on the Solace Message Router.

  The MessageConsumer object is an EventEmitter, and will emit events to which the application may choose to subscribe, such as the connection to the Solace Message Router going up or down.

  If a registered listener for an emitted event throws an exception, this is caught and emitted as an 'error'.

MessageConsumerAcknowledgeMode — namespace

  An enumeration of consumer acknowledgement modes. The corresponding MessageConsumer property solace.MessageConsumerProperties#acknowledgeMode configures how acknowledgments are generated for received Guaranteed messages.

  When received messages are acknowledged they are removed from the Guaranteed Message storage on the Solace Message Router. Message Consumer acknowledgements, only remove messages from the Solace Message Router.

  In particular, withholding Message Consumer Acknowledgemnts does not stop message delivery. For Message Consumer flow control see solace.MessageConsumer.stop/solace.MessageConsumer.start. Message Consumer flow control may also be imlpemented by removing the solace.MessageConsumerEventName#event:MESSAGE listener.

MessageConsumerEvent — class in namespace solace

  Message consumer event objects. A solace.MessageConsumer will emit these events related to queue subscription management: MessageConsumerEventName.SUBSCRIPTION_OK and MessageConsumerEventName.SUBSCRIPTION_ERROR.

  Similar to SessionEvent. Also compatible with RequestError.

MessageConsumerEventName — namespace

  An enumeration of message consumer event names. A solace.MessageConsumer will emit these events as part of its lifecycle. Applications, having created a MessageConsumer can choose to listen to all of the events described here, or any subset of these events. For Example:

          mc = solace.Session.createMessageConsumer(...);
          mc.on(solace.MessageConsumerEventName.CONNECT_FAILED_ERROR,
                function connectFailedErrorEventCb(error) {
                  // error can be used as an OperationError object
                });

MessageConsumerProperties — class in namespace solace

  Defines the properties for a solace.MessageConsumer.

MessageDeliveryModeType — namespace

  Represents an enumeration of message delivery modes.

MessageDumpFlag — namespace

  Represents an enumeration of message dump formats. It controls the output of solace.Message#dump.

MessagePublisherAcknowledgeMode — namespace

  Represents authentication scheme enumeration.

MessagePublisherProperties — class in namespace solace

  Properties that define the configuration for a guaranteed message publisher.

MessageRxCBInfo — class in namespace solace

  Encapsulates the session's message receive callback function and an optional user-specified object.

  This class is passed to solace.SolclientFactory.createSession when creating a session.

MessageType — namespace

  Represents an enumeration of message payload types (see solace.Message#getBinaryAttachment)

  A message may contain unstructured byte data, or a structured container.

MessageUserCosType — namespace

  Represents an enumeration of user Class of Service (COS) levels. The COS is set on a Message with solace.Message#setUserCos The Class of Service has different semantics for direct and guaranteed messages.

  For messages published with solace.MessageDeliveryModeType.DIRECT, the class of service selects the weighted round-robin delivery queue when the message is forwarded to a consumer. solace.MessageUserCosType.COS1 are the lowest priority messages and will use the Solace Message Router D-1 delivery queues.

  For messages published as guaranteed messages (solace.MessageDeliveryModeType.PERSISTENT or solace.MessageDeliveryModeType.NON_PERSISTENT), messages published with solace.MessageUserCosType.COS1 can be rejected by the Solace Message Router if that message would cause any queue or topic-endpoint to exceed its configured low-priority-max-msg-count.

MutableSessionProperty — namespace

  Represents an enumeration of session properties that can be modified by solace.Session.updateProperty after the solace.Session is originally created.

  These correspond to session properties in solace.SessionProperties.

## N Top

nameOf — static public method in class solace.Enum

  Returns the name of an enuerated value given the enumeration and the value.

nameOf — public method in class solace.Enum

  Returns the canonical name in this enumeration for the given value. This function is designed to facilitate reflection, whereas for display

NotImplementedError — class in namespace solace

  This class is not exposed for construction by API users. An error thrown when calling an API that has not been implemented.

## O Top

OperationError — class in namespace solace

  This class is not exposed for construction by API users. An error thrown by the API when an operational error is encountered.

## P Top

PROPERTY_UPDATE_ERROR — event triggered in class solace.SessionEventCode

  The event represents a failed update of a mutable session property.

PROPERTY_UPDATE_OK — event triggered in class solace.SessionEventCode

  The event represents a successful update of a mutable session property.

## Q Top

QueueAccessType — namespace

  Represents the possible endpoint access types. The corresponding endpoint property is solace.QueueProperties#accessType.

QueueBrowser — class in namespace solace

  This class is not exposed for construction by API users. A Queue Browser is created by calling solace.Session#createQueueBrowser.

  A Queue Browser allows client applications to look at messages spooled on Endpoints without removing them. Messages are browsed from oldest to newest. After being browsed, messages are still available for consumption over normal flows. However, it is possible to selectively remove messages from the persistent store of an Endpoint. In this case, these removed messages will no longer be available for consumption. Note: If browsing a queue with an active consumer, no guarantee is made that the browser will receive all messages published to the queue. The consumer can receive and acknowledge messages before they are delivered to the browser.

  One typical application is to use Browsers to allow message bus administrators to remove “stuck” Guaranteed messages from an Endpoint without having to modify or disrupt existing applications. A message can get stuck if:

  1) It has been received by an application, but for some reason, that application has failed to acknowledge it. 2) All active message selectors have failed to match this particular message and therefore the message bus has not delivered it to any client yet. The current release only supports browsing Endpoints of type Queue.

  Note that the delivery restrictions imposed by the queue’s Access type (exclusive or non-exclusive), do not apply when browsing messages with a Browser.

  Browser characteristics and behavior are defined by solace.QueueBrowserProperties. The properties can also be supplied as a simple key-value {Object}. The queue descriptor, solace.QueueBrowserProperties#queueDescriptor must be specified to identify the Guaranteed Message Queue on the Solace Message Router.

  The Browser is an EventEmitter, and will emit events to which the application may choose to subscribe, such as the connection to the Solace Message Router going up or down.

  If a registered listener for an emitted event throws an exception, this is caught and emitted as an 'error'.

QueueBrowserEventName — namespace

  An enumeration of queue browser event names. A solace.QueueBrowser will emit these events as part of its lifecycle. Applications, having created a QueueBrowser can choose to listen to all of the events described here, or any subset of these events. For Example:

          qb = solace.Session.createQueueBrowser(...);
          qb.on(solace.QueueBrowserEventName.CONNECT_FAILED_ERROR,
                function connectFailedErrorEventCb(error) {
                  // details is an OperationError object
                });

QueueBrowserProperties — class in namespace solace

  Defines the properties for a solace.QueueBrowser.

QueueDescriptor — class in namespace solace

  QueueDescriptor

QueueDiscardBehavior — namespace

  Enumerates the behavior options when a message cannot be added to an endpoint (for example, the maximum quota solace.QueueProperties#quotaMB was exceeded).

QueuePermissions — namespace

  Represents the permissions applicable to a queue.

  The corresponding endpoint property is solace.QueueProperties#permissions.

  The access controls:

  - the permissions for all other users of the queue, this only applies to non-durable queues solace.QueueProperties#permissions;
  - for the current Message Consumer on a queue or endpoint, solace.MessageConsumer.permissions

  For example, creating a temporary topic endpoint with MODIFY_TOPIC will allow other users to modify the topic subscribed to that endpoint.

QueueProperties — class in namespace solace

  Represents a queue properties object. May be passed in to solace.Session#createMessageConsumer when creating a solace.MessageConsumer object. Upon creation of a queue, undefined queue properties are set to default values chosen by the router.

QueueType — namespace

  Specifies the type of remote resource to which an solace.AbstractQueueDescriptor refers.

## R Top

RECONNECTED — event triggered in class solace.MessageConsumerEventName

  The message consumer successfully auto-reconnected.

RECONNECTED_NOTICE — event triggered in class solace.SessionEventCode

  The automatic reconnect of the Session was successful, and the session is established again.

RECONNECTING — event triggered in class solace.MessageConsumerEventName

  The message consumer was established and then disconnected by the router, likely due to operator intervention, but flow auto reconnect is active. The message consumer is disabled, but actively reconnecting. Expect a RECONNECTED or DOWN_ERROR on success of failure. respectively. See also MessageConsumerProperties.reconnectAttempts and reconnectIntervalInMsecs.

RECONNECTING_NOTICE — event triggered in class solace.SessionEventCode

  The session has gone down, and an automatic reconnection attempt is in progress.

REJECTED_MESSAGE_ERROR — event triggered in class solace.SessionEventCode

  The Solace Message Router rejected a published message.

removeMessageFromQueue — public method in class solace.QueueBrowser

  Removes a message from the queue by acknowledging it.

  The solace.QueueBrowser does not automatically acknowledge messages. once they have been received.

  The API does not send acknowledgments immediately. It stores the state for acknowledged messages internally and acknowledges messages, in bulk, when a threshold or timer is reached.

removeSubscription — public method in class solace.MessageConsumer

  Unsubscribe the queue from a topic, requesting confirmation from the router.

  solace.MessageConsumerEventName.SUBSCRIPTION_OK is generated when subscription is removed successfully; otherwise, session event solace.MessageConsumerEventName.SUBSCRIPTION_ERROR is generated.

  When the application receives the message consumer event solace.MessageConsumerEventName.SUBSCRIPTION_ERROR, it can obtain the failed topic subscription by calling solace.MessageConsumerEvent#reason. The returned string is in the format "Topic: <failed topic subscription>".

ReplayStartLocation — class in namespace solace
  - This class is not exposed for construction by API users. Users should obtain an instances from one of the following:
  - solace.SolclientFactory.createReplayStartLocationBeginning
  - solace.SolclientFactory.createReplayStartLocationDate

  Defines the ReplayStartLocation class. The ReplayStartLocation is set in the corresponding MessageConsumer property solace.MessageConsumerProperties#replayStartLocation The single member variable, _replayStartTime is undefined in ReplayStartLocationBeginning and contains the elapsed time in milliseconds since the epoch in ReplayStartLocationDate

ReplayStartLocationBeginning — class in namespace solace
  - This class is not exposed for construction by API users. Users should obtain an instances from the following:
    - solace.SolclientFactory.createReplayStartLocationBeginning

  Defines the ReplayStartLocation class. The ReplayStartLocation is set in the corresponding MessageConsumer property solace.MessageConsumerProperties#replayStartLocation

ReplayStartLocationDate — class in namespace solace
  - This class is not exposed for construction by API users. Users should obtain an instances from the following:
    - solace.SolclientFactory.createReplayStartLocationDate

  Defines the ReplayStartLocation class. The ReplayStartLocation is set in the corresponding MessageConsumer property solace.MessageConsumerProperties#replayStartLocation

ReplicationGroupMessageId — class in namespace solace

  This class is not exposed for construction by API users. Users should obtain an instance from solace.SolclientFactory.createReplicationGroupMessageId or from solace.Message.getReplicationGroupMessageId

  ReplicationGroupMessageId specifies a Replication Group Message ID. Can be used to specify a solace.ReplayStartLocation for the message after this id. The ReplayStartLocation is set in the corresponding MessageConsumer property solace.MessageConsumerProperties#replayStartLocation.

replyReceivedCallback — static public method in class solace.Session

  A callback that returns replies to requests sent via solace.Session#sendRequest. The replyReceivedCallback must be provided to the API as the third argument of solace.Session#sendRequest.

REPUBLISHING_UNACKED_MESSAGES — event triggered in class solace.SessionEventCode

  The session has automatically recovered after the Guaranteed Message publisher failed to reconnect. Messages sent but not acknowledged are being renumbered and retransmitted. Some messages may be duplicated in the system.

RequestError — class in namespace solace

  This class is not exposed for construction by API users.

  Represents a request failure event; request failure events are passed to the application event handling callback provided when sending the request solace.Session#sendRequest

RequestEventCode — namespace

  An attribute of solace.RequestError. This enumeration represents the different errors emitted by solace.Session.requestFailedCallback when a solace.Session#sendRequest fails.

  The client application receives a request error with event code solace.RequestEventCode.REQUEST_ABORTED when the underlying connection is successfully closed, or closed as a result of a communication error.

requestFailedCallback — static public method in class solace.Session

  A callback that returns errors associated with requests sent via solace.Session#sendRequest. The requestFailedCallback must be provided to the API as the fourth argument of solace.Session#sendRequest

reset — public method in class solace.Message

  Releases all memory associated with this message. All values are reinitialized to defaults. The message is no longer associated with any session or consumer.

resetStats — public method in class solace.Session

  Reset session statistics to initial values.

rewind — public method in class solace.SDTStreamContainer

  Rewinds the read pointer to the beginning of the stream. Normally when hasNext returns false, a client application must call rewind() to reiterate over the stream's fields.

## S Top

SDTField — class in namespace solace

  This class is not exposed for construction by API users.

  Represents a SDT (Structured Data Type) field. To create an instance of an `SDTField`, call solace.SDTField.create.

  SDTField objects are used in Solace Containers (solace.SDTMapContainer and solace.SDTStreamContainer). The deprecated usage of solace.SDTMapContainer#addField and solace.SDTStreamContainer#addField take a SDTField object as an argument. The preferred usage is to pass a solace.SDTFieldType and value as arguments.

  SDTField objectts must be used as an argument to solace.Message#setSdtContainer. The only valid SDTField objects for solace.Message#setSdtContainer are:

  - solace.SDTFieldType.STREAM
  - solace.SDTFieldType.MAP
  - solace.SDTFieldType.STRING
SDTFieldType — namespace

  An enumeration of all SDT data types.

SDTMapContainer — class in namespace solace

  Defines a Structured Data Type (SDT) map container.

SDTStreamContainer — class in namespace solace

  Defines a Structured Data Type (SDT) stream container. A stream is an iterable collection of solace.SDTFields.

SDTUnsupportedValueError — class in namespace solace

  This class is not exposed for construction by API users.

  Represents a SDT unsupported value error. An SDT field was assigned a value that is within the type range for the given SDT type, but is not supported on this platform/runtime. This occurs when a received solace.SDTContainerMap or solace.SDTContainerStream contains a field with a value that can not represented in the local architecture. Possible causes include:

  - receive 64 bit integer that cannot be represented accurately in a javaScript number. JavaScript numbers are floats and can only hold a 48 bit integer without loss of precission. Any integer greater than 281474976710655 or less than -281474976710655 will cause this exception.
SDTValueErrorSubcode — namespace

  Enumeration of solace.SDTUnsuportedValueError causes.

send — public method in class solace.Session

  Publish (send) a message over the session. The message is sent to its set destination.

  This method is used for sending both direct and Guaranteed Messages. If the message's solace.MessageDeliveryModeType is solace.MessageDeliveryModeType.DIRECT, the message is a direct message; otherwise, it is a guaranteed message.

sendCacheRequest — public method in class solace.CacheSession

  Issues an asynchronous cache request. The result of the request will be returned via the listener. Messages returned as a result of issuing the request will be returned to the application via the solace.MessageRxCBInfo associated with this solace.CacheSession's solace.Session

sendReply — public method in class solace.Session

  Sends a reply message to the destination specified in messageToReplyTo.

  If `messageToReplyTo` is non-null:

  - solace.Message#getReplyTo is copied from `messageToReplyTo` to solace.Message#setDestination on `replyMessage`, unless `replyTo` is null.
  - solace.Message#setCorrelationId is copied from `messageToReplyTo` to solace.Message#setCorrelationId on `replyMessage`, unless `correlationId` is null.

  If `messageToReplyTo` is null, the application is responsible for setting the `destination` and `correlationId` on the `replyMessage`.

sendRequest — public method in class solace.Session

  Sends a request using user-specified callback functions.
  Note: The API sets the correlationId and replyTo fields of the message being sent; this overwrites any existing correlationId and replyTo values on the message.

Session — class in namespace solace

  This class is not exposed for construction by API users. Applications must use solace.SolclientFactory.createSession to create a session.

  Represents a client Session.

  Session provides these major functions:

  - Subscriber control, such as updating subscriptions;
  - Publishes both Direct and Guaranteed Messages to the router;
  - Receives direct messages from the router.

  The Session object is an EventEmitter, and will emit events with event names from solace.SessionEventCode when Session events occur. Each session event can be subscribed using solace.Session#on with the corresponding solace.SessionEventCode. If any of the registered event listeners throw an exception, the exception will be emitted on the 'error' event.

SessionEvent — class in namespace solace

  Represents a session event; events are passed to the application-provided event handling callback provided when creating the session.

SessionEventCBInfo — class in namespace solace

  Encapsulates the session's event callback function and an optional user-specified object.

  This class is passed to solace.SolclientFactory.createSession when creating a session.

SessionEventCode — namespace

  An attribute of SessionEvent. This enumeration represents the different events emitted by Session through the session event callback.

  When a session is no longer in a usable state, the API tears down the underlying connection and notifies the application with one of the following session events:

  - solace.SessionEventCode#event:DOWN_ERROR
  - solace.SessionEventCode#event:CONNECT_FAILED_ERROR
SessionProperties — class in namespace solace

  Represents a session properties object. Passed in to solace.SolclientFactory.createSession when creating a solace.Session instance.

setAcknowledgeImmediately — public method in class solace.Message

  Set the optional Acknoweledge Immediately message property. When the Acknowledge Immediately property is set to true on an outgoing Guaranteed Message, it indicates that the Solace Message Router should acknoweledge this message immediately upon receipt. By default the property is set to false on newly created messages.

  This property, when set by a publisher, may or may not be removed by the appliance prior to delivery to a consumer, so message consumers must not expect the property value indicates how the message was originally published. Therefore if a received message is forwarded by the application, the Acknowledge Immediately property should be explicitly set to the desired value (true or false).

  Setting this property on an outgoing direct message has no effect.

setApplicationMessageId — public method in class solace.Message

  Sets the application-provided message ID.

setApplicationMessageType — public method in class solace.Message

  Sets the application message type. This value is used by applications only, and is passed through the API and Solace Message Router untouched.

setAsReplyMessage — public method in class solace.Message

  Sets the reply field of the message.

setBinaryAttachment — public method in class solace.Message

  Sets the binary attachment part of the message.

  The binary attachment is conceptually an array of bytes. When this method is used, the message payload type is solace.MessageType#BINARY See solace.Message#getType.

  Applications may set the binary attachment to NULL or undefined to remove the binary attachment and create a message with no payload.

  The following types are accepted: Buffer (the nodeJS native type or equivalent) ArrayBuffer, Any DataView or TypedArray, 'latin1' String for backwards compatibility: each character has a code in the range 0-255 representing exactly one byte in the attachment.

setCacheName — public method in class solace.CacheSessionProperties

  Sets the cache name to which requests should be sent. Cannot be null or blank.

setCorrelationId — public method in class solace.Message

  Sets the correlation ID. The message Correlation Id is carried in the Solace message headers unmodified by the API and the Solace Message Router. This field may be used for peer-to-peer message synchronization and is commonly used for correlating a request to a reply. See solace.Session#sendRequest.

setCorrelationKey — public method in class solace.Message

  Sets the correlation Key. A correlation key is used to correlate a message with its acknowledgement or rejection. The correlation key is an object that is passed back to the client during the router acknowledgement or rejection.

  The correlation key is a local reference used by applications generating Guaranteed Messages. Messages that are sent in either solace.MessageDeliveryModeType.PERSISTENT or solace.MessageDeliveryModeType.NON_PERSISTENT mode may set the correlation key. If this method is used, the correlation information is returned when the solace.SessionEventCode#event:ACKNOWLEDGED_MESSAGE event is later received for an acknowledged message or when the solace.SessionEventCode#event:REJECTED_MESSAGE_ERROR is received for a rejected message.

  The API only maintains a reference to the passed object. If the application requires the contents are unmodified for proper correlation, then it is the application's responsibility to ensure the contents of the object are not modified.

  Important: The Correlation Key is not included in the transmitted message and is only used with the local API

setDeliverToOne — public method in class solace.Message

  Sets whether the message is configured for delivering to one client only.

setDeliveryMode — public method in class solace.Message

  Sets the delivery mode of the message.

setDestination — public method in class solace.Message

  Sets the destination (solace.DestinationType#Topic or solace.DestinationType#Queue) to publish the message to.

setDMQEligible — public method in class solace.Message
setElidingEligible — public method in class solace.Message

  Sets whether the message is eligible for eliding.

  Message eliding enables filtering of data to avoid transmitting every single update to a subscribing client.

  This property does not indicate whether the message was elided.

setGMExpiration — public method in class solace.Message

  Set the expiration time field. The expiration time is the UTC time (that is, the number of milliseconds from midnight January 1, 1970 UTC) when the message is to expire. The expiration time is carried in the message when set to a non-zero value. Expiration time is not included when this value is set to zero or undefined

  The message expiration time is carried to clients that receive the message unmodified and does not effect the life cycle of the message. Use solace.Message#setTimeToLive to enforce message expiry in the network.

setLogLevel — static public method in class solace.SolclientFactory

  This method changes the current log level from the level set when solace.SolclientFactory.init was called.

setMaxMessageAgeSec — public method in class solace.CacheSessionProperties

  Sets the maximum allowable message age. 0 means no restriction on age.

setMaxMessages — public method in class solace.CacheSessionProperties

  Sets the maximum count of messages to be delivered per solace.Destination in response to a cache request. 0 means no restriction.

setPriority — public method in class solace.Message

  Sets the Message Priority Parameter (JMS Priority) value for the message. Numerical values between 0 and 255 are accepted, use undefined to unset.

  If destination queues and topic endpoints for this message are configured to respect message priority, the values 0 through 9 can be used to affect the priority of delivery to consumers of those queues or topic endpoints. For the purposes of prioritized message delivery, values larger than 9 are treated the same as 9.

setReplyTo — public method in class solace.Message

  Sets the replyTo destination

setSdtContainer — public method in class solace.Message

  Makes this message a strutured data message by assigning it a structured data type (SDT) container payload (such as a solace.SDTMapContainer, solace.SDTStreamContainer or a solace.SDTFieldType.String, which is transported in the binary attachment field.

  Assigning a SDT container updates the message's Type property to the appropriate value.

  The container argument must be a solace.SDTField with a type of solace.SDTFieldType.MAP, solace.SDTFieldType.STREAM, or solace.SDTFieldType.STRING.

setSenderId — public method in class solace.Message

  Sets the Sender ID for the message

setSenderTimestamp — public method in class solace.Message

  Sets the send timestamp (in milliseconds, from midnight, January 1, 1970 UTC). This field can be generated automatically during message publishing, but it will not be generated if previously set to a non-null value by this method. See solace.SessionProperties#generateSendTimestamps.

  An application that publishes the same solace.Messsage multiple times and also wants generted timestamps on each messages, should set the sender timestamp to undefined after each call to solace.Session#send.

setSequenceNumber — public method in class solace.Message

  Sets the application-defined sequence number. If the sequence number is not set, or set to undefined, and solace.SessionProperties#generateSequenceNumber is true, then a sequence number is automatically generated for each sent message.

setTimeoutMsec — public method in class solace.CacheSessionProperties

  Sets the timeout for requests.

  - The valid range is >= 3000.
setTimeToLive — public method in class solace.Message
setUserCos — public method in class solace.Message

  Sets the Class of Service (CoS) value for the message.

  The Class of Service has different semantics for direct and guaranteed messages.

  For messages published with solace.MessageDeliveryModeType.DIRECT, the class of service selects the weighted round-robin delivery queue when the message is forwarded to a consumer. solace.MessageUserCosType#COS1 are the lowest priority messages and will use the Solace Message Router D-1 delivery queues.

  For messages published as guaranteed messages (solace.MessageDeliveryModeType.PERSISTENT or solace.solace.MessageDeliveryModeType.NON_PERSISTENT), messages published with solace.MessageUserCosType#COS1 can be rejected by the Solace Message Router if that message would cause any queue or topic-endpoint to exceed its configured low-priority-max-msg-count.

setUserData — public method in class solace.Message

  Sets the user data part of the message.

setUserPropertyMap — public method in class solace.Message

  Allows users to specify their own user properties to be carried in the message binary metadata separate from the payload.

setXmlContent — public method in class solace.Message

  Sets the XML content part of the message. The content is encoded by replacing each instance of certain characters by one, two, three, or four escape sequences representing the UTF-8 encoding of the character.

setXmlMetadata — public method in class solace.Message

  Sets the message's XML metadata section.

solace — namespace
solace/fsm — Module
SolaceError — class in namespace solace

  This class is not exposed for construction by API users. The base class for all errors thrown by the API.

SolclientFactory — namespace

  A singleton used as the main factory for the messaging APIs. The very first operation by any application must be to initialize the API:

  - solace.SolclientFactory.init

  SolclientFactory provides methods to construct:

  - solace.Session
  - solace.Message
  - solace.Destination

  Additionally SolclientFactory manages the logging level in the API.

SolclientFactoryProfiles — namespace

  The collection of predefined factory profiles available for application use.

  See each member for a description of its configuration.

SolclientFactoryProperties — class in namespace solace

  Properties used during initialization of solace.SolclientFactory.

solClientJS — global
  The Solace Message Router Messaging API for Javascript.
start — public method in class solace.QueueBrowser

  Begins delivery of messages to this queue browser. This method opens the protocol window to the Solace Message Router so further messages can be received.

  A newly created queue browser is in started state.

  If the queue browser was already started, this method has no effect.

  A consumer is stopped by calling solace.QueueBrowser.stop

start — public method in class solace.MessageConsumer

  Begins delivery of messages to this consumer. This method opens the protocol window to the Solace Message Router so further messages can be received.

  A newly created consumer is in started state.

  If the consumer was already started, this method has no effect.

  A consumer is stopped by calling solace.MessageConsumer.stop

StatType — namespace

  Statistics for sent/received messages and control operations.

stop — public method in class solace.QueueBrowser

  Stops messages from being delivered to this queue browser from the Solace Message Router. Messages may continue to be prefetched by the API and queued internally until solace.QueueBrowser#start is called.

  If the queue browser was already stopped, this method has no effect.

stop — public method in class solace.MessageConsumer

  Stops messages from being delivered to this consumer from the Solace Message Router. Messages may continue to be prefetched by the API and queued internally until solace.MessageConsumer#start is called.

  If the consumer was already stopped, this method has no effect.

subscribe — public method in class solace.Session

  Subscribe to a topic, optionally requesting a confirmation from the router.

  If requestConfirmation is set to true: solace.SessionEventCode.SUBSCRIPTION_OK is generated when subscription is added successfully; otherwise, session event solace.SessionEventCode.SUBSCRIPTION_ERROR is generated.

  If requestConfirmation is set to false, only session event solace.SessionEventCode.SUBSCRIPTION_ERROR is generated upon failure.

  When the application receives session event solace.SessionEventCode.SUBSCRIPTION_ERROR, it can obtain the failed topic subscription by calling solace.SessionEvent#reason. The returned string is in the format of "Topic: <failed topic subscription>".

SUBSCRIPTION_ERROR — event triggered in class solace.SessionEventCode

  The Solace Message Router rejected a subscription (add or remove).

SUBSCRIPTION_ERROR — event triggered in class solace.MessageConsumerEventName

  The Solace Message Router rejected a queue subscription (add or remove).

SUBSCRIPTION_OK — event triggered in class solace.SessionEventCode

  The subscribe or unsubscribe operation succeeded.

SUBSCRIPTION_OK — event triggered in class solace.MessageConsumerEventName

  The subscribe or unsubscribe operation succeeded on the queue.

## T Top

Topic — class in namespace solace

  Represents a Topic, which is a type of solace.Destination.

toString — public method in class solace.AbstractQueueDescriptor

  An informational summary of this object, subject to change.

toString — public method in class solace.Destination
toString — inherited public method in class solace.MessageConsumer
toString — public method in class solace.QueueDescriptor

  An informational summary of this object, subject to change.

toString — public method in class solace.ReplayStartLocation
toString — inherited public method in class solace.ReplicationGroupMessageId
toString — public method in class solace.SessionProperties

  Returns a human-readable representation of this Session, subject to change.

toString — inherited public method in class solace.Topic
TransportProtocol — namespace

  Connection scheme types referenced by solace.SessionProperties#transportProtocol, solace.SessionProperties#webTransportProtocolList (browser only), and solace.SessionProperties#transportProtocolInUse.

## U Top

unsubscribe — public method in class solace.Session

  Unsubscribe from a topic, and optionally request a confirmation from the router.

  If requestConfirmation is set to true, session event solace.SessionEventCode.SUBSCRIPTION_OK is generated when subscription is removed successfully; otherwise, session event solace.SessionEventCode.SUBSCRIPTION_ERROR is generated.

  If requestConfirmation is set to false, only session event solace.SessionEventCode.SUBSCRIPTION_ERROR is generated upon failure.

  When the application receives session event solace.SessionEventCode.SUBSCRIPTION_ERROR, it can obtain the failed topic subscription by calling solace.SessionEvent#reason. The returned string is in the format "Topic: <failed topic subscription>".

UNSUBSCRIBE_TE_TOPIC_ERROR — event triggered in class solace.SessionEventCode

  Unsubscribing the topic from the Durable Topic Endpoint failed.

UNSUBSCRIBE_TE_TOPIC_OK — event triggered in class solace.SessionEventCode

  Unsubscribing the topic from the Durable Topic Endpoint succeeded.

unsubscribeDurableTopicEndpoint — public method in class solace.Session

  Request that a Durable Topic Endpoint stop receiving data on a topic. Unsubscribe requests are only allowed by the router when no clients are bound to the DTE. If the unubscribe request is successful, the DTE will stop attracting messages, and all messages spooled to the DTE will be deleted.

  solace.SessionEventCode.UNSUBSCRIBE_TE_TOPIC_OK is generated when the subscription is removed successfully; otherwise, solace.SessionEventCode.UNSUBSCRIBE_TE_TOPIC_ERROR is generated.

  When the application receives session event solace.SessionEventCode.UNSUBSCRIBE_TE_TOPIC_ERROR, it can obtain the failed topic subscription by calling solace.SessionEvent#reason.

UP — event triggered in class solace.MessageConsumerEventName

  The message consumer is established.

UP — event triggered in class solace.QueueBrowserEventName

  The queue browser is established.

UP_NOTICE — event triggered in class solace.SessionEventCode

  The Session is ready to send/receive messages and perform control operations.

  At this point the transport session is up, the Session has logged in, and the P2PInbox subscription is added.

  The session is established.

updateProperty — public method in class solace.Session

  Modify a session property after creation of the session.

## V Top

values — static public method in class solace.Enum

  Returns values defined on this enumeration for the given keys. To get the enumeration keys, use Object#keys.

Version — namespace

  Returns the API version. Use version, date and mode properties for build details. Use the summary property or the .toString() method to return a summary.

VIRTUALROUTER_NAME_CHANGED — event triggered in class solace.SessionEventCode

  The Solace Message Router's Virtual Router Name changed during a reconnect operation.