activemq::commands::ActiveMQMessageTemplate< T > Class Template Reference

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

Inheritance diagram for activemq::commands::ActiveMQMessageTemplate< T >:

[legend]

Public Member Functions
	ActiveMQMessageTemplate ()
virtual	~ActiveMQMessageTemplate () throw ()
virtual void	acknowledge () const
virtual void	onSend ()
	Allows derived Message classes to perform tasks before a message is sent.
virtual bool	equals (const DataStructure *value) const
	Compares the DataStructure passed in to this one, and returns if they are equivalent.
virtual void	clearBody ()
virtual void	clearProperties ()
virtual std::vector< std::string >	getPropertyNames () const
virtual bool	propertyExists (const std::string &name) const
virtual cms::Message::ValueType	getPropertyValueType (const std::string &name) const
virtual bool	getBooleanProperty (const std::string &name) const
virtual unsigned char	getByteProperty (const std::string &name) const
virtual double	getDoubleProperty (const std::string &name) const
virtual float	getFloatProperty (const std::string &name) const
virtual int	getIntProperty (const std::string &name) const
virtual long long	getLongProperty (const std::string &name) const
virtual short	getShortProperty (const std::string &name) const
virtual std::string	getStringProperty (const std::string &name) const
virtual void	setBooleanProperty (const std::string &name, bool value)
virtual void	setByteProperty (const std::string &name, unsigned char value)
virtual void	setDoubleProperty (const std::string &name, double value)
virtual void	setFloatProperty (const std::string &name, float value)
virtual void	setIntProperty (const std::string &name, int value)
virtual void	setLongProperty (const std::string &name, long long value)
virtual void	setShortProperty (const std::string &name, short value)
virtual void	setStringProperty (const std::string &name, const std::string &value)
virtual std::string	getCMSCorrelationID () const
virtual void	setCMSCorrelationID (const std::string &correlationId)
virtual int	getCMSDeliveryMode () const
virtual void	setCMSDeliveryMode (int mode)
virtual const cms::Destination *	getCMSDestination () const
virtual void	setCMSDestination (const cms::Destination *destination)
virtual long long	getCMSExpiration () const
virtual void	setCMSExpiration (long long expireTime)
virtual std::string	getCMSMessageID () const
virtual void	setCMSMessageID (const std::string &value)
virtual int	getCMSPriority () const
virtual void	setCMSPriority (int priority)
virtual bool	getCMSRedelivered () const
virtual void	setCMSRedelivered (bool redelivered AMQCPP_UNUSED)
virtual const cms::Destination *	getCMSReplyTo () const
virtual void	setCMSReplyTo (const cms::Destination *destination)
virtual long long	getCMSTimestamp () const
virtual void	setCMSTimestamp (long long timeStamp)
virtual std::string	getCMSType () const
virtual void	setCMSType (const std::string &type)
Protected Member Functions
void	failIfWriteOnlyBody () const
void	failIfReadOnlyBody () const
void	failIfReadOnlyProperties () const

template<typename T>
class activemq::commands::ActiveMQMessageTemplate< T >

---

Constructor & Destructor Documentation

template<typename T>

activemq::commands::ActiveMQMessageTemplate< T >::ActiveMQMessageTemplate

(

)

[inline]

template<typename T>

virtual activemq::commands::ActiveMQMessageTemplate< T >::~ActiveMQMessageTemplate

(

)

throw () [inline, virtual]

---

Member Function Documentation

template<typename T>

virtual void activemq::commands::ActiveMQMessageTemplate< T >::acknowledge

(

)

const [inline, virtual]

template<typename T>

virtual void activemq::commands::ActiveMQMessageTemplate< T >::clearBody

(

)

[inline, virtual]

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

template<typename T>

virtual void activemq::commands::ActiveMQMessageTemplate< T >::clearProperties

(

)

[inline, virtual]

template<typename T>

virtual bool activemq::commands::ActiveMQMessageTemplate< T >::equals

(

const DataStructure *

value

)

const [inline, 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::Message.

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

template<typename T>

void activemq::commands::ActiveMQMessageTemplate< T >::failIfReadOnlyBody

(

)

const [inline, protected]

template<typename T>

void activemq::commands::ActiveMQMessageTemplate< T >::failIfReadOnlyProperties

(

)

const [inline, protected]

template<typename T>

void activemq::commands::ActiveMQMessageTemplate< T >::failIfWriteOnlyBody

(

)

const [inline, protected]

template<typename T>

virtual bool activemq::commands::ActiveMQMessageTemplate< T >::getBooleanProperty

(

const std::string &

name

)

const [inline, virtual]

template<typename T>

virtual unsigned char activemq::commands::ActiveMQMessageTemplate< T >::getByteProperty

(

const std::string &

name

)

const [inline, virtual]

template<typename T>

virtual std::string activemq::commands::ActiveMQMessageTemplate< T >::getCMSCorrelationID

(

)

const [inline, virtual]

template<typename T>

virtual int activemq::commands::ActiveMQMessageTemplate< T >::getCMSDeliveryMode

(

)

const [inline, virtual]

template<typename T>

virtual const cms::Destination* activemq::commands::ActiveMQMessageTemplate< T >::getCMSDestination

(

)

const [inline, virtual]

template<typename T>

virtual long long activemq::commands::ActiveMQMessageTemplate< T >::getCMSExpiration

(

)

const [inline, virtual]

template<typename T>

virtual std::string activemq::commands::ActiveMQMessageTemplate< T >::getCMSMessageID

(

)

const [inline, virtual]

template<typename T>

virtual int activemq::commands::ActiveMQMessageTemplate< T >::getCMSPriority

(

)

const [inline, virtual]

template<typename T>

virtual bool activemq::commands::ActiveMQMessageTemplate< T >::getCMSRedelivered

(

)

const [inline, virtual]

template<typename T>

virtual const cms::Destination* activemq::commands::ActiveMQMessageTemplate< T >::getCMSReplyTo

(

)

const [inline, virtual]

template<typename T>

virtual long long activemq::commands::ActiveMQMessageTemplate< T >::getCMSTimestamp

(

)

const [inline, virtual]

template<typename T>

virtual std::string activemq::commands::ActiveMQMessageTemplate< T >::getCMSType

(

)

const [inline, virtual]

template<typename T>

virtual double activemq::commands::ActiveMQMessageTemplate< T >::getDoubleProperty

(

const std::string &

name

)

const [inline, virtual]

template<typename T>

virtual float activemq::commands::ActiveMQMessageTemplate< T >::getFloatProperty

(

const std::string &

name

)

const [inline, virtual]

template<typename T>

virtual int activemq::commands::ActiveMQMessageTemplate< T >::getIntProperty

(

const std::string &

name

)

const [inline, virtual]

template<typename T>

virtual long long activemq::commands::ActiveMQMessageTemplate< T >::getLongProperty

(

const std::string &

name

)

const [inline, virtual]

template<typename T>

virtual std::vector<std::string> activemq::commands::ActiveMQMessageTemplate< T >::getPropertyNames

(

)

const [inline, virtual]

template<typename T>

virtual cms::Message::ValueType activemq::commands::ActiveMQMessageTemplate< T >::getPropertyValueType

(

const std::string &

name

)

const [inline, virtual]

template<typename T>

virtual short activemq::commands::ActiveMQMessageTemplate< T >::getShortProperty

(

const std::string &

name

)

const [inline, virtual]

template<typename T>

virtual std::string activemq::commands::ActiveMQMessageTemplate< T >::getStringProperty

(

const std::string &

name

)

const [inline, virtual]

template<typename T>

virtual void activemq::commands::ActiveMQMessageTemplate< T >::onSend

(

)

[inline, virtual]

Allows derived Message classes to perform tasks before a message is sent.

Reimplemented from activemq::commands::Message.

Reimplemented in activemq::commands::ActiveMQBytesMessage, and activemq::commands::ActiveMQStreamMessage.

template<typename T>

virtual bool activemq::commands::ActiveMQMessageTemplate< T >::propertyExists

(

const std::string &

name

)

const [inline, virtual]

template<typename T>

virtual void activemq::commands::ActiveMQMessageTemplate< T >::setBooleanProperty	(	const std::string &	name,
		bool	value
	)			[inline, virtual]

template<typename T>

virtual void activemq::commands::ActiveMQMessageTemplate< T >::setByteProperty	(	const std::string &	name,
		unsigned char	value
	)			[inline, virtual]

template<typename T>

virtual void activemq::commands::ActiveMQMessageTemplate< T >::setCMSCorrelationID

(

const std::string &

correlationId

)

[inline, virtual]

template<typename T>

virtual void activemq::commands::ActiveMQMessageTemplate< T >::setCMSDeliveryMode

(

int

mode

)

[inline, virtual]

template<typename T>

virtual void activemq::commands::ActiveMQMessageTemplate< T >::setCMSDestination

(

const cms::Destination *

destination

)

[inline, virtual]

template<typename T>

virtual void activemq::commands::ActiveMQMessageTemplate< T >::setCMSExpiration

(

long long

expireTime

)

[inline, virtual]

template<typename T>

virtual void activemq::commands::ActiveMQMessageTemplate< T >::setCMSMessageID

(

const std::string &

value

)

[inline, virtual]

template<typename T>

virtual void activemq::commands::ActiveMQMessageTemplate< T >::setCMSPriority

(

int

priority

)

[inline, virtual]

template<typename T>

virtual void activemq::commands::ActiveMQMessageTemplate< T >::setCMSRedelivered

(

bool redelivered

AMQCPP_UNUSED

)

[inline, virtual]

template<typename T>

virtual void activemq::commands::ActiveMQMessageTemplate< T >::setCMSReplyTo

(

const cms::Destination *

destination

)

[inline, virtual]

template<typename T>

virtual void activemq::commands::ActiveMQMessageTemplate< T >::setCMSTimestamp

(

long long

timeStamp

)

[inline, virtual]

template<typename T>

virtual void activemq::commands::ActiveMQMessageTemplate< T >::setCMSType

(

const std::string &

type

)

[inline, virtual]

template<typename T>

virtual void activemq::commands::ActiveMQMessageTemplate< T >::setDoubleProperty	(	const std::string &	name,
		double	value
	)			[inline, virtual]

template<typename T>

virtual void activemq::commands::ActiveMQMessageTemplate< T >::setFloatProperty	(	const std::string &	name,
		float	value
	)			[inline, virtual]

template<typename T>

virtual void activemq::commands::ActiveMQMessageTemplate< T >::setIntProperty	(	const std::string &	name,
		int	value
	)			[inline, virtual]

template<typename T>

virtual void activemq::commands::ActiveMQMessageTemplate< T >::setLongProperty	(	const std::string &	name,
		long long	value
	)			[inline, virtual]

template<typename T>

virtual void activemq::commands::ActiveMQMessageTemplate< T >::setShortProperty	(	const std::string &	name,
		short	value
	)			[inline, virtual]

template<typename T>

virtual void activemq::commands::ActiveMQMessageTemplate< T >::setStringProperty	(	const std::string &	name,
		const std::string &	value
	)			[inline, virtual]

---

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

• src/main/activemq/commands/ActiveMQMessageTemplate.h