cms::XAConnection Class Reference
The XAConnection interface defines an extended Connection type that is used to create XASession objects. More...
#include <src/main/cms/XAConnection.h>
Inheritance diagram for cms::XAConnection:
Public Member Functions | |
| virtual | ~XAConnection () |
| virtual XASession * | createXASession ()=0 |
| Creates an XASession object. | |
 Public Member Functions inherited from cms::Connection | |
| virtual | ~Connection () |
| virtual void | close ()=0 |
| Closes this connection as well as any Sessions created from it (and those Sessions' consumers and producers). | |
| virtual const ConnectionMetaData * | getMetaData () const =0 |
| Gets the metadata for this connection. | |
| virtual Session * | createSession ()=0 |
| Creates an AUTO_ACKNOWLEDGE Session. | |
| virtual Session * | createSession (Session::AcknowledgeMode ackMode)=0 |
| Creates a new Session to work for this Connection using the specified acknowledgment mode. | |
| virtual std::string | getClientID () const =0 |
| Get the Client Id for this session, the client Id is provider specific and is either assigned by the connection factory or set using the setClientID method. | |
| virtual void | setClientID (const std::string &clientID)=0 |
| Sets the client identifier for this connection. | |
| virtual ExceptionListener * | getExceptionListener () const =0 |
| Gets the registered Exception Listener for this connection. | |
| virtual void | setExceptionListener (ExceptionListener *listener)=0 |
| Sets the registered Exception Listener for this connection. | |
| virtual void | setMessageTransformer (cms::MessageTransformer *transformer)=0 |
| Set an MessageTransformer instance that is passed on to all Session objects created from this Connection. | |
| virtual cms::MessageTransformer * | getMessageTransformer () const =0 |
| Gets the currently configured MessageTransformer for this Connection. | |
| Public Member Functions inherited from cms::Startable | |
| virtual | ~Startable () |
| virtual void | start ()=0 |
| Starts the service. | |
| Public Member Functions inherited from cms::Stoppable | |
| virtual | ~Stoppable () |
| virtual void | stop ()=0 |
| Stops this service. | |
| Public Member Functions inherited from cms::Closeable | |
| virtual | ~Closeable () |
Detailed Description
The XAConnection interface defines an extended Connection type that is used to create XASession objects.
This is an optional interface and CMS providers are allowed to omit an implementation and instead throw an exception from an XAConnectionFactory stub to indicate that XA is not supported.
- Since
- 2.3
Constructor & Destructor Documentation
|
virtual |
Member Function Documentation
|
pure virtual |
Creates an XASession object.
- Returns
- a newly created XASession instance, caller owns the pointer.
- Exceptions
-
CMSException If the XAConnection object fails to create the XASession instance due to an internal error.
Implemented in activemq::core::ActiveMQXAConnection.
The documentation for this class was generated from the following file:
- src/main/cms/XAConnection.h
