activemq::commands::ActiveMQObjectMessage Class Reference
#include <src/main/activemq/commands/ActiveMQObjectMessage.h>
Public Member Functions | |
| ActiveMQObjectMessage () | |
| virtual | ~ActiveMQObjectMessage () throw () |
| virtual unsigned char | getDataStructureType () const |
| Get the DataStructure Type as defined in CommandTypes.h. | |
| virtual ActiveMQObjectMessage * | 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) |
| 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 cms::Message * | clone () const |
| Clone this message exactly, returns a new instance that the caller is required to delete. | |
| virtual void | setObjectBytes (const std::vector< unsigned char > &bytes) |
| Sets the payload bytes the represent the Object being transmitted. | |
| virtual std::vector< unsigned char > | getObjectBytes () const |
| Returns the byte array containing the serialized form of the transmitted Object. | |
Static Public Attributes | |
| static const unsigned char | ID_ACTIVEMQOBJECTMESSAGE = 26 |
Constructor & Destructor Documentation
| activemq::commands::ActiveMQObjectMessage::ActiveMQObjectMessage | ( | ) |
| virtual activemq::commands::ActiveMQObjectMessage::~ActiveMQObjectMessage | ( | ) | throw () [inline, virtual] |
Member Function Documentation
| virtual cms::Message* activemq::commands::ActiveMQObjectMessage::clone | ( | ) | const [inline, virtual] |
Clone this message exactly, returns a new instance that the caller is required to delete.
- Returns:
- new copy of this message
Implements cms::Message.
References activemq::commands::Message::setReadOnlyBody(), and activemq::commands::Message::setReadOnlyProperties().
| virtual ActiveMQObjectMessage* activemq::commands::ActiveMQObjectMessage::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.
Reimplemented from activemq::commands::Message.
| virtual void activemq::commands::ActiveMQObjectMessage::copyDataStructure | ( | const DataStructure * | src | ) | [virtual] |
Reimplemented from activemq::commands::Message.
| virtual bool activemq::commands::ActiveMQObjectMessage::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::ActiveMQMessageTemplate< cms::ObjectMessage >.
| virtual unsigned char activemq::commands::ActiveMQObjectMessage::getDataStructureType | ( | ) | const [virtual] |
Get the DataStructure Type as defined in CommandTypes.h.
- Returns:
- The type of the data structure
Reimplemented from activemq::commands::Message.
| virtual std::vector<unsigned char> activemq::commands::ActiveMQObjectMessage::getObjectBytes | ( | ) | const [virtual] |
Returns the byte array containing the serialized form of the transmitted Object.
- Returns:
- a byte vector containing the serialized Object.
- Exceptions:
-
CMSException - if the operation fails due to an internal error. MessageNotReadableException - if the message is in write only mode.
Implements cms::ObjectMessage.
| virtual void activemq::commands::ActiveMQObjectMessage::setObjectBytes | ( | const std::vector< unsigned char > & | bytes | ) | [virtual] |
Sets the payload bytes the represent the Object being transmitted.
- Parameters:
-
bytes The byte array that contains the serialized object.
- Exceptions:
-
CMSException - if the operation fails due to an internal error. MessageNotWriteableException - if the Message is in Read-only Mode.
Implements cms::ObjectMessage.
| virtual std::string activemq::commands::ActiveMQObjectMessage::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::Message.
Field Documentation
const unsigned char activemq::commands::ActiveMQObjectMessage::ID_ACTIVEMQOBJECTMESSAGE = 26 [static] |
The documentation for this class was generated from the following file:
- src/main/activemq/commands/ActiveMQObjectMessage.h
