semaine::cms::IOBase Class Reference

#include <IOBase.h>

Inheritance diagram for semaine::cms::IOBase:
semaine::cms::receiver::Receiver semaine::cms::sender::Sender semaine::components::meta::MetaMessenger semaine::cms::receiver::BytesReceiver semaine::cms::receiver::FeatureReceiver semaine::cms::receiver::XMLReceiver semaine::cms::sender::BytesSender semaine::cms::sender::FeatureSender semaine::cms::sender::XMLSender semaine::cms::receiver::BMLReceiver semaine::cms::receiver::EmmaReceiver semaine::cms::receiver::FMLReceiver semaine::cms::receiver::StateReceiver semaine::cms::sender::BMLSender semaine::cms::sender::EmmaSender semaine::cms::sender::FMLSender semaine::cms::sender::StateSender

List of all members.

Public Member Functions

 IOBase (const std::string &topicName) throw (CMSException)
virtual ~IOBase ()
 IOBase (const std::string &cmsUrl, const std::string &cmsUser, const std::string &cmsPassword, const std::string &topicName) throw (CMSException)
std::string getTopicName () throw (CMSException)
void startConnection () throw (CMSException)
std::string getCMSUrl ()
Connection * getConnection ()
Session * getSession ()
Topic * getTopic ()

Protected Attributes

const std::string cmsUrl
const std::string cmsUser
const std::string cmsPassword
Connection * connection
Session * session
Topic * topic
bool isConnectionStarted
const CMSException * exception

Friends

class ExcListener

Detailed Description

This class handles the low-level interaction with the JMS provider for the components of the SEMAINE system.

Author:
marc

Constructor & Destructor Documentation

IOBase::IOBase ( const std::string &  topicName  )  throw (CMSException)

Create a new CMS IOBase connection with the given topic on the default JMS server. The default JMS server is determined as follows:

  • jms URL: default value tcp://localhost:61616;
  • jms User: default value empty;
  • jms Password: default value empty.
Parameters:
topicName the name of the topic to send to.
Exceptions:
CMSException 
IOBase::~IOBase (  )  [virtual]
IOBase::IOBase ( const std::string &  cmsUrl,
const std::string &  cmsUser,
const std::string &  cmsPassword,
const std::string &  topicName 
) throw (CMSException)

Create a new CMS IOBase connection with the given topic on the given JMS server.

Parameters:
cmsUrl the url where to contact the JMS server
cmsUser the username to use (can be an empty string)
cmsPassword the password to use (can be an empty string)
topicName the name of the topic to send to.
Exceptions:
CMSException 

Member Function Documentation

std::string semaine::cms::IOBase::getCMSUrl (  )  [inline]

Get the URL of the JMS server connected to.

Returns:
a string containing the url
Connection* semaine::cms::IOBase::getConnection (  )  [inline]
Session* semaine::cms::IOBase::getSession (  )  [inline]
Topic* semaine::cms::IOBase::getTopic (  )  [inline]
std::string IOBase::getTopicName (  )  throw (CMSException)

Get the name of the topic.

Returns:
a string containing the topic name.
Exceptions:
JMSException 
void IOBase::startConnection (  )  throw (CMSException)

Friends And Related Function Documentation

friend class ExcListener [friend]

Member Data Documentation

const std::string semaine::cms::IOBase::cmsPassword [protected]
const std::string semaine::cms::IOBase::cmsUrl [protected]
const std::string semaine::cms::IOBase::cmsUser [protected]
Connection* semaine::cms::IOBase::connection [protected]
const CMSException* semaine::cms::IOBase::exception [protected]
Session* semaine::cms::IOBase::session [protected]
Topic* semaine::cms::IOBase::topic [protected]

The documentation for this class was generated from the following files:
Generated on Tue Dec 14 17:13:18 2010 for SEMAINE by  doxygen 1.6.3