activemq::transport::IOTransport Class Reference

Implementation of the Transport interface that performs marshaling of commands to IO streams. More...

#include <src/main/activemq/transport/IOTransport.h>

Inheritance diagram for activemq::transport::IOTransport:

Public Member Functions
	IOTransport ()
	Default Constructor.
	IOTransport (const Pointer< wireformat::WireFormat > wireFormat)
	Create an instance of this Transport and assign its WireFormat instance at creation time.
virtual	~IOTransport ()
virtual void	setInputStream (decaf::io::DataInputStream *is)
	Sets the stream from which this Transport implementation will read its data.
virtual void	setOutputStream (decaf::io::DataOutputStream *os)
	Sets the stream to which this Transport implementation will write its data.
virtual void	oneway (const Pointer< Command > command)
	Sends a one-way command.
virtual Pointer< FutureResponse >	asyncRequest (const Pointer< Command > command, const Pointer< ResponseCallback > responseCallback)
	Sends a commands asynchronously, returning a FutureResponse object that the caller can use to check to find out the response from the broker. Parameters command The Command object that is to sent out. responseCallback A callback object that will be notified once a response to the command is received. Returns A FutureResponse instance that can be queried for the Response to the Command. Exceptions IOException if an exception occurs during the read of the command. UnsupportedOperationException if this method is not implemented by this transport.
virtual Pointer< Response >	request (const Pointer< Command > command)
	Sends the given command to the broker and then waits for the response. Parameters command the command to be sent. Returns the response from the broker. Exceptions IOException if an exception occurs during the read of the command. UnsupportedOperationException if this method is not implemented by this transport.
virtual Pointer< Response >	request (const Pointer< Command > command, unsigned int timeout)
	Sends the given command to the broker and then waits for the response. Parameters command The command to be sent. timeout The time to wait for this response. Returns the response from the broker. Exceptions IOException if an exception occurs during the read of the command. UnsupportedOperationException if this method is not implemented by this transport.
virtual Pointer< wireformat::WireFormat >	getWireFormat () const
	Gets the WireFormat instance that is in use by this transport.
virtual void	setWireFormat (const Pointer< wireformat::WireFormat > wireFormat)
	Sets the WireFormat instance to use.
virtual void	setTransportListener (TransportListener *listener)
	Sets the observer of asynchronous events from this transport.
virtual TransportListener *	getTransportListener () const
	Gets the observer of asynchronous events from this transport.
virtual void	start ()
	Starts the Transport, the send methods of a Transport will throw an exception if used before the Transport is started.
virtual void	stop ()
	Stops the Transport.
virtual void	close ()
	Closes this object and deallocates the appropriate resources.
virtual Transport *	narrow (const std::type_info &typeId)
	Narrows down a Chain of Transports to a specific Transport to allow a higher level transport to skip intermediate Transports in certain circumstances.
virtual bool	isFaultTolerant () const
	Is this Transport fault tolerant, meaning that it will reconnect to a broker on disconnect.
virtual bool	isConnected () const
	Is the Transport Connected to its Broker.
virtual bool	isClosed () const
	Has the Transport been shutdown and no longer usable.
virtual std::string	getRemoteAddress () const
virtual bool	isReconnectSupported () const
virtual bool	isUpdateURIsSupported () const
virtual void	updateURIs (bool rebalance AMQCPP_UNUSED, const decaf::util::List< decaf::net::URI > &uris AMQCPP_UNUSED)
virtual void	reconnect (const decaf::net::URI &uri AMQCPP_UNUSED)
virtual void	run ()
	Run method - called by the Thread class in the context of the thread.
Public Member Functions inherited from activemq::transport::Transport
virtual	~Transport ()
virtual void	start ()=0
	Starts the Transport, the send methods of a Transport will throw an exception if used before the Transport is started.
virtual void	stop ()=0
	Stops the Transport.
virtual void	oneway (const Pointer< Command > command)=0
	Sends a one-way command.
virtual Pointer< FutureResponse >	asyncRequest (const Pointer< Command > command, const Pointer< ResponseCallback > responseCallback)=0
	Sends a commands asynchronously, returning a FutureResponse object that the caller can use to check to find out the response from the broker.
virtual Pointer< Response >	request (const Pointer< Command > command)=0
	Sends the given command to the broker and then waits for the response.
virtual Pointer< Response >	request (const Pointer< Command > command, unsigned int timeout)=0
	Sends the given command to the broker and then waits for the response.
virtual Pointer< wireformat::WireFormat >	getWireFormat () const =0
	Gets the WireFormat instance that is in use by this transport.
virtual void	setWireFormat (const Pointer< wireformat::WireFormat > wireFormat)=0
	Sets the WireFormat instance to use.
virtual void	setTransportListener (TransportListener *listener)=0
	Sets the observer of asynchronous events from this transport.
virtual TransportListener *	getTransportListener () const =0
	Gets the observer of asynchronous events from this transport.
virtual Transport *	narrow (const std::type_info &typeId)=0
	Narrows down a Chain of Transports to a specific Transport to allow a higher level transport to skip intermediate Transports in certain circumstances.
virtual bool	isFaultTolerant () const =0
	Is this Transport fault tolerant, meaning that it will reconnect to a broker on disconnect.
virtual bool	isConnected () const =0
	Is the Transport Connected to its Broker.
virtual bool	isClosed () const =0
	Has the Transport been shutdown and no longer usable.
virtual bool	isReconnectSupported () const =0
virtual bool	isUpdateURIsSupported () const =0
virtual std::string	getRemoteAddress () const =0
virtual void	reconnect (const decaf::net::URI &uri)=0
	reconnect to another location
virtual void	updateURIs (bool rebalance, const decaf::util::List< decaf::net::URI > &uris)=0
	Updates the set of URIs the Transport can connect to.
Public Member Functions inherited from activemq::util::Service
virtual	~Service ()
virtual void	start ()=0
virtual void	stop ()=0
Public Member Functions inherited from decaf::io::Closeable
virtual	~Closeable ()
virtual void	close ()=0
	Closes this object and deallocates the appropriate resources.
Public Member Functions inherited from decaf::lang::Runnable
virtual	~Runnable ()
virtual void	run ()=0
	Run method - called by the Thread class in the context of the thread.

Detailed Description

Implementation of the Transport interface that performs marshaling of commands to IO streams.

This class does not implement the Transport::request method, it only handles oneway messages. A thread polls on the input stream for in-coming commands. When a command is received, the command listener is notified. The polling thread is not started until the start method is called. Polling can be suspending by calling stop; however, because the read operation is blocking the transport my still pull one command off the wire even after the stop method has been called.

The close method will close the associated streams. Close can be called explicitly by the user, but is also called in the destructor. Once this object has been closed, it cannot be restarted.

Constructor & Destructor Documentation

IOTransport() [1/2]

activemq::transport::IOTransport::IOTransport

(

)

Default Constructor.

IOTransport() [2/2]

activemq::transport::IOTransport::IOTransport

(

const Pointer< wireformat::WireFormat >

wireFormat

)

Create an instance of this Transport and assign its WireFormat instance at creation time.

Parameters

wireFormat

Data encoder / decoder to use when reading and writing.

~IOTransport()

virtual activemq::transport::IOTransport::~IOTransport ( )

virtual

Member Function Documentation

asyncRequest()

virtual Pointer< FutureResponse > activemq::transport::IOTransport::asyncRequest ( const Pointer< Command >  command, const Pointer< ResponseCallback >  responseCallback  )

virtual

Sends a commands asynchronously, returning a FutureResponse object that the caller can use to check to find out the response from the broker.

Parameters

command	The Command object that is to sent out.
responseCallback	A callback object that will be notified once a response to the command is received.

Returns

A FutureResponse instance that can be queried for the Response to the Command.

Exceptions

IOException	if an exception occurs during the read of the command.
UnsupportedOperationException	if this method is not implemented by this transport.

This method always thrown an UnsupportedOperationException.

Implements activemq::transport::Transport.

close()

virtual void activemq::transport::IOTransport::close ( )

virtual

Closes this object and deallocates the appropriate resources.

The object is generally no longer usable after calling close.

Exceptions

IOException

if an error occurs while closing.

Implements decaf::io::Closeable.

getRemoteAddress()

virtual std::string activemq::transport::IOTransport::getRemoteAddress ( ) const

inlinevirtual

Returns

the remote address for this connection

Implements activemq::transport::Transport.

getTransportListener()

virtual TransportListener * activemq::transport::IOTransport::getTransportListener ( ) const

virtual

Gets the observer of asynchronous events from this transport.

Returns

the listener of transport events.

Implements activemq::transport::Transport.

getWireFormat()

virtual Pointer< wireformat::WireFormat > activemq::transport::IOTransport::getWireFormat ( ) const

virtual

Gets the WireFormat instance that is in use by this transport.

In the case of nested transport this method delegates down to the lowest level transport that actually maintains a WireFormat info instance.

Returns

The WireFormat the object used to encode / decode commands.

Implements activemq::transport::Transport.

isClosed()

virtual bool activemq::transport::IOTransport::isClosed ( ) const

virtual

Has the Transport been shutdown and no longer usable.

Returns

true if the Transport

Implements activemq::transport::Transport.

isConnected()

virtual bool activemq::transport::IOTransport::isConnected ( ) const

virtual

Is the Transport Connected to its Broker.

Returns

true if a connection has been made.

Implements activemq::transport::Transport.

isFaultTolerant()

virtual bool activemq::transport::IOTransport::isFaultTolerant ( ) const

inlinevirtual

Is this Transport fault tolerant, meaning that it will reconnect to a broker on disconnect.

Returns

true if the Transport is fault tolerant.

Implements activemq::transport::Transport.

isReconnectSupported()

virtual bool activemq::transport::IOTransport::isReconnectSupported ( ) const

inlinevirtual

Returns

true if reconnect is supported.

Implements activemq::transport::Transport.

isUpdateURIsSupported()

virtual bool activemq::transport::IOTransport::isUpdateURIsSupported ( ) const

inlinevirtual

Returns

true if updating uris is supported.

Implements activemq::transport::Transport.

narrow()

virtual Transport * activemq::transport::IOTransport::narrow ( const std::type_info &  typeId )

inlinevirtual

Narrows down a Chain of Transports to a specific Transport to allow a higher level transport to skip intermediate Transports in certain circumstances.

Parameters

typeId

- The type_info of the Object we are searching for.

Returns

the requested Object. or NULL if its not in this chain.

Implements activemq::transport::Transport.

References NULL.

oneway()

virtual void activemq::transport::IOTransport::oneway ( const Pointer< Command >  command )

virtual

Sends a one-way command.

Does not wait for any response from the broker.

Parameters

command

The command to be sent.

Exceptions

IOException	if an exception occurs during writing of the command.
UnsupportedOperationException	if this method is not implemented by this transport.

Implements activemq::transport::Transport.

reconnect()

virtual void activemq::transport::IOTransport::reconnect ( const decaf::net::URI &uri  AMQCPP_UNUSED )

inlinevirtual

This method does nothing in this subclass.

request() [1/2]

virtual Pointer< Response > activemq::transport::IOTransport::request ( const Pointer< Command >  command )

virtual

Sends the given command to the broker and then waits for the response.

Parameters

command

the command to be sent.

Returns

the response from the broker.

Exceptions

IOException	if an exception occurs during the read of the command.
UnsupportedOperationException	if this method is not implemented by this transport.

This method always thrown an UnsupportedOperationException.

Implements activemq::transport::Transport.

request() [2/2]

virtual Pointer< Response > activemq::transport::IOTransport::request ( const Pointer< Command >  command, unsigned int  timeout  )

virtual

Sends the given command to the broker and then waits for the response.

Parameters

command	The command to be sent.
timeout	The time to wait for this response.

Returns

the response from the broker.

Exceptions

IOException	if an exception occurs during the read of the command.
UnsupportedOperationException	if this method is not implemented by this transport.

This method always thrown an UnsupportedOperationException.

Implements activemq::transport::Transport.

run()

virtual void activemq::transport::IOTransport::run ( )

virtual

Run method - called by the Thread class in the context of the thread.

Implements decaf::lang::Runnable.

setInputStream()

virtual void activemq::transport::IOTransport::setInputStream ( decaf::io::DataInputStream *  is )

virtual

Sets the stream from which this Transport implementation will read its data.

Parameters

is	The InputStream that will be read from by this object.

setOutputStream()

virtual void activemq::transport::IOTransport::setOutputStream ( decaf::io::DataOutputStream *  os )

virtual

Sets the stream to which this Transport implementation will write its data.

Parameters

os	The OuputStream that will be written to by this object.

setTransportListener()

virtual void activemq::transport::IOTransport::setTransportListener ( TransportListener *  listener )

virtual

Sets the observer of asynchronous events from this transport.

Parameters

listener

the listener of transport events.

Implements activemq::transport::Transport.

setWireFormat()

virtual void activemq::transport::IOTransport::setWireFormat ( const Pointer< wireformat::WireFormat >  wireFormat )

virtual

Sets the WireFormat instance to use.

Parameters

wireFormat

The WireFormat the object used to encode / decode commands.

Implements activemq::transport::Transport.

start()

virtual void activemq::transport::IOTransport::start ( )

virtual

Starts the Transport, the send methods of a Transport will throw an exception if used before the Transport is started.

Exceptions

IOException

if and error occurs while starting the Transport.

Implements activemq::transport::Transport.

stop()

virtual void activemq::transport::IOTransport::stop ( )

virtual

Stops the Transport.

Exceptions

IOException

if an error occurs while stopping the transport.

Implements activemq::transport::Transport.

updateURIs()

virtual void activemq::transport::IOTransport::updateURIs ( bool rebalance  AMQCPP_UNUSED, const decaf::util::List< decaf::net::URI > &uris  AMQCPP_UNUSED  )

inlinevirtual

---

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

• src/main/activemq/transport/IOTransport.h