activemq::commands::WireFormatInfo Class Reference

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

Inheritance diagram for activemq::commands::WireFormatInfo:

Public Member Functions
	WireFormatInfo ()
virtual	~WireFormatInfo ()
virtual unsigned char	getDataStructureType () const
	Get the DataStructure Type as defined in CommandTypes.h.
virtual DataStructure *	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)
	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.
virtual bool	isMarshalAware () const
	Determine if the class implementing this interface is really wanting to be told about marshaling.
virtual decaf::lang::Pointer< commands::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.
int	getVersion () const
	Get the current Wireformat Version.
void	setVersion (int version)
	Set the current Wireformat Version.
long long	getMaxInactivityDuration () const
	Returns the currently configured Max Inactivity duration.
void	setMaxInactivityDuration (long long maxInactivityDuration)
	Sets the Max inactivity duration value.
long long	getMaxInactivityDurationInitalDelay () const
	Returns the currently configured Max Inactivity Intial Delay duration.
void	setMaxInactivityDurationInitalDelay (long long maxInactivityDurationInitalDelay)
	Sets the Max inactivity initial delay duration value.
bool	isStackTraceEnabled () const
	Checks if the stackTraceEnabled flag is on.
void	setStackTraceEnabled (bool stackTraceEnabled)
	Sets if the stackTraceEnabled flag is on.
bool	isTcpNoDelayEnabled () const
	Checks if the tcpNoDelayEnabled flag is on.
void	setTcpNoDelayEnabled (bool tcpNoDelayEnabled)
	Sets if the tcpNoDelayEnabled flag is on.
bool	isCacheEnabled () const
	Checks if the cacheEnabled flag is on.
void	setCacheEnabled (bool cacheEnabled)
	Sets if the cacheEnabled flag is on.
int	getCacheSize () const
	Gets the Cache Size setting.
void	setCacheSize (int value)
	Sets the Cache Size setting.
bool	isTightEncodingEnabled () const
	Checks if the tightEncodingEnabled flag is on.
void	setTightEncodingEnabled (bool tightEncodingEnabled)
	Sets if the tightEncodingEnabled flag is on.
bool	isSizePrefixDisabled () const
	Checks if the sizePrefixDisabled flag is on.
void	setSizePrefixDisabled (bool sizePrefixDisabled)
	Sets if the sizePrefixDisabled flag is on.
const std::vector< unsigned char > &	getMagic () const
	Get the Magic field.
void	setMagic (const std::vector< unsigned char > &magic)
	Sets the value of the magic field.
const std::vector< unsigned char > &	getMarshalledProperties () const
	Get the marshalledProperties field.
void	setMarshalledProperties (const std::vector< unsigned char > &marshalledProperties)
	Sets the value of the marshalledProperties field.
virtual const util::PrimitiveMap &	getProperties () const
	Gets the Properties for this Command.
virtual util::PrimitiveMap &	getProperties ()
	Gets the Properties for this Command.
virtual void	setProperties (const util::PrimitiveMap &map)
	Sets the Properties for this Command.
bool	isValid () const
	Determines if we think this is a Valid WireFormatInfo command.
virtual bool	isWireFormatInfo () const
virtual void	beforeMarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
virtual void	afterUnmarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
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 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.
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	isMessage () 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 ()
virtual void	setCommandId (int id)=0
	Sets the Command Id of this Message.
virtual int	getCommandId () const =0
	Gets the Command Id of this Message.
virtual void	setResponseRequired (const bool required)=0
	Set if this Message requires a Response.
virtual bool	isResponseRequired () const =0
	Is a Response required for this Command.
virtual std::string	toString () const =0
	Returns a provider-specific string that provides information about the contents of the command.
virtual decaf::lang::Pointer< commands::Command >	visit (activemq::state::CommandVisitor *visitor)=0
	Allows a Visitor to visit this command and return a response to the command based on the command type being visited.
virtual bool	isBrokerInfo () const =0
virtual bool	isControlCommand () const =0
virtual bool	isConnectionControl () const =0
virtual bool	isConnectionInfo () const =0
virtual bool	isConnectionError () const =0
virtual bool	isConsumerInfo () const =0
virtual bool	isConsumerControl () const =0
virtual bool	isDestinationInfo () const =0
virtual bool	isFlushCommand () const =0
virtual bool	isKeepAliveInfo () const =0
virtual bool	isMessage () const =0
virtual bool	isMessageAck () const =0
virtual bool	isMessagePull () const =0
virtual bool	isMessageDispatch () const =0
virtual bool	isMessageDispatchNotification () const =0
virtual bool	isProducerAck () const =0
virtual bool	isProducerInfo () const =0
virtual bool	isResponse () const =0
virtual bool	isReplayCommand () const =0
virtual bool	isRemoveInfo () const =0
virtual bool	isRemoveSubscriptionInfo () const =0
virtual bool	isSessionInfo () const =0
virtual bool	isShutdownInfo () const =0
virtual bool	isTransactionInfo () const =0
virtual bool	isWireFormatInfo () const =0
Public Member Functions inherited from activemq::commands::BaseDataStructure
virtual	~BaseDataStructure ()
virtual bool	isMarshalAware () const
	Determine if the class implementing this interface is really wanting to be told about marshaling.
virtual void	beforeMarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
virtual void	afterMarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
virtual void	beforeUnmarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
virtual void	afterUnmarshal (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 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 AMQCPP_UNUSED) const
Public Member Functions inherited from activemq::commands::DataStructure
virtual	~DataStructure ()
virtual unsigned char	getDataStructureType () const =0
	Get the DataStructure Type as defined in CommandTypes.h.
virtual DataStructure *	cloneDataStructure () const =0
	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)=0
	Copy the contents of the passed object into this objects members, overwriting any existing data.
virtual std::string	toString () const =0
	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 =0
	Compares the DataStructure passed in to this one, and returns if they are equivalent.
Public Member Functions inherited from activemq::wireformat::MarshalAware
virtual	~MarshalAware ()
virtual bool	isMarshalAware () const =0
	Determine if the class implementing this interface is really wanting to be told about marshaling.
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_WIREFORMATINFO = 1

Constructor & Destructor Documentation

WireFormatInfo()

activemq::commands::WireFormatInfo::WireFormatInfo

(

)

~WireFormatInfo()

virtual activemq::commands::WireFormatInfo::~WireFormatInfo ( )

virtual

Member Function Documentation

afterUnmarshal()

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

virtual

Reimplemented from activemq::commands::BaseDataStructure.

beforeMarshal()

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

virtual

Reimplemented from activemq::commands::BaseDataStructure.

cloneDataStructure()

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

copyDataStructure()

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

virtual

Copy the contents of the passed object into this objects members, overwriting any existing data.

Returns

src - Source Object

Reimplemented from activemq::commands::BaseCommand.

equals()

virtual bool activemq::commands::WireFormatInfo::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::BaseCommand.

getCacheSize()

int activemq::commands::WireFormatInfo::getCacheSize

(

)

const

Gets the Cache Size setting.

Returns

currently set cache size.

getDataStructureType()

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

virtual

Get the DataStructure Type as defined in CommandTypes.h.

Returns

The type of the data structure

Implements activemq::commands::DataStructure.

getMagic()

const std::vector< unsigned char > & activemq::commands::WireFormatInfo::getMagic ( ) const

inline

Get the Magic field.

Returns

const reference to a std::vector<char>

getMarshalledProperties()

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

inline

Get the marshalledProperties field.

Returns

const reference to a std::vector<char>

getMaxInactivityDuration()

long long activemq::commands::WireFormatInfo::getMaxInactivityDuration

(

)

const

Returns the currently configured Max Inactivity duration.

Returns

the set inactivity duration value.

getMaxInactivityDurationInitalDelay()

long long activemq::commands::WireFormatInfo::getMaxInactivityDurationInitalDelay

(

)

const

Returns the currently configured Max Inactivity Intial Delay duration.

Returns

the set inactivity duration initial delay value.

getProperties() [1/2]

virtual util::PrimitiveMap & activemq::commands::WireFormatInfo::getProperties ( )

inlinevirtual

Gets the Properties for this Command.

Returns

the Properties object for this Command.

getProperties() [2/2]

virtual const util::PrimitiveMap & activemq::commands::WireFormatInfo::getProperties ( ) const

inlinevirtual

Gets the Properties for this Command.

Returns

the Properties object for this Command.

getVersion()

int activemq::commands::WireFormatInfo::getVersion ( ) const

inline

Get the current Wireformat Version.

Returns

int that identifies the version

isCacheEnabled()

bool activemq::commands::WireFormatInfo::isCacheEnabled

(

)

const

Checks if the cacheEnabled flag is on.

Returns

true if the flag is on.

isMarshalAware()

virtual bool activemq::commands::WireFormatInfo::isMarshalAware ( ) const

inlinevirtual

Determine if the class implementing this interface is really wanting to be told about marshaling.

Normally if you didn't want to be marshal aware you just wouldn't implement this interface but since this is C++ and we don't have true interfaces we need a flat inheritance hierarchy, so we always implement this.

Returns

true if this class cares about marshaling.

Reimplemented from activemq::commands::BaseDataStructure.

isSizePrefixDisabled()

bool activemq::commands::WireFormatInfo::isSizePrefixDisabled

(

)

const

Checks if the sizePrefixDisabled flag is on.

Returns

true if the flag is on.

isStackTraceEnabled()

bool activemq::commands::WireFormatInfo::isStackTraceEnabled

(

)

const

Checks if the stackTraceEnabled flag is on.

Returns

true if the flag is on.

isTcpNoDelayEnabled()

bool activemq::commands::WireFormatInfo::isTcpNoDelayEnabled

(

)

const

Checks if the tcpNoDelayEnabled flag is on.

Returns

true if the flag is on.

isTightEncodingEnabled()

bool activemq::commands::WireFormatInfo::isTightEncodingEnabled

(

)

const

Checks if the tightEncodingEnabled flag is on.

Returns

true if the flag is on.

isValid()

bool activemq::commands::WireFormatInfo::isValid

(

)

const

Determines if we think this is a Valid WireFormatInfo command.

Returns

true if its valid.

isWireFormatInfo()

virtual bool activemq::commands::WireFormatInfo::isWireFormatInfo ( ) const

inlinevirtual

Returns

answers true to the isWireFormatInfo query

Reimplemented from activemq::commands::BaseCommand.

setCacheEnabled()

void activemq::commands::WireFormatInfo::setCacheEnabled

(

bool

cacheEnabled

)

Sets if the cacheEnabled flag is on.

Parameters

cacheEnabled

- true to turn flag is on

setCacheSize()

void activemq::commands::WireFormatInfo::setCacheSize

(

int

value

)

Sets the Cache Size setting.

Parameters

value

- value to set to the cache size.

setMagic()

void activemq::commands::WireFormatInfo::setMagic ( const std::vector< unsigned char > &  magic )

inline

Sets the value of the magic field.

Parameters

magic

- const std::vector<char>

setMarshalledProperties()

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

inline

Sets the value of the marshalledProperties field.

Parameters

marshalledProperties

The Byte Array vector that contains the marshaled form of the Message properties, this is the data sent over the wire.

setMaxInactivityDuration()

void activemq::commands::WireFormatInfo::setMaxInactivityDuration

(

long long

maxInactivityDuration

)

Sets the Max inactivity duration value.

Parameters

maxInactivityDuration

- max time a client can be inactive.

setMaxInactivityDurationInitalDelay()

void activemq::commands::WireFormatInfo::setMaxInactivityDurationInitalDelay

(

long long

maxInactivityDurationInitalDelay

)

Sets the Max inactivity initial delay duration value.

Parameters

maxInactivityDurationInitalDelay

- time before the inactivity delay is checked.

setProperties()

virtual void activemq::commands::WireFormatInfo::setProperties ( const util::PrimitiveMap &  map )

inlinevirtual

Sets the Properties for this Command.

Parameters

map	- PrimtiveMap to copy

References decaf::util::StlMap< K, V, COMPARATOR >::copy().

setSizePrefixDisabled()

void activemq::commands::WireFormatInfo::setSizePrefixDisabled

(

bool

sizePrefixDisabled

)

Sets if the sizePrefixDisabled flag is on.

Parameters

sizePrefixDisabled

- true to turn flag is on

setStackTraceEnabled()

void activemq::commands::WireFormatInfo::setStackTraceEnabled

(

bool

stackTraceEnabled

)

Sets if the stackTraceEnabled flag is on.

Parameters

stackTraceEnabled

- ture to turn flag is on

setTcpNoDelayEnabled()

void activemq::commands::WireFormatInfo::setTcpNoDelayEnabled

(

bool

tcpNoDelayEnabled

)

Sets if the tcpNoDelayEnabled flag is on.

Parameters

tcpNoDelayEnabled

- ture to turn flag is on

setTightEncodingEnabled()

void activemq::commands::WireFormatInfo::setTightEncodingEnabled

(

bool

tightEncodingEnabled

)

Sets if the tightEncodingEnabled flag is on.

Parameters

tightEncodingEnabled

- true to turn flag is on

setVersion()

void activemq::commands::WireFormatInfo::setVersion ( int  version )

inline

Set the current Wireformat Version.

Parameters

version

- int that identifies the version

toString()

virtual std::string activemq::commands::WireFormatInfo::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::BaseCommand.

visit()

virtual decaf::lang::Pointer< commands::Command > activemq::commands::WireFormatInfo::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

ID_WIREFORMATINFO

const unsigned char activemq::commands::WireFormatInfo::ID_WIREFORMATINFO = 1

static

---

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

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