activemq::wireformat::stomp::StompWireFormat Class Reference

#include <src/main/activemq/wireformat/stomp/StompWireFormat.h>

Inheritance diagram for activemq::wireformat::stomp::StompWireFormat:

[legend]

Public Member Functions
	StompWireFormat ()
virtual	~StompWireFormat ()
virtual void	marshal (const Pointer< commands::Command > command, const activemq::transport::Transport *transport, decaf::io::DataOutputStream *out)
	Stream based marshaling of a Command, this method blocks until the entire Command has been written out to the output stream.
virtual Pointer < commands::Command >	unmarshal (const activemq::transport::Transport *transport, decaf::io::DataInputStream *in)
	Stream based un-marshaling, blocks on reads on the input stream until a complete command has been read and unmarshaled into the correct form.
virtual void	setVersion (int version AMQCPP_UNUSED)
	Set the Version.
virtual int	getVersion () const
	Get the Version.
std::string	getTopicPrefix () const
	Gets the prefix used to address Topics.
void	setTopicPrefix (const std::string &prefix)
	Sets the prefix used to address Topics.
std::string	getQueuePrefix () const
	Gets the prefix used to address Queues.
void	setQueuePrefix (const std::string &prefix)
	Sets the prefix used to address Queues.
std::string	getTempTopicPrefix () const
	Gets the prefix used to address Temporary Topics.
void	setTempTopicPrefix (const std::string &prefix)
	Sets the prefix used to address Temporary Topics.
std::string	getTempQueuePrefix () const
	Gets the prefix used to address Temporary Queues.
void	setTempQueuePrefix (const std::string &prefix)
	Sets the prefix used to address Temporary Queues.
virtual bool	inReceive () const
	Is there a Message being unmarshaled?
virtual bool	hasNegotiator () const
	Returns true if this WireFormat has a Negotiator that needs to wrap the Transport that uses it.
virtual Pointer < transport::Transport >	createNegotiator (const Pointer< transport::Transport > transport)
	If the Transport Provides a Negotiator this method will create and return a news instance of the Negotiator.

---

Constructor & Destructor Documentation

activemq::wireformat::stomp::StompWireFormat::StompWireFormat

(

)

virtual activemq::wireformat::stomp::StompWireFormat::~StompWireFormat

(

)

[virtual]

---

Member Function Documentation

virtual Pointer<transport::Transport> activemq::wireformat::stomp::StompWireFormat::createNegotiator

(

const Pointer< transport::Transport >

transport

)

[virtual]

If the Transport Provides a Negotiator this method will create and return a news instance of the Negotiator.

Returns:

new instance of a WireFormatNegotiator.

Exceptions:

UnsupportedOperationException

if the WireFormat doesn't have a Negotiator.

Implements activemq::wireformat::WireFormat.

std::string activemq::wireformat::stomp::StompWireFormat::getQueuePrefix

(

)

const

Gets the prefix used to address Queues.

Returns:

the string prefix used to address Queues.

std::string activemq::wireformat::stomp::StompWireFormat::getTempQueuePrefix

(

)

const

Gets the prefix used to address Temporary Queues.

Returns:

the string prefix used to address Temporary Queues.

std::string activemq::wireformat::stomp::StompWireFormat::getTempTopicPrefix

(

)

const

Gets the prefix used to address Temporary Topics.

Returns:

the string prefix used to address Temporary Topics.

std::string activemq::wireformat::stomp::StompWireFormat::getTopicPrefix

(

)

const

Gets the prefix used to address Topics.

Returns:

the string prefix used to address Topics.

virtual int activemq::wireformat::stomp::StompWireFormat::getVersion

(

)

const [inline, virtual]

Get the Version.

Returns:

the version of the wire format

Implements activemq::wireformat::WireFormat.

virtual bool activemq::wireformat::stomp::StompWireFormat::hasNegotiator

(

)

const [inline, virtual]

Returns true if this WireFormat has a Negotiator that needs to wrap the Transport that uses it.

Returns:

true if the WireFormat provides a Negotiator.

Implements activemq::wireformat::WireFormat.

virtual bool activemq::wireformat::stomp::StompWireFormat::inReceive

(

)

const [inline, virtual]

Is there a Message being unmarshaled?

Returns:

true while in the doUnmarshal method.

Implements activemq::wireformat::WireFormat.

virtual void activemq::wireformat::stomp::StompWireFormat::marshal	(	const Pointer< commands::Command >	command,
		const activemq::transport::Transport *	transport,
		decaf::io::DataOutputStream *	out
	)			[virtual]

Stream based marshaling of a Command, this method blocks until the entire Command has been written out to the output stream.

Parameters:

	command	The Command to Marshal to the output stream.
	transport	The Transport that initiated this marshal call.
	out	The output stream to write the command to.

Exceptions:

IOException

Implements activemq::wireformat::WireFormat.

void activemq::wireformat::stomp::StompWireFormat::setQueuePrefix

(

const std::string &

prefix

)

Sets the prefix used to address Queues.

Parameters:

prefix

The prefix to use.

void activemq::wireformat::stomp::StompWireFormat::setTempQueuePrefix

(

const std::string &

prefix

)

Sets the prefix used to address Temporary Queues.

Parameters:

prefix

The prefix to use.

void activemq::wireformat::stomp::StompWireFormat::setTempTopicPrefix

(

const std::string &

prefix

)

Sets the prefix used to address Temporary Topics.

Parameters:

prefix

The prefix to use.

void activemq::wireformat::stomp::StompWireFormat::setTopicPrefix

(

const std::string &

prefix

)

Sets the prefix used to address Topics.

Parameters:

prefix

The prefix to use.

virtual void activemq::wireformat::stomp::StompWireFormat::setVersion

(

int version

AMQCPP_UNUSED

)

[inline, virtual]

Set the Version.

Parameters:

the

version of the wire format

Implements activemq::wireformat::WireFormat.

virtual Pointer<commands::Command> activemq::wireformat::stomp::StompWireFormat::unmarshal	(	const activemq::transport::Transport *	transport,
		decaf::io::DataInputStream *	in
	)			[virtual]

Stream based un-marshaling, blocks on reads on the input stream until a complete command has been read and unmarshaled into the correct form.

Returns a Pointer to the newly unmarshaled Command.

Parameters:

	transport	- Pointer to the transport that is making this request.
	in	- the input stream to read the command from.

Returns:

the newly marshaled Command, caller owns the pointer

Exceptions:

IOException

Implements activemq::wireformat::WireFormat.

---

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

• src/main/activemq/wireformat/stomp/StompWireFormat.h