activemq::connector::stomp::commands::ConnectCommand Class Reference

#include <ConnectCommand.h>

Inheritance diagram for activemq::connector::stomp::commands::ConnectCommand:

activemq::connector::stomp::commands::AbstractCommand< transport::Command > activemq::connector::stomp::commands::StompCommand activemq::transport::Command activemq::connector::stomp::marshal::Marshalable List of all members.

Public Member Functions

 ConnectCommand (void)
 ConnectCommand (StompFrame *frame)
virtual ~ConnectCommand (void)
virtual const char * getLogin (void) const
virtual void setLogin (const std::string &login)
virtual const char * getPassword (void) const
virtual void setPassword (const std::string &password)
virtual const char * getClientId (void) const
virtual void setClientId (const std::string &clientId)

Protected Member Functions

virtual void initialize (StompFrame &frame)
virtual bool validate (const StompFrame &frame) const

Detailed Description

Message sent to the broker to connect.


Constructor & Destructor Documentation

activemq::connector::stomp::commands::ConnectCommand::ConnectCommand void   )  [inline]
 

activemq::connector::stomp::commands::ConnectCommand::ConnectCommand StompFrame frame  )  [inline]
 

virtual activemq::connector::stomp::commands::ConnectCommand::~ConnectCommand void   )  [inline, virtual]
 


Member Function Documentation

virtual const char* activemq::connector::stomp::commands::ConnectCommand::getClientId void   )  const [inline, virtual]
 

Get the Client Id

Returns:
char* to client Id, can be ""

virtual const char* activemq::connector::stomp::commands::ConnectCommand::getLogin void   )  const [inline, virtual]
 

Get the login

Returns:
char* to login, can be ""

virtual const char* activemq::connector::stomp::commands::ConnectCommand::getPassword void   )  const [inline, virtual]
 

Get the password

Returns:
char* to password, can be ""

virtual void activemq::connector::stomp::commands::ConnectCommand::initialize StompFrame frame  )  [inline, protected, virtual]
 

Inheritors are required to override this method to init the frame with data appropriate for the command type.

Parameters:
frame Frame to init

Implements activemq::connector::stomp::commands::AbstractCommand< transport::Command >.

virtual void activemq::connector::stomp::commands::ConnectCommand::setClientId const std::string &  clientId  )  [inline, virtual]
 

Set the Client Id

Parameters:
clientId client id string value

virtual void activemq::connector::stomp::commands::ConnectCommand::setLogin const std::string &  login  )  [inline, virtual]
 

Set the login

Parameters:
login username string value

virtual void activemq::connector::stomp::commands::ConnectCommand::setPassword const std::string &  password  )  [inline, virtual]
 

Set the password

Parameters:
password the passwrod string value

virtual bool activemq::connector::stomp::commands::ConnectCommand::validate const StompFrame frame  )  const [inline, protected, virtual]
 

Inheritors are required to override this method to validate the passed stomp frame before it is marshalled or unmarshaled

Parameters:
frame Frame to validate
Returns:
true if frame is valid

Implements activemq::connector::stomp::commands::AbstractCommand< transport::Command >.


The documentation for this class was generated from the following file:
Generated on Thu Aug 3 18:03:32 2006 for activemq-cpp by  doxygen 1.4.5