activemq-cpp-3.6.0
activemq::transport::logging::LoggingTransport Class Reference

A transport filter that logs commands as they are sent/received. More...

#include <src/main/activemq/transport/logging/LoggingTransport.h>

Inheritance diagram for activemq::transport::logging::LoggingTransport:

Public Member Functions

 LoggingTransport (const Pointer< Transport > next)
 Constructor.
virtual ~LoggingTransport ()
virtual void onCommand (const Pointer< Command > command)
 Event handler for the receipt of a command.
virtual void oneway (const Pointer< Command > command)
 Sends a one-way command.
virtual Pointer< Responserequest (const Pointer< Command > command)
 Sends the given command to the broker and then waits for the response.
Parameters
commandthe command to be sent.
Returns
the response from the broker.
Exceptions
IOExceptionif an exception occurs during the read of the command.
UnsupportedOperationExceptionif this method is not implemented by this transport.

virtual Pointer< Responserequest (const Pointer< Command > command, unsigned int timeout)
 Sends the given command to the broker and then waits for the response.
Parameters
commandThe command to be sent.
timeoutThe time to wait for this response.
Returns
the response from the broker.
Exceptions
IOExceptionif an exception occurs during the read of the command.
UnsupportedOperationExceptionif this method is not implemented by this transport.

- Public Member Functions inherited from activemq::transport::TransportFilter
 TransportFilter (const Pointer< Transport > next)
 Constructor.
virtual ~TransportFilter ()
void start ()
 Starts the Transport, the send methods of a Transport will throw an exception if used before the Transport is started.
void stop ()
 Stops the Transport.
void close ()
 Closes this object and deallocates the appropriate resources.
virtual void onException (const decaf::lang::Exception &ex)
 Event handler for an exception from a command transport.
virtual void transportInterrupted ()
 The transport has suffered an interruption from which it hopes to recover.
virtual void transportResumed ()
 The transport has resumed after an interruption.
virtual Pointer< FutureResponseasyncRequest (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.
virtual void setTransportListener (TransportListener *listener)
 Sets the observer of asynchronous events from this transport.
virtual TransportListenergetTransportListener () const
 Gets the observer of asynchronous events from 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 Transportnarrow (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 isReconnectSupported () const
virtual bool isUpdateURIsSupported () const
virtual bool isClosed () const
 Has the Transport been shutdown and no longer usable.
virtual std::string getRemoteAddress () const
virtual void reconnect (const decaf::net::URI &uri)
 reconnect to another location
virtual void updateURIs (bool rebalance, const decaf::util::List< decaf::net::URI > &uris)
 Updates the set of URIs the Transport can connect to.
- Public Member Functions inherited from activemq::transport::Transport
virtual ~Transport ()
- Public Member Functions inherited from decaf::io::Closeable
virtual ~Closeable ()
- Public Member Functions inherited from activemq::transport::TransportListener
virtual ~TransportListener ()

Additional Inherited Members

- Protected Member Functions inherited from activemq::transport::TransportFilter
void checkClosed () const
 Throws an IOException if this filter chain has already been closed.
virtual void beforeNextIsStarted ()
 Subclasses can override this method to do their own startup work.
virtual void afterNextIsStarted ()
 Subclasses can override this method to do their own post startup work.
virtual void beforeNextIsStopped ()
 Subclasses can override this method to do their own pre-stop work.
virtual void afterNextIsStopped ()
 Subclasses can override this method to do their own stop work.
virtual void doClose ()
 Subclasses can override this method to do their own close work.
- Protected Attributes inherited from activemq::transport::TransportFilter
Pointer< Transportnext
 The transport that this filter wraps around.
TransportListenerlistener
 Listener of this transport.

Detailed Description

A transport filter that logs commands as they are sent/received.

Constructor & Destructor Documentation

activemq::transport::logging::LoggingTransport::LoggingTransport ( const Pointer< Transport next)

Constructor.

Parameters
next- the next Transport in the chain
virtual activemq::transport::logging::LoggingTransport::~LoggingTransport ( )
inlinevirtual

Member Function Documentation

virtual void activemq::transport::logging::LoggingTransport::onCommand ( const Pointer< Command command)
virtual

Event handler for the receipt of a command.

Parameters
command- the received command object.

Reimplemented from activemq::transport::TransportFilter.

virtual void activemq::transport::logging::LoggingTransport::oneway ( const Pointer< Command command)
virtual

Sends a one-way command.

Does not wait for any response from the broker.

Parameters
commandThe command to be sent.
Exceptions
IOExceptionif an exception occurs during writing of the command.
UnsupportedOperationExceptionif this method is not implemented by this transport.

Reimplemented from activemq::transport::TransportFilter.

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

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

Parameters
commandthe command to be sent.
Returns
the response from the broker.
Exceptions
IOExceptionif an exception occurs during the read of the command.
UnsupportedOperationExceptionif this method is not implemented by this transport.

Not supported by this class - throws an exception.

Reimplemented from activemq::transport::TransportFilter.

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

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

Parameters
commandThe command to be sent.
timeoutThe time to wait for this response.
Returns
the response from the broker.
Exceptions
IOExceptionif an exception occurs during the read of the command.
UnsupportedOperationExceptionif this method is not implemented by this transport.

Not supported by this class - throws an exception.

Reimplemented from activemq::transport::TransportFilter.


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