cms::Connection Class Reference

#include <src/main/cms/Connection.h>

Inheritance diagram for cms::Connection:

[legend]

Collaboration diagram for cms::Connection:

[legend]

---

Detailed Description

The client's connection to its provider.

Public Member Functions
virtual	~Connection ()
virtual void	close ()=0 throw ( CMSException )
	Closes this connection as well as any Sessions created from it (and those Sessions' consumers and producers).
virtual Session *	createSession ()=0 throw ( CMSException )
	Creates an AUTO_ACKNOWLEDGE Session.
virtual Session *	createSession (Session::AcknowledgeMode ackMode)=0 throw ( CMSException )
	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.
virtual ExceptionListener *	getExceptionListener () const =0
	Gets the registered Exception Listener for this connection.
virtual void	setExceptionListener (ExceptionListener *listener)=0
	Sets the registed Exception Listener for this connection.

---

Constructor & Destructor Documentation

virtual cms::Connection::~Connection

(

)

[inline, virtual]

---

Member Function Documentation

virtual void cms::Connection::close

(

)

throw ( CMSException ) [pure virtual]

Closes this connection as well as any Sessions created from it (and those Sessions' consumers and producers).

Exceptions:

CMSException

Implements cms::Closeable.

virtual Session* cms::Connection::createSession

(

)

throw ( CMSException ) [pure virtual]

Creates an AUTO_ACKNOWLEDGE Session.

Exceptions:

CMSException

virtual Session* cms::Connection::createSession

(

Session::AcknowledgeMode

ackMode

)

throw ( CMSException ) [pure virtual]

Creates a new Session to work for this Connection using the specified acknowledgment mode.

Parameters:

ackMode

the Acknowledgement Mode to use.

Exceptions:

CMSException

virtual std::string cms::Connection::getClientID

(

)

const [pure virtual]

Get the Client Id for this session.

Returns:

Client Id String

virtual ExceptionListener* cms::Connection::getExceptionListener

(

)

const [pure virtual]

Gets the registered Exception Listener for this connection.

Returns:

pointer to an exception listnener or NULL

virtual void cms::Connection::setExceptionListener

(

ExceptionListener *

listener

)

[pure virtual]

Sets the registed Exception Listener for this connection.

Parameters:

listener

pointer to and ExceptionListener

---

The documentation for this class was generated from the following file:

• src/main/cms/Connection.h

---