activemq::commands::ControlCommand Class Reference
#include <src/main/activemq/commands/ControlCommand.h>
Public Member Functions | |
| ControlCommand () | |
| virtual | ~ControlCommand () |
| virtual unsigned char | getDataStructureType () const |
| Get the DataStructure Type as defined in CommandTypes.h. | |
| virtual ControlCommand * | cloneDataStructure () const |
| Clone this obbject and return a new instance that the caller now owns, this will be an exact copy of this one. | |
| virtual void | copyDataStructure (const DataStructure *src) |
| Copy the contents of the passed object into this objects members, overwriting any existing data. | |
| virtual std::string | toString () const |
| Returns a string containing the information for this DataStructure such as its type and value of its elements. | |
| virtual bool | equals (const DataStructure *value) const |
| Compares the DataStructure passed in to this one, and returns if they are equivalent. | |
| virtual const std::string & | getCommand () const |
| virtual std::string & | getCommand () |
| virtual void | setCommand (const std::string &command) |
| virtual Pointer< Command > | visit (activemq::state::CommandVisitor *visitor) |
| Allows a Visitor to visit this command and return a response to the command based on the command type being visited. | |
Static Public Attributes | |
| static const unsigned char | ID_CONTROLCOMMAND = 14 |
Protected Attributes | |
| std::string | command |
Constructor & Destructor Documentation
| activemq::commands::ControlCommand::ControlCommand | ( | ) |
| virtual activemq::commands::ControlCommand::~ControlCommand | ( | ) | [virtual] |
Member Function Documentation
| virtual ControlCommand* activemq::commands::ControlCommand::cloneDataStructure | ( | ) | const [virtual] |
Clone this obbject and return a new instance that the caller now owns, this will be an exact copy of this one.
- Returns:
- new copy of this object.
Implements activemq::commands::DataStructure.
| virtual void activemq::commands::ControlCommand::copyDataStructure | ( | const DataStructure * | src | ) | [virtual] |
Copy the contents of the passed object into this objects members, overwriting any existing data.
- Returns:
- src - Source Object
Reimplemented from activemq::commands::BaseCommand.
| virtual bool activemq::commands::ControlCommand::equals | ( | const DataStructure * | value | ) | const [virtual] |
Compares the DataStructure passed in to this one, and returns if they are equivalent.
Equivalent here means that they are of the same type, and that each element of the objects are the same.
- Returns:
- true if DataStructure's are Equal.
Reimplemented from activemq::commands::BaseCommand.
| virtual std::string& activemq::commands::ControlCommand::getCommand | ( | ) | [virtual] |
| virtual const std::string& activemq::commands::ControlCommand::getCommand | ( | ) | const [virtual] |
| virtual unsigned char activemq::commands::ControlCommand::getDataStructureType | ( | ) | const [virtual] |
Get the DataStructure Type as defined in CommandTypes.h.
- Returns:
- The type of the data structure
Implements activemq::commands::DataStructure.
| virtual void activemq::commands::ControlCommand::setCommand | ( | const std::string & | command | ) | [virtual] |
| virtual std::string activemq::commands::ControlCommand::toString | ( | ) | const [virtual] |
Returns a string containing the information for this DataStructure such as its type and value of its elements.
- Returns:
- formatted string useful for debugging.
Reimplemented from activemq::commands::BaseCommand.
| virtual Pointer<Command> activemq::commands::ControlCommand::visit | ( | activemq::state::CommandVisitor * | visitor | ) | [virtual] |
Allows a Visitor to visit this command and return a response to the command based on the command type being visited.
The command will call the proper processXXX method in the visitor.
- Returns:
- a Response to the visitor being called or NULL if no response.
Implements activemq::commands::Command.
Field Documentation
std::string activemq::commands::ControlCommand::command [protected] |
const unsigned char activemq::commands::ControlCommand::ID_CONTROLCOMMAND = 14 [static] |
The documentation for this class was generated from the following file:
- src/main/activemq/commands/ControlCommand.h
