activemq-cpp-3.9.5
activemq::commands::Message Class Reference

#include <src/main/activemq/commands/Message.h>

Inheritance diagram for activemq::commands::Message:

Public Member Functions

 Message ()
 
virtual ~Message ()
 
virtual unsigned char getDataStructureType () const
 Get the DataStructure Type as defined in CommandTypes.h.
 
virtual MessagecloneDataStructure () 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.
 
Pointer< Messagecopy () 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::ActiveMQAckHandlergetAckHandler () 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::ActiveMQConnectiongetConnection () 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::PrimitiveMapgetMessageProperties ()
 Gets a reference to the Message's Properties object, allows the derived classes to get and set their own specific properties.
 
const util::PrimitiveMapgetMessageProperties () 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< Commandvisit (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.
 
- Public Member Functions inherited from activemq::commands::BaseCommand
 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 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
 
- Public Member Functions inherited from activemq::commands::Command
virtual ~Command ()
 
- Public Member Functions inherited from activemq::commands::BaseDataStructure
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
 
- Public Member Functions inherited from activemq::commands::DataStructure
virtual ~DataStructure ()
 
- Public Member Functions inherited from activemq::wireformat::MarshalAware
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< ProducerIdproducerId
 
Pointer< ActiveMQDestinationdestination
 
Pointer< TransactionIdtransactionId
 
Pointer< ActiveMQDestinationoriginalDestination
 
Pointer< MessageIdmessageId
 
Pointer< TransactionIdoriginalTransactionId
 
std::string groupID
 
int groupSequence
 
std::string correlationId
 
bool persistent
 
long long expiration
 
unsigned char priority
 
Pointer< ActiveMQDestinationreplyTo
 
long long timestamp
 
std::string type
 
std::vector< unsigned char > content
 
std::vector< unsigned char > marshalledProperties
 
Pointer< DataStructuredataStructure
 
Pointer< ConsumerIdtargetConsumerId
 
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::ActiveMQConnectionconnection
 

Static Protected Attributes

static const unsigned int DEFAULT_MESSAGE_SIZE = 1024
 

Constructor & Destructor Documentation

◆ Message()

activemq::commands::Message::Message ( )

◆ ~Message()

virtual activemq::commands::Message::~Message ( )
virtual

Member Function Documentation

◆ afterUnmarshal()

virtual void activemq::commands::Message::afterUnmarshal ( wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
virtual

Called after unmarshaling is started to cleanup the object being unmarshaled.

Parameters
wireFormat- the wireformat object to control unmarshaling

Reimplemented from activemq::commands::BaseDataStructure.

◆ beforeMarshal()

virtual void activemq::commands::Message::beforeMarshal ( wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
virtual

Handles the marshaling of the objects properties into the internal byte array before the object is marshaled to the wire.

Parameters
wireFormat- the wireformat controller

Reimplemented from activemq::commands::BaseDataStructure.

◆ cloneDataStructure()

virtual Message * activemq::commands::Message::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.

Reimplemented in activemq::commands::ActiveMQBlobMessage, activemq::commands::ActiveMQBytesMessage, activemq::commands::ActiveMQMapMessage, activemq::commands::ActiveMQMessage, activemq::commands::ActiveMQObjectMessage, activemq::commands::ActiveMQStreamMessage, and activemq::commands::ActiveMQTextMessage.

Referenced by copy().

◆ copy()

Pointer< Message > activemq::commands::Message::copy ( ) const
inline

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>();

Returns
a Pointer<Message> which is a duplicate of this object.

References cloneDataStructure().

◆ copyDataStructure()

virtual void activemq::commands::Message::copyDataStructure ( const DataStructure * src)
virtual

◆ equals()

◆ getAckHandler()

virtual Pointer< core::ActiveMQAckHandler > activemq::commands::Message::getAckHandler ( ) const
inlinevirtual

Gets the Acknowledgment Handler that this Message will use when the Acknowledge method is called.

Returns
handler ActiveMQAckHandler to call or NULL if not set

Referenced by activemq::commands::ActiveMQMessageTemplate< T >::acknowledge().

◆ getArrival()

virtual long long activemq::commands::Message::getArrival ( ) const
virtual

◆ getBrokerInTime()

virtual long long activemq::commands::Message::getBrokerInTime ( ) const
virtual

◆ getBrokerOutTime()

virtual long long activemq::commands::Message::getBrokerOutTime ( ) const
virtual

◆ getBrokerPath() [1/2]

virtual std::vector< decaf::lang::Pointer< BrokerId > > & activemq::commands::Message::getBrokerPath ( )
virtual

◆ getBrokerPath() [2/2]

virtual const std::vector< decaf::lang::Pointer< BrokerId > > & activemq::commands::Message::getBrokerPath ( ) const
virtual

◆ getCluster() [1/2]

virtual std::vector< decaf::lang::Pointer< BrokerId > > & activemq::commands::Message::getCluster ( )
virtual

◆ getCluster() [2/2]

virtual const std::vector< decaf::lang::Pointer< BrokerId > > & activemq::commands::Message::getCluster ( ) const
virtual

◆ getConnection()

core::ActiveMQConnection * activemq::commands::Message::getConnection ( ) const
inline

Gets the ActiveMQConnection instance that this Command was created from when the session create methods are called to create a Message.

Returns
the ActiveMQConnection parent for this Message or NULL if not set.

◆ getContent() [1/2]

virtual std::vector< unsigned char > & activemq::commands::Message::getContent ( )
virtual

◆ getContent() [2/2]

virtual const std::vector< unsigned char > & activemq::commands::Message::getContent ( ) const
virtual

◆ getCorrelationId() [1/2]

virtual std::string & activemq::commands::Message::getCorrelationId ( )
virtual

◆ getCorrelationId() [2/2]

virtual const std::string & activemq::commands::Message::getCorrelationId ( ) const
virtual

◆ getDataStructure() [1/2]

virtual Pointer< DataStructure > & activemq::commands::Message::getDataStructure ( )
virtual

◆ getDataStructure() [2/2]

virtual const Pointer< DataStructure > & activemq::commands::Message::getDataStructure ( ) const
virtual

◆ getDataStructureType()

virtual unsigned char activemq::commands::Message::getDataStructureType ( ) const
virtual

◆ getDestination() [1/2]

virtual Pointer< ActiveMQDestination > & activemq::commands::Message::getDestination ( )
virtual

◆ getDestination() [2/2]

◆ getExpiration()

virtual long long activemq::commands::Message::getExpiration ( ) const
virtual

◆ getGroupID() [1/2]

virtual std::string & activemq::commands::Message::getGroupID ( )
virtual

◆ getGroupID() [2/2]

virtual const std::string & activemq::commands::Message::getGroupID ( ) const
virtual

◆ getGroupSequence()

virtual int activemq::commands::Message::getGroupSequence ( ) const
virtual

◆ getMarshalledProperties() [1/2]

virtual std::vector< unsigned char > & activemq::commands::Message::getMarshalledProperties ( )
virtual

◆ getMarshalledProperties() [2/2]

virtual const std::vector< unsigned char > & activemq::commands::Message::getMarshalledProperties ( ) const
virtual

◆ getMessageId() [1/2]

virtual Pointer< MessageId > & activemq::commands::Message::getMessageId ( )
virtual

◆ getMessageId() [2/2]

virtual const Pointer< MessageId > & activemq::commands::Message::getMessageId ( ) const
virtual

◆ getMessageProperties() [1/2]

util::PrimitiveMap & activemq::commands::Message::getMessageProperties ( )
inline

◆ getMessageProperties() [2/2]

const util::PrimitiveMap & activemq::commands::Message::getMessageProperties ( ) const
inline

◆ getOriginalDestination() [1/2]

virtual Pointer< ActiveMQDestination > & activemq::commands::Message::getOriginalDestination ( )
virtual

◆ getOriginalDestination() [2/2]

virtual const Pointer< ActiveMQDestination > & activemq::commands::Message::getOriginalDestination ( ) const
virtual

◆ getOriginalTransactionId() [1/2]

virtual Pointer< TransactionId > & activemq::commands::Message::getOriginalTransactionId ( )
virtual

◆ getOriginalTransactionId() [2/2]

virtual const Pointer< TransactionId > & activemq::commands::Message::getOriginalTransactionId ( ) const
virtual

◆ getPriority()

virtual unsigned char activemq::commands::Message::getPriority ( ) const
virtual

◆ getProducerId() [1/2]

virtual Pointer< ProducerId > & activemq::commands::Message::getProducerId ( )
virtual

◆ getProducerId() [2/2]

virtual const Pointer< ProducerId > & activemq::commands::Message::getProducerId ( ) const
virtual

◆ getRedeliveryCounter()

virtual int activemq::commands::Message::getRedeliveryCounter ( ) const
virtual

◆ getReplyTo() [1/2]

virtual Pointer< ActiveMQDestination > & activemq::commands::Message::getReplyTo ( )
virtual

◆ getReplyTo() [2/2]

virtual const Pointer< ActiveMQDestination > & activemq::commands::Message::getReplyTo ( ) const
virtual

◆ getSize()

virtual unsigned int activemq::commands::Message::getSize ( ) const
virtual

Returns the Size of this message in Bytes.

Returns
number of bytes this message equates to.

Reimplemented in activemq::commands::ActiveMQTextMessage.

◆ getTargetConsumerId() [1/2]

virtual Pointer< ConsumerId > & activemq::commands::Message::getTargetConsumerId ( )
virtual

◆ getTargetConsumerId() [2/2]

virtual const Pointer< ConsumerId > & activemq::commands::Message::getTargetConsumerId ( ) const
virtual

◆ getTimestamp()

virtual long long activemq::commands::Message::getTimestamp ( ) const
virtual

◆ getTransactionId() [1/2]

virtual Pointer< TransactionId > & activemq::commands::Message::getTransactionId ( )
virtual

◆ getTransactionId() [2/2]

virtual const Pointer< TransactionId > & activemq::commands::Message::getTransactionId ( ) const
virtual

◆ getType() [1/2]

virtual std::string & activemq::commands::Message::getType ( )
virtual

◆ getType() [2/2]

virtual const std::string & activemq::commands::Message::getType ( ) const
virtual

◆ getUserID() [1/2]

virtual std::string & activemq::commands::Message::getUserID ( )
virtual

◆ getUserID() [2/2]

virtual const std::string & activemq::commands::Message::getUserID ( ) const
virtual

◆ isCompressed()

virtual bool activemq::commands::Message::isCompressed ( ) const
virtual

◆ isDroppable()

virtual bool activemq::commands::Message::isDroppable ( ) const
virtual

◆ isExpired()

virtual bool activemq::commands::Message::isExpired ( ) const
virtual

Returns if this message has expired, meaning that its Expiration time has elapsed.

Returns
true if message is expired.

◆ isJMSXGroupFirstForConsumer()

virtual bool activemq::commands::Message::isJMSXGroupFirstForConsumer ( ) const
virtual

◆ isMarshalAware()

virtual bool activemq::commands::Message::isMarshalAware ( ) const
inlinevirtual

Indicates that this command is aware of Marshaling, and needs to have its Marshaling methods invoked.

Returns
boolean indicating desire to be in marshaling stages

Reimplemented from activemq::commands::BaseDataStructure.

Reimplemented in activemq::commands::ActiveMQMapMessage.

◆ isMessage()

virtual bool activemq::commands::Message::isMessage ( ) const
inlinevirtual
Returns
an answer of true to the isMessage() query.

Reimplemented from activemq::commands::BaseCommand.

◆ isPersistent()

virtual bool activemq::commands::Message::isPersistent ( ) const
virtual

◆ isReadOnlyBody()

bool activemq::commands::Message::isReadOnlyBody ( ) const
inline

◆ isReadOnlyProperties()

bool activemq::commands::Message::isReadOnlyProperties ( ) const
inline

Returns if the Message Properties Are Read Only.

Returns
true if Message Properties are Read Only.

Referenced by activemq::commands::ActiveMQMessageTemplate< T >::failIfReadOnlyProperties().

◆ isRecievedByDFBridge()

virtual bool activemq::commands::Message::isRecievedByDFBridge ( ) const
virtual

◆ onSend()

◆ setAckHandler()

virtual void activemq::commands::Message::setAckHandler ( const Pointer< core::ActiveMQAckHandler > & handler)
inlinevirtual

Sets the Acknowledgment Handler that this Message will use when the Acknowledge method is called.

Parameters
handlerActiveMQAckHandler to call

◆ setArrival()

virtual void activemq::commands::Message::setArrival ( long long arrival)
virtual

References arrival.

◆ setBrokerInTime()

virtual void activemq::commands::Message::setBrokerInTime ( long long brokerInTime)
virtual

References brokerInTime.

◆ setBrokerOutTime()

virtual void activemq::commands::Message::setBrokerOutTime ( long long brokerOutTime)
virtual

References brokerOutTime.

◆ setBrokerPath()

virtual void activemq::commands::Message::setBrokerPath ( const std::vector< decaf::lang::Pointer< BrokerId > > & brokerPath)
virtual

References brokerPath.

◆ setCluster()

virtual void activemq::commands::Message::setCluster ( const std::vector< decaf::lang::Pointer< BrokerId > > & cluster)
virtual

References cluster.

◆ setCompressed()

virtual void activemq::commands::Message::setCompressed ( bool compressed)
virtual

References compressed.

◆ setConnection()

void activemq::commands::Message::setConnection ( core::ActiveMQConnection * connection)
inline

Sets the ActiveMQConnection instance that this Command was created from when the session create methods are called to create a Message.

Parameters
handlerActiveMQConnection parent for this message

References connection.

◆ setContent()

virtual void activemq::commands::Message::setContent ( const std::vector< unsigned char > & content)
virtual

◆ setCorrelationId()

virtual void activemq::commands::Message::setCorrelationId ( const std::string & correlationId)
virtual

◆ setDataStructure()

virtual void activemq::commands::Message::setDataStructure ( const Pointer< DataStructure > & dataStructure)
virtual

References dataStructure.

◆ setDestination()

virtual void activemq::commands::Message::setDestination ( const Pointer< ActiveMQDestination > & destination)
virtual

◆ setDroppable()

virtual void activemq::commands::Message::setDroppable ( bool droppable)
virtual

References droppable.

◆ setExpiration()

virtual void activemq::commands::Message::setExpiration ( long long expiration)
virtual

◆ setGroupID()

virtual void activemq::commands::Message::setGroupID ( const std::string & groupID)
virtual

References groupID.

◆ setGroupSequence()

virtual void activemq::commands::Message::setGroupSequence ( int groupSequence)
virtual

References groupSequence.

◆ setJMSXGroupFirstForConsumer()

virtual void activemq::commands::Message::setJMSXGroupFirstForConsumer ( bool jMSXGroupFirstForConsumer)
virtual

◆ setMarshalledProperties()

virtual void activemq::commands::Message::setMarshalledProperties ( const std::vector< unsigned char > & marshalledProperties)
virtual

References marshalledProperties.

◆ setMessageId()

virtual void activemq::commands::Message::setMessageId ( const Pointer< MessageId > & messageId)
virtual

◆ setOriginalDestination()

virtual void activemq::commands::Message::setOriginalDestination ( const Pointer< ActiveMQDestination > & originalDestination)
virtual

References originalDestination.

◆ setOriginalTransactionId()

virtual void activemq::commands::Message::setOriginalTransactionId ( const Pointer< TransactionId > & originalTransactionId)
virtual

References originalTransactionId.

◆ setPersistent()

virtual void activemq::commands::Message::setPersistent ( bool persistent)
virtual

◆ setPriority()

virtual void activemq::commands::Message::setPriority ( unsigned char priority)
virtual

◆ setProducerId()

virtual void activemq::commands::Message::setProducerId ( const Pointer< ProducerId > & producerId)
virtual

References producerId.

◆ setReadOnlyBody()

void activemq::commands::Message::setReadOnlyBody ( bool value)
inline

Set the Read Only State of the Message Content.

Parameters
value- true if Content should be read only.

Referenced by activemq::commands::ActiveMQMessageTemplate< T >::clearBody(), and activemq::commands::ActiveMQMessageTemplate< T >::onSend().

◆ setReadOnlyProperties()

void activemq::commands::Message::setReadOnlyProperties ( bool value)
inline

Set the Read Only State of the Message Properties.

Parameters
value- true if Properties should be read only.

Referenced by activemq::commands::ActiveMQMessageTemplate< T >::clearProperties(), and activemq::commands::ActiveMQMessageTemplate< T >::onSend().

◆ setRecievedByDFBridge()

virtual void activemq::commands::Message::setRecievedByDFBridge ( bool recievedByDFBridge)
virtual

References recievedByDFBridge.

◆ setRedeliveryCounter()

virtual void activemq::commands::Message::setRedeliveryCounter ( int redeliveryCounter)
virtual

References redeliveryCounter.

◆ setReplyTo()

virtual void activemq::commands::Message::setReplyTo ( const Pointer< ActiveMQDestination > & replyTo)
virtual

◆ setTargetConsumerId()

virtual void activemq::commands::Message::setTargetConsumerId ( const Pointer< ConsumerId > & targetConsumerId)
virtual

References targetConsumerId.

◆ setTimestamp()

virtual void activemq::commands::Message::setTimestamp ( long long timestamp)
virtual

◆ setTransactionId()

virtual void activemq::commands::Message::setTransactionId ( const Pointer< TransactionId > & transactionId)
virtual

References transactionId.

◆ setType()

virtual void activemq::commands::Message::setType ( const std::string & type)
virtual

◆ setUserID()

virtual void activemq::commands::Message::setUserID ( const std::string & userID)
virtual

References userID.

◆ toString()

virtual std::string activemq::commands::Message::toString ( ) const
virtual

◆ visit()

virtual Pointer< Command > activemq::commands::Message::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

◆ arrival

long long activemq::commands::Message::arrival
protected

Referenced by setArrival().

◆ brokerInTime

long long activemq::commands::Message::brokerInTime
protected

Referenced by setBrokerInTime().

◆ brokerOutTime

long long activemq::commands::Message::brokerOutTime
protected

Referenced by setBrokerOutTime().

◆ brokerPath

std::vector< decaf::lang::Pointer<BrokerId> > activemq::commands::Message::brokerPath
protected

Referenced by setBrokerPath().

◆ cluster

std::vector< decaf::lang::Pointer<BrokerId> > activemq::commands::Message::cluster
protected

Referenced by setCluster().

◆ compressed

bool activemq::commands::Message::compressed
protected

Referenced by setCompressed().

◆ connection

core::ActiveMQConnection* activemq::commands::Message::connection
protected

Referenced by setConnection().

◆ content

std::vector<unsigned char> activemq::commands::Message::content
protected

Referenced by setContent().

◆ correlationId

std::string activemq::commands::Message::correlationId
protected

◆ dataStructure

Pointer<DataStructure> activemq::commands::Message::dataStructure
protected

Referenced by setDataStructure().

◆ DEFAULT_MESSAGE_SIZE

const unsigned int activemq::commands::Message::DEFAULT_MESSAGE_SIZE = 1024
staticprotected

◆ destination

◆ droppable

bool activemq::commands::Message::droppable
protected

Referenced by setDroppable().

◆ expiration

long long activemq::commands::Message::expiration
protected

Referenced by setExpiration().

◆ groupID

std::string activemq::commands::Message::groupID
protected

Referenced by setGroupID().

◆ groupSequence

int activemq::commands::Message::groupSequence
protected

Referenced by setGroupSequence().

◆ ID_MESSAGE

const unsigned char activemq::commands::Message::ID_MESSAGE = 0
static

◆ jMSXGroupFirstForConsumer

bool activemq::commands::Message::jMSXGroupFirstForConsumer
protected

◆ marshalledProperties

std::vector<unsigned char> activemq::commands::Message::marshalledProperties
protected

Referenced by setMarshalledProperties().

◆ messageId

Pointer<MessageId> activemq::commands::Message::messageId
protected

◆ originalDestination

Pointer<ActiveMQDestination> activemq::commands::Message::originalDestination
protected

Referenced by setOriginalDestination().

◆ originalTransactionId

Pointer<TransactionId> activemq::commands::Message::originalTransactionId
protected

◆ persistent

bool activemq::commands::Message::persistent
protected

Referenced by setPersistent().

◆ priority

unsigned char activemq::commands::Message::priority
protected

◆ producerId

Pointer<ProducerId> activemq::commands::Message::producerId
protected

Referenced by setProducerId().

◆ recievedByDFBridge

bool activemq::commands::Message::recievedByDFBridge
protected

Referenced by setRecievedByDFBridge().

◆ redeliveryCounter

int activemq::commands::Message::redeliveryCounter
protected

Referenced by setRedeliveryCounter().

◆ replyTo

Pointer<ActiveMQDestination> activemq::commands::Message::replyTo
protected

Referenced by setReplyTo().

◆ targetConsumerId

Pointer<ConsumerId> activemq::commands::Message::targetConsumerId
protected

Referenced by setTargetConsumerId().

◆ timestamp

long long activemq::commands::Message::timestamp
protected

Referenced by setTimestamp().

◆ transactionId

Pointer<TransactionId> activemq::commands::Message::transactionId
protected

Referenced by setTransactionId().

◆ type

◆ userID

std::string activemq::commands::Message::userID
protected

Referenced by setUserID().


The documentation for this class was generated from the following file: