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

Inheritance diagram for activemq::commands::FlushCommand:

Public Member Functions
	FlushCommand ()

virtual	~FlushCommand ()

virtual unsigned char	getDataStructureType () const
	Get the DataStructure Type as defined in CommandTypes.h.

virtual FlushCommand *	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	isFlushCommand () 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.

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_FLUSHCOMMAND = 15

Constructor & Destructor Documentation

◆ FlushCommand()

activemq::commands::FlushCommand::FlushCommand ( )

◆ ~FlushCommand()

virtual activemq::commands::FlushCommand::~FlushCommand ( )

virtual

Member Function Documentation

◆ cloneDataStructure()

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

◆ getDataStructureType()

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

virtual

Get the DataStructure Type as defined in CommandTypes.h.

Returns: The type of the data structure

Implements activemq::commands::DataStructure.

◆ isFlushCommand()

virtual bool activemq::commands::FlushCommand::isFlushCommand ( ) const

inlinevirtual

Returns: an answer of true to the isFlushCommand() query.

Reimplemented from activemq::commands::BaseCommand.

◆ toString()

virtual std::string activemq::commands::FlushCommand::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 Pointer< Command > activemq::commands::FlushCommand::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_FLUSHCOMMAND

const unsigned char activemq::commands::FlushCommand::ID_FLUSHCOMMAND = 15

static

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

src/main/activemq/commands/FlushCommand.h

Public Member Functions

Static Public Attributes

Constructor & Destructor Documentation

◆ FlushCommand()

◆ ~FlushCommand()

Member Function Documentation

◆ cloneDataStructure()

◆ copyDataStructure()

◆ equals()

◆ getDataStructureType()

◆ isFlushCommand()

◆ toString()

◆ visit()

Field Documentation

◆ ID_FLUSHCOMMAND