This topic documents the C++ classes and their methods.
The following table summarizes all the classes.
Class | Description |
---|---|
BytesMessage | A bytes message is a message whose body comprises a stream of bytes. |
Connection | A Connection object represents an application's active connection to a broker. |
ConnectionFactory | An application uses a connection factory to create a connection. |
ConnectionMetaData | A ConnectionMetaData object provides information about a connection. |
Destination | A destination is where an application sends messages, or it is a source from which an application receives messages, or both. |
Exception | If XMS detects
an error while processing a call to a method, XMS throws
an exception. An exception is an object that encapsulates information about
the error. There are different types of XMS exception, and an Exception object is just one type of exception. However, the Exception class is a superclass of the other XMS exception classes. XMS throws an Exception object in situations where none of the other types of exception are appropriate. |
ExceptionListener | An application uses an exception listener to be notified asynchronously of a problem with a connection. |
IllegalStateException | XMS throws this exception if an application calls a method at an incorrect or inappropriate time, or if XMS is not in an appropriate state for the requested operation. |
InitialContext | An application uses an InitialContext object to create objects from object definitions that are retrieved from a repository of administered objects. |
InvalidClientIDException | XMS throws this exception if an application attempts to set a client identifier for a connection, but the client identifier is not valid or is already in use. |
InvalidDestinationException | XMS throws this exception if an application specifies a destination that is not valid. |
InvalidSelectorException | XMS throws this exception if an application provides a message selector expression whose syntax is not valid. |
Iterator | An iterator encapsulates a list of objects. An application uses an iterator to access object in turn. |
MapMessage | A map message is a message whose body comprises a set of name-value pairs, where each value has an associated data type. |
Message | A Message object represents a message that an application sends or receives. |
MessageConsumer | An application uses a message consumer to receive messages sent to a destination. |
MessageEOFException | XMS throws this exception if XMS encounters the end of a bytes message stream when an application is reading the body of a bytes message. |
MessageFormatException | XMS throws this exception if XMS encounters a message with a format that is not valid. |
MessageListener | An application uses a message listener to receive messages asynchronously. |
MessageNotReadableException | XMS throws this exception if an application attempts to read the body of a message that is write-only. |
MessageNotWritableException | XMS throws this exception if an application attempts to write to the body of a message that is read-only. |
MessageProducer | An application uses a message producer to send messages to a destination. |
ObjectMessage | An object message is a message whose body comprises a serialized Java or .NET object. |
Property | A Property object represents a property of an object. |
PropertyContext | PropertyContext is an abstract superclass that contains methods that get and set properties. These methods are inherited by other classes. |
QueueBrowser | An application uses a queue browser to browse messages on a queue without removing them. |
Requestor | An application uses a requestor to send a request message and then wait for, and receive, the reply. |
ResourceAllocationException | XMS throws this exception if XMS cannot allocate the resources required by a method. |
SecurityException | XMS throws this exception if the user identifer and password provided to authenticate an application are rejected. XMS also throws this exception if an authority check fails and prevents a method from completing. |
Session | A session is a single threaded context for sending and receiving messages. |
StreamMessage | A stream message is a message whose body comprises a stream of values, where each value has an associated data type. |
String | A String object encapsulates a string. |
TextMessage | A text message is a message whose body comprises a string. |
TransactionInProgressException | XMS throws this exception if an application requests an operation that is not valid because a transaction is in progress. |
TransactionRolledBackException | XMS throws this exception if an application calls Session.commit() to commit the current transaction, but the transaction is subsequently rolled back. |
The definition of each method lists the exception codes that XMS might return if it detects an error while processing a call to the method. Each exception code is represented by its named constant. The following table lists the exception codes and their corresponding C++ exceptions.
Exception code | Corresponding C++ exception |
---|---|
XMS_X_GENERAL_EXCEPTION | Exception |
XMS_X_ILLEGAL_STATE_EXCEPTION | IllegalStateException |
XMS_X_INVALID_CLIENTID_EXCEPTION | InvalidClientIDException |
XMS_X_INVALID_DESTINATION_EXCEPTION | InvalidDestinationException |
XMS_X_INVALID_SELECTOR_EXCEPTION | InvalidSelectorException |
XMS_X_MESSAGE_EOF_EXCEPTION | MessageEOFException |
XMS_X_MESSAGE_FORMAT_EXCEPTION | MessageFormatException |
XMS_X_MESSAGE_NOT_READABLE_EXCEPTION | MessageNotReadableException |
XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION | MessageNotWritableException |
XMS_X_RESOURCE_ALLOCATION_EXCEPTION | ResourceAllocationException |
XMS_X_SECURITY_EXCEPTION | SecurityException |
XMS_X_TRANSACTION_IN_PROGRESS_EXCEPTION | TransactionInProgressException |
XMS_X_TRANSACTION_ROLLED_BACK_EXCEPTION | TransactionRolledBackException |