activemq::connector::stomp::commands::ErrorCommand Class Reference

#include <ErrorCommand.h>

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

List of all members.

Public Member Functions
	ErrorCommand (void)
	ErrorCommand (StompFrame *frame)
virtual	~ErrorCommand (void)
virtual const char *	getErrorMessage (void) const
virtual void	setErrorMessage (const std::string &message)
virtual void	setErrorDetails (const std::string &text)
virtual const char *	getErrorDetails (void) const
Protected Member Functions
virtual void	initialize (StompFrame &frame)
virtual bool	validate (const StompFrame &frame) const

---

Detailed Description

Message sent from the broker when an error occurs.

---

Constructor & Destructor Documentation

activemq::connector::stomp::commands::ErrorCommand::ErrorCommand (  void   )  [inline]

activemq::connector::stomp::commands::ErrorCommand::ErrorCommand (  StompFrame *  frame  )  [inline]

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

---

Member Function Documentation

virtual const char* activemq::connector::stomp::commands::ErrorCommand::getErrorDetails (  void   )  const [inline, virtual]

Get the Text associated with this Error Returns: Error Message String

virtual const char* activemq::connector::stomp::commands::ErrorCommand::getErrorMessage (  void   )  const [inline, virtual]

Get the error message Returns: the error message string

virtual void activemq::connector::stomp::commands::ErrorCommand::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::ErrorCommand::setErrorDetails (  const std::string &  text  )  [inline, virtual]

Set the Text associated with this Error Parameters: text  Detailed Error Message

virtual void activemq::connector::stomp::commands::ErrorCommand::setErrorMessage (  const std::string &  message  )  [inline, virtual]

Set the error message Parameters: message  the error message string

virtual bool activemq::connector::stomp::commands::ErrorCommand::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:

• activemq-cpp/src/main/activemq/connector/stomp/commands/ErrorCommand.h

---