activemq::commands::ProducerInfo Class Reference

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

Inheritance diagram for activemq::commands::ProducerInfo:

Public Member Functions
	ProducerInfo ()
virtual	~ProducerInfo ()
virtual unsigned char	getDataStructureType () const
	Get the DataStructure Type as defined in CommandTypes.h.
virtual ProducerInfo *	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.
Pointer< RemoveInfo >	createRemoveCommand () const
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 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 bool	isDispatchAsync () const
virtual void	setDispatchAsync (bool dispatchAsync)
virtual int	getWindowSize () const
virtual void	setWindowSize (int windowSize)
virtual bool	isProducerInfo () 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.
Static Public Attributes
static const unsigned char	ID_PRODUCERINFO = 6
Protected Attributes
Pointer< ProducerId >	producerId
Pointer< ActiveMQDestination >	destination
std::vector < decaf::lang::Pointer < BrokerId > >	brokerPath
bool	dispatchAsync
int	windowSize

---

Constructor & Destructor Documentation

activemq::commands::ProducerInfo::ProducerInfo

(

)

virtual activemq::commands::ProducerInfo::~ProducerInfo

(

)

[virtual]

---

Member Function Documentation

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

virtual void activemq::commands::ProducerInfo::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.

Pointer<RemoveInfo> activemq::commands::ProducerInfo::createRemoveCommand

(

)

const

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

virtual const std::vector< decaf::lang::Pointer<BrokerId> >& activemq::commands::ProducerInfo::getBrokerPath

(

)

const [virtual]

virtual std::vector< decaf::lang::Pointer<BrokerId> >& activemq::commands::ProducerInfo::getBrokerPath

(

)

[virtual]

virtual unsigned char activemq::commands::ProducerInfo::getDataStructureType

(

)

const [virtual]

Get the DataStructure Type as defined in CommandTypes.h.

Returns:

The type of the data structure

Implements activemq::commands::DataStructure.

virtual const Pointer<ActiveMQDestination>& activemq::commands::ProducerInfo::getDestination

(

)

const [virtual]

virtual Pointer<ActiveMQDestination>& activemq::commands::ProducerInfo::getDestination

(

)

[virtual]

virtual Pointer<ProducerId>& activemq::commands::ProducerInfo::getProducerId

(

)

[virtual]

virtual const Pointer<ProducerId>& activemq::commands::ProducerInfo::getProducerId

(

)

const [virtual]

virtual int activemq::commands::ProducerInfo::getWindowSize

(

)

const [virtual]

virtual bool activemq::commands::ProducerInfo::isDispatchAsync

(

)

const [virtual]

virtual bool activemq::commands::ProducerInfo::isProducerInfo

(

)

const [inline, virtual]

Returns:

an answer of true to the isProducerInfo() query.

Reimplemented from activemq::commands::BaseCommand.

virtual void activemq::commands::ProducerInfo::setBrokerPath

(

const std::vector< decaf::lang::Pointer< BrokerId > > &

brokerPath

)

[virtual]

virtual void activemq::commands::ProducerInfo::setDestination

(

const Pointer< ActiveMQDestination > &

destination

)

[virtual]

virtual void activemq::commands::ProducerInfo::setDispatchAsync

(

bool

dispatchAsync

)

[virtual]

virtual void activemq::commands::ProducerInfo::setProducerId

(

const Pointer< ProducerId > &

producerId

)

[virtual]

virtual void activemq::commands::ProducerInfo::setWindowSize

(

int

windowSize

)

[virtual]

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

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

std::vector< decaf::lang::Pointer<BrokerId> > activemq::commands::ProducerInfo::brokerPath [protected]

Pointer<ActiveMQDestination> activemq::commands::ProducerInfo::destination [protected]

bool activemq::commands::ProducerInfo::dispatchAsync [protected]

const unsigned char activemq::commands::ProducerInfo::ID_PRODUCERINFO = 6 [static]

Pointer<ProducerId> activemq::commands::ProducerInfo::producerId [protected]

int activemq::commands::ProducerInfo::windowSize [protected]

---

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

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