activemq-cpp-3.9.5
|
#include <src/main/activemq/commands/Message.h>
Public Member Functions | |
Message () | |
virtual | ~Message () |
virtual unsigned char | getDataStructureType () const |
Get the DataStructure Type as defined in CommandTypes.h. | |
virtual Message * | 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 |
Pointer< Message > | copy () const |
Create a Pointer based copy of this message. | |
virtual void | beforeMarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED) |
Handles the marshaling of the objects properties into the internal byte array before the object is marshaled to the wire. | |
virtual void | afterUnmarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED) |
Called after unmarshaling is started to cleanup the object being unmarshaled. | |
virtual bool | isMarshalAware () const |
Indicates that this command is aware of Marshaling, and needs to have its Marshaling methods invoked. | |
virtual void | setAckHandler (const Pointer< core::ActiveMQAckHandler > &handler) |
Sets the Acknowledgment Handler that this Message will use when the Acknowledge method is called. | |
virtual Pointer< core::ActiveMQAckHandler > | getAckHandler () const |
Gets the Acknowledgment Handler that this Message will use when the Acknowledge method is called. | |
void | setConnection (core::ActiveMQConnection *connection) |
Sets the ActiveMQConnection instance that this Command was created from when the session create methods are called to create a Message. | |
core::ActiveMQConnection * | getConnection () const |
Gets the ActiveMQConnection instance that this Command was created from when the session create methods are called to create a Message. | |
virtual unsigned int | getSize () const |
Returns the Size of this message in Bytes. | |
virtual bool | isExpired () const |
Returns if this message has expired, meaning that its Expiration time has elapsed. | |
virtual void | onSend () |
Allows derived Message classes to perform tasks before a message is sent. | |
util::PrimitiveMap & | getMessageProperties () |
Gets a reference to the Message's Properties object, allows the derived classes to get and set their own specific properties. | |
const util::PrimitiveMap & | getMessageProperties () const |
bool | isReadOnlyProperties () const |
Returns if the Message Properties Are Read Only. | |
void | setReadOnlyProperties (bool value) |
Set the Read Only State of the Message Properties. | |
bool | isReadOnlyBody () const |
Returns if the Message Body is Read Only. | |
void | setReadOnlyBody (bool value) |
Set the Read Only State of the Message Content. | |
virtual const Pointer< ProducerId > & | getProducerId () const |
virtual Pointer< ProducerId > & | getProducerId () |
virtual void | setProducerId (const Pointer< ProducerId > &producerId) |
virtual const Pointer< ActiveMQDestination > & | getDestination () const |
virtual Pointer< ActiveMQDestination > & | getDestination () |
virtual void | setDestination (const Pointer< ActiveMQDestination > &destination) |
virtual const Pointer< TransactionId > & | getTransactionId () const |
virtual Pointer< TransactionId > & | getTransactionId () |
virtual void | setTransactionId (const Pointer< TransactionId > &transactionId) |
virtual const Pointer< ActiveMQDestination > & | getOriginalDestination () const |
virtual Pointer< ActiveMQDestination > & | getOriginalDestination () |
virtual void | setOriginalDestination (const Pointer< ActiveMQDestination > &originalDestination) |
virtual const Pointer< MessageId > & | getMessageId () const |
virtual Pointer< MessageId > & | getMessageId () |
virtual void | setMessageId (const Pointer< MessageId > &messageId) |
virtual const Pointer< TransactionId > & | getOriginalTransactionId () const |
virtual Pointer< TransactionId > & | getOriginalTransactionId () |
virtual void | setOriginalTransactionId (const Pointer< TransactionId > &originalTransactionId) |
virtual const std::string & | getGroupID () const |
virtual std::string & | getGroupID () |
virtual void | setGroupID (const std::string &groupID) |
virtual int | getGroupSequence () const |
virtual void | setGroupSequence (int groupSequence) |
virtual const std::string & | getCorrelationId () const |
virtual std::string & | getCorrelationId () |
virtual void | setCorrelationId (const std::string &correlationId) |
virtual bool | isPersistent () const |
virtual void | setPersistent (bool persistent) |
virtual long long | getExpiration () const |
virtual void | setExpiration (long long expiration) |
virtual unsigned char | getPriority () const |
virtual void | setPriority (unsigned char priority) |
virtual const Pointer< ActiveMQDestination > & | getReplyTo () const |
virtual Pointer< ActiveMQDestination > & | getReplyTo () |
virtual void | setReplyTo (const Pointer< ActiveMQDestination > &replyTo) |
virtual long long | getTimestamp () const |
virtual void | setTimestamp (long long timestamp) |
virtual const std::string & | getType () const |
virtual std::string & | getType () |
virtual void | setType (const std::string &type) |
virtual const std::vector< unsigned char > & | getContent () const |
virtual std::vector< unsigned char > & | getContent () |
virtual void | setContent (const std::vector< unsigned char > &content) |
virtual const std::vector< unsigned char > & | getMarshalledProperties () const |
virtual std::vector< unsigned char > & | getMarshalledProperties () |
virtual void | setMarshalledProperties (const std::vector< unsigned char > &marshalledProperties) |
virtual const Pointer< DataStructure > & | getDataStructure () const |
virtual Pointer< DataStructure > & | getDataStructure () |
virtual void | setDataStructure (const Pointer< DataStructure > &dataStructure) |
virtual const Pointer< ConsumerId > & | getTargetConsumerId () const |
virtual Pointer< ConsumerId > & | getTargetConsumerId () |
virtual void | setTargetConsumerId (const Pointer< ConsumerId > &targetConsumerId) |
virtual bool | isCompressed () const |
virtual void | setCompressed (bool compressed) |
virtual int | getRedeliveryCounter () const |
virtual void | setRedeliveryCounter (int redeliveryCounter) |
virtual const std::vector< decaf::lang::Pointer< BrokerId > > & | getBrokerPath () const |
virtual std::vector< decaf::lang::Pointer< BrokerId > > & | getBrokerPath () |
virtual void | setBrokerPath (const std::vector< decaf::lang::Pointer< BrokerId > > &brokerPath) |
virtual long long | getArrival () const |
virtual void | setArrival (long long arrival) |
virtual const std::string & | getUserID () const |
virtual std::string & | getUserID () |
virtual void | setUserID (const std::string &userID) |
virtual bool | isRecievedByDFBridge () const |
virtual void | setRecievedByDFBridge (bool recievedByDFBridge) |
virtual bool | isDroppable () const |
virtual void | setDroppable (bool droppable) |
virtual const std::vector< decaf::lang::Pointer< BrokerId > > & | getCluster () const |
virtual std::vector< decaf::lang::Pointer< BrokerId > > & | getCluster () |
virtual void | setCluster (const std::vector< decaf::lang::Pointer< BrokerId > > &cluster) |
virtual long long | getBrokerInTime () const |
virtual void | setBrokerInTime (long long brokerInTime) |
virtual long long | getBrokerOutTime () const |
virtual void | setBrokerOutTime (long long brokerOutTime) |
virtual bool | isJMSXGroupFirstForConsumer () const |
virtual void | setJMSXGroupFirstForConsumer (bool jMSXGroupFirstForConsumer) |
virtual bool | isMessage () const |
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. | |
![]() | |
BaseCommand () | |
virtual | ~BaseCommand () |
virtual void | setCommandId (int id) |
Sets the Command Id of this Message. | |
virtual int | getCommandId () const |
Gets the Command Id of this Message. | |
virtual void | setResponseRequired (const bool required) |
Set if this Message requires a Response. | |
virtual bool | isResponseRequired () const |
Is a Response required for this Command. | |
virtual void | copyDataStructure (const DataStructure *src) |
Copy the contents of the passed object into this objects members, overwriting any existing data. | |
virtual bool | equals (const DataStructure *value) const |
Compares the DataStructure passed in to this one, and returns if they are equivalent. | |
virtual bool | isBrokerInfo () const |
virtual bool | isControlCommand () const |
virtual bool | isConnectionControl () const |
virtual bool | isConnectionError () const |
virtual bool | isConnectionInfo () const |
virtual bool | isConsumerInfo () const |
virtual bool | isConsumerControl () const |
virtual bool | isDestinationInfo () const |
virtual bool | isFlushCommand () const |
virtual bool | isMessageAck () const |
virtual bool | isMessagePull () const |
virtual bool | isKeepAliveInfo () const |
virtual bool | isMessageDispatch () const |
virtual bool | isMessageDispatchNotification () const |
virtual bool | isProducerAck () const |
virtual bool | isProducerInfo () const |
virtual bool | isResponse () const |
virtual bool | isRemoveInfo () const |
virtual bool | isRemoveSubscriptionInfo () const |
virtual bool | isReplayCommand () const |
virtual bool | isSessionInfo () const |
virtual bool | isShutdownInfo () const |
virtual bool | isTransactionInfo () const |
virtual bool | isWireFormatInfo () const |
![]() | |
virtual | ~Command () |
![]() | |
virtual | ~BaseDataStructure () |
virtual void | afterMarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED) |
virtual void | beforeUnmarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED) |
virtual void | setMarshaledForm (wireformat::WireFormat *wireFormat AMQCPP_UNUSED, const std::vector< char > &data AMQCPP_UNUSED) |
virtual std::vector< unsigned char > | getMarshaledForm (wireformat::WireFormat *wireFormat AMQCPP_UNUSED) |
virtual void | copyDataStructure (const DataStructure *src AMQCPP_UNUSED) |
virtual bool | equals (const DataStructure *value AMQCPP_UNUSED) const |
![]() | |
virtual | ~DataStructure () |
![]() | |
virtual | ~MarshalAware () |
virtual void | beforeMarshal (WireFormat *wireFormat)=0 |
Called before marshaling is started to prepare the object to be marshaled. | |
virtual void | afterMarshal (WireFormat *wireFormat)=0 |
Called after marshaling is started to cleanup the object being marshaled. | |
virtual void | beforeUnmarshal (WireFormat *wireFormat)=0 |
Called before unmarshaling is started to prepare the object to be unmarshaled. | |
virtual void | afterUnmarshal (WireFormat *wireFormat)=0 |
Called after unmarshaling is started to cleanup the object being unmarshaled. | |
virtual void | setMarshaledForm (WireFormat *wireFormat, const std::vector< char > &data)=0 |
Called to set the data to this object that will contain the objects marshaled form. | |
virtual std::vector< unsigned char > | getMarshaledForm (WireFormat *wireFormat)=0 |
Called to get the data to this object that will contain the objects marshaled form. | |
Static Public Attributes | |
static const unsigned char | ID_MESSAGE = 0 |
Protected Attributes | |
Pointer< ProducerId > | producerId |
Pointer< ActiveMQDestination > | destination |
Pointer< TransactionId > | transactionId |
Pointer< ActiveMQDestination > | originalDestination |
Pointer< MessageId > | messageId |
Pointer< TransactionId > | originalTransactionId |
std::string | groupID |
int | groupSequence |
std::string | correlationId |
bool | persistent |
long long | expiration |
unsigned char | priority |
Pointer< ActiveMQDestination > | replyTo |
long long | timestamp |
std::string | type |
std::vector< unsigned char > | content |
std::vector< unsigned char > | marshalledProperties |
Pointer< DataStructure > | dataStructure |
Pointer< ConsumerId > | targetConsumerId |
bool | compressed |
int | redeliveryCounter |
std::vector< decaf::lang::Pointer< BrokerId > > | brokerPath |
long long | arrival |
std::string | userID |
bool | recievedByDFBridge |
bool | droppable |
std::vector< decaf::lang::Pointer< BrokerId > > | cluster |
long long | brokerInTime |
long long | brokerOutTime |
bool | jMSXGroupFirstForConsumer |
core::ActiveMQConnection * | connection |
Static Protected Attributes | |
static const unsigned int | DEFAULT_MESSAGE_SIZE = 1024 |
activemq::commands::Message::Message | ( | ) |
|
virtual |
|
virtual |
Called after unmarshaling is started to cleanup the object being unmarshaled.
wireFormat | - the wireformat object to control unmarshaling |
Reimplemented from activemq::commands::BaseDataStructure.
|
virtual |
Handles the marshaling of the objects properties into the internal byte array before the object is marshaled to the wire.
wireFormat | - the wireformat controller |
Reimplemented from activemq::commands::BaseDataStructure.
|
virtual |
Clone this obbject and return a new instance that the caller now owns, this will be an exact copy of this one.
Implements activemq::commands::DataStructure.
Create a Pointer based copy of this message.
Useful for chaining a clone operation with other operation such as casting to a cms Message type.
Pointer<cms::Message> cmsMsg = message->copy().dynamic_cast<cms::Message>();
|
virtual |
|
virtual |
|
inlinevirtual |
Gets the Acknowledgment Handler that this Message will use when the Acknowledge method is called.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
inline |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Get the DataStructure Type as defined in CommandTypes.h.
Implements activemq::commands::DataStructure.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
inline |
Gets a reference to the Message's Properties object, allows the derived classes to get and set their own specific properties.
|
inline |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Returns the Size of this message in Bytes.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Returns if this message has expired, meaning that its Expiration time has elapsed.
|
virtual |
|
inlinevirtual |
Indicates that this command is aware of Marshaling, and needs to have its Marshaling methods invoked.
Reimplemented from activemq::commands::BaseDataStructure.
|
inlinevirtual |
Reimplemented from activemq::commands::BaseCommand.
|
virtual |
|
inline |
|
inline |
|
virtual |
|
inlinevirtual |
Allows derived Message classes to perform tasks before a message is sent.
|
inlinevirtual |
Sets the Acknowledgment Handler that this Message will use when the Acknowledge method is called.
handler | ActiveMQAckHandler to call |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
inline |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
inline |
Set the Read Only State of the Message Content.
value | - true if Content should be read only. |
|
inline |
Set the Read Only State of the Message Properties.
value | - true if Properties should be read only. |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Returns a string containing the information for this DataStructure such as its type and value of its elements.
Reimplemented from activemq::commands::BaseCommand.
|
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.
Implements activemq::commands::Command.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
staticprotected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
static |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |