This topic documents the C classes and their functions.
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. |
ErrorBlock | If a C function call fails, XMS can store information about why the call failed in an error block. |
ExceptionListener | An application uses an exception listener to be notified asynchronously of a problem with a connection. |
InitialContext | An application uses an InitialContext object to create objects from object definitions that are retrieved from a repository of administered objects. |
Iterator | An iterator encapsulates a list of objects. An application uses an iterator to access each 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. |
MessageListener | An application uses a message listener to receive messages asynchronously. |
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 | The PropertyContext class contains functions that get and set properties. These functions can operate on any object that can have properties. |
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. |
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. |
TextMessage | A text message is a message whose body comprises a string. |
The definition of each function lists the exception codes that XMS might return if it detects an error while processing a call to the function. Each exception code is represented by its named constant.