activemq::commands::ActiveMQBlobMessage Class Reference
#include <src/main/activemq/commands/ActiveMQBlobMessage.h>
Public Member Functions | |
| ActiveMQBlobMessage () | |
| virtual | ~ActiveMQBlobMessage () throw () |
| virtual unsigned char | getDataStructureType () const |
| Get the DataStructure Type as defined in CommandTypes.h. | |
| virtual ActiveMQBlobMessage * | 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. | |
| std::string | getRemoteBlobUrl () const |
| Get the Remote URL of the Blob. | |
| void | setRemoteBlobUrl (const std::string &remoteURL) |
| Set the Remote URL of the Blob. | |
| std::string | getMimeType () const |
| Get the Mime Type of the Blob. | |
| void | setMimeType (const std::string &mimeType) |
| Set the Mime Type of the Blob. | |
| std::string | getName () const |
| Gets the Name of the Blob. | |
| void | setName (const std::string &name) |
| Sets the Name of the Blob. | |
| bool | isDeletedByBroker () const |
| Gets if this Blob is deleted by the Broker. | |
| void | setDeletedByBroker (bool value) |
| Sets the Deleted By Broker flag. | |
Static Public Attributes | |
| static const unsigned char | ID_ACTIVEMQBLOBMESSAGE = 29 |
| static const std::string | BINARY_MIME_TYPE |
Constructor & Destructor Documentation
| activemq::commands::ActiveMQBlobMessage::ActiveMQBlobMessage | ( | ) |
| virtual activemq::commands::ActiveMQBlobMessage::~ActiveMQBlobMessage | ( | ) | throw () [inline, virtual] |
Member Function Documentation
| virtual cms::Message* activemq::commands::ActiveMQBlobMessage::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 ActiveMQBlobMessage* activemq::commands::ActiveMQBlobMessage::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::ActiveMQBlobMessage::copyDataStructure | ( | const DataStructure * | src | ) | [virtual] |
Reimplemented from activemq::commands::Message.
| virtual bool activemq::commands::ActiveMQBlobMessage::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::Message >.
| virtual unsigned char activemq::commands::ActiveMQBlobMessage::getDataStructureType | ( | ) | const [virtual] |
Get the DataStructure Type as defined in CommandTypes.h.
- Returns:
- The type of the data structure
Reimplemented from activemq::commands::Message.
| std::string activemq::commands::ActiveMQBlobMessage::getMimeType | ( | ) | const [inline] |
Get the Mime Type of the Blob.
- Returns:
- string holding the MIME Type.
| std::string activemq::commands::ActiveMQBlobMessage::getName | ( | ) | const [inline] |
Gets the Name of the Blob.
- Returns:
- string name of the Blob.
| std::string activemq::commands::ActiveMQBlobMessage::getRemoteBlobUrl | ( | ) | const [inline] |
Get the Remote URL of the Blob.
- Returns:
- string from of the Remote Blob URL.
| bool activemq::commands::ActiveMQBlobMessage::isDeletedByBroker | ( | ) | const [inline] |
Gets if this Blob is deleted by the Broker.
- Returns:
- true if the Blob is deleted by the Broker.
| void activemq::commands::ActiveMQBlobMessage::setDeletedByBroker | ( | bool | value | ) | [inline] |
Sets the Deleted By Broker flag.
- Parameters:
-
value - set the Delete by broker flag to value.
| void activemq::commands::ActiveMQBlobMessage::setMimeType | ( | const std::string & | mimeType | ) | [inline] |
Set the Mime Type of the Blob.
- Parameters:
-
mimeType - String holding the MIME Type.
| void activemq::commands::ActiveMQBlobMessage::setName | ( | const std::string & | name | ) | [inline] |
Sets the Name of the Blob.
- Parameters:
-
name - Name of the Blob.
| void activemq::commands::ActiveMQBlobMessage::setRemoteBlobUrl | ( | const std::string & | remoteURL | ) | [inline] |
Set the Remote URL of the Blob.
- Parameters:
-
remoteURL - String form of the Remote URL.
| virtual std::string activemq::commands::ActiveMQBlobMessage::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 std::string activemq::commands::ActiveMQBlobMessage::BINARY_MIME_TYPE [static] |
const unsigned char activemq::commands::ActiveMQBlobMessage::ID_ACTIVEMQBLOBMESSAGE = 29 [static] |
The documentation for this class was generated from the following file:
- src/main/activemq/commands/ActiveMQBlobMessage.h
