Added: incubator/activemq/site/cms/html/classactivemq_1_1network_1_1_tcp_socket.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1network_1_1_tcp_socket.html?rev=428212&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classactivemq_1_1network_1_1_tcp_socket.html (added) +++ incubator/activemq/site/cms/html/classactivemq_1_1network_1_1_tcp_socket.html Wed Aug 2 19:24:43 2006 @@ -0,0 +1,617 @@ + + +activemq-cpp: activemq::network::TcpSocket Class Reference + + + + +
+
+
+
+ +

activemq::network::TcpSocket Class Reference

#include <TcpSocket.h> +

+List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

 TcpSocket ()
 TcpSocket (SocketHandle socketHandle)
virtual ~TcpSocket ()
SocketHandle getSocketHandle ()
virtual void connect (const char *host, const int port) throw ( SocketException )
virtual bool isConnected () const
virtual io::InputStreamgetInputStream ()
virtual io::OutputStreamgetOutputStream ()
virtual int getSoLinger () const throw ( SocketException )
virtual void setSoLinger (const int linger) throw ( SocketException )
virtual bool getKeepAlive () const throw ( SocketException )
virtual void setKeepAlive (const bool keepAlive) throw ( SocketException )
virtual int getReceiveBufferSize () const throw ( SocketException )
virtual void setReceiveBufferSize (const int size) throw ( SocketException )
virtual bool getReuseAddress () const throw ( SocketException )
virtual void setReuseAddress (const bool reuse) throw ( SocketException )
virtual int getSendBufferSize () const throw ( SocketException )
virtual void setSendBufferSize (const int size) throw ( SocketException )
virtual int getSoTimeout () const throw ( SocketException )
virtual void setSoTimeout (const int timeout) throw (SocketException)
virtual void close () throw ( cms::CMSException )
+


Detailed Description

+Platform-independent implementation of the socket interface. +

+


Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
TcpSocket::TcpSocket (  ) 
+
+
+ +

+Construct a non-connected socket. +

+

+ +

+
+ + + + + + + + + +
TcpSocket::TcpSocket (SocketHandle  socketHandle  ) 
+
+
+ +

+Construct a connected or bound socket based on given socket handle.

Parameters:
+ + +
socketHandle a socket handle to wrap in the object
+
+ +
+

+ +

+
+ + + + + + + + +
TcpSocket::~TcpSocket (  )  [virtual]
+
+
+ +

+Destruct. Releases the socket handle but not gracefully shut down the connection. +

+

+


Member Function Documentation

+ +
+
+ + + + + + + + +
void TcpSocket::close (  )  throw ( cms::CMSException ) [virtual]
+
+
+ +

+Closes this object and deallocates the appropriate resources.

Exceptions:
+ + +
CMSException 
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void TcpSocket::connect (const char *  host,
const int  port 
) throw ( SocketException ) [virtual]
+
+
+ +

+Connects to the specified destination. Closes this socket if connected to another destination.

Parameters:
+ + + +
host The host of the server to connect to.
port The port of the server to connect to.
+
+
Exceptions:
+ + +
IOException Thrown if a failure occurred in the connect.
+
+ +
+

+ +

+
+ + + + + + + + +
InputStream * TcpSocket::getInputStream (  )  [virtual]
+
+
+ +

+Gets the InputStream for this socket.

Returns:
The InputStream for this socket. NULL if not connected.
+ +
+

+ +

+
+ + + + + + + + +
bool TcpSocket::getKeepAlive (  )  const throw ( SocketException ) [virtual]
+
+
+ +

+Gets the keep alive flag.

Returns:
True if keep alive is enabled.
+
Exceptions:
+ + +
SocketException if the operation fails.
+
+ +
+

+ +

+
+ + + + + + + + +
OutputStream * TcpSocket::getOutputStream (  )  [virtual]
+
+
+ +

+Gets the OutputStream for this socket.

Returns:
the OutputStream for this socket. NULL if not connected.
+ +
+

+ +

+
+ + + + + + + + +
int TcpSocket::getReceiveBufferSize (  )  const throw ( SocketException ) [virtual]
+
+
+ +

+Gets the receive buffer size.

Returns:
the receive buffer size in bytes.
+
Exceptions:
+ + +
SocketException if the operation fails.
+
+ +
+

+ +

+
+ + + + + + + + +
bool TcpSocket::getReuseAddress (  )  const throw ( SocketException ) [virtual]
+
+
+ +

+Gets the reuse address flag.

Returns:
True if the address can be reused.
+
Exceptions:
+ + +
SocketException if the operation fails.
+
+ +
+

+ +

+
+ + + + + + + + +
int TcpSocket::getSendBufferSize (  )  const throw ( SocketException ) [virtual]
+
+
+ +

+Gets the send buffer size.

Returns:
the size in bytes of the send buffer.
+
Exceptions:
+ + +
SocketException if the operation fails.
+
+ +
+

+ +

+
+ + + + + + + + +
SocketHandle activemq::network::TcpSocket::getSocketHandle (  )  [inline]
+
+
+ +

+Gets the handle for the socket.

Returns:
SocketHabler for this Socket, can be NULL
+ +
+

+ +

+
+ + + + + + + + +
int TcpSocket::getSoLinger (  )  const throw ( SocketException ) [virtual]
+
+
+ +

+Gets the linger time.

Returns:
The linger time in seconds.
+
Exceptions:
+ + +
SocketException if the operation fails.
+
+ +
+

+ +

+
+ + + + + + + + +
int TcpSocket::getSoTimeout (  )  const throw ( SocketException ) [virtual]
+
+
+ +

+Gets the timeout for socket operations.

Returns:
The timeout in milliseconds for socket operations.
+
Exceptions:
+ + +
SocketException Thrown if unable to retrieve the information.
+
+ +
+

+ +

+
+ + + + + + + + +
virtual bool activemq::network::TcpSocket::isConnected (  )  const [inline, virtual]
+
+
+ +

+Indicates whether or not this socket is connected to a destination.

Returns:
true if connected
+ +
+

+ +

+
+ + + + + + + + + +
void TcpSocket::setKeepAlive (const bool  keepAlive  )  throw ( SocketException ) [virtual]
+
+
+ +

+Enables/disables the keep alive flag.

Parameters:
+ + +
keepAlive If true, enables the flag.
+
+
Exceptions:
+ + +
SocketException if the operation fails.
+
+ +
+

+ +

+
+ + + + + + + + + +
void TcpSocket::setReceiveBufferSize (const int  size  )  throw ( SocketException ) [virtual]
+
+
+ +

+Sets the recieve buffer size.

Parameters:
+ + +
size Number of bytes to set the receive buffer to.
+
+
Exceptions:
+ + +
SocketException if the operation fails.
+
+ +
+

+ +

+
+ + + + + + + + + +
void TcpSocket::setReuseAddress (const bool  reuse  )  throw ( SocketException ) [virtual]
+
+
+ +

+Sets the reuse address flag.

Parameters:
+ + +
reuse If true, sets the flag.
+
+
Exceptions:
+ + +
SocketException if the operation fails.
+
+ +
+

+ +

+
+ + + + + + + + + +
void TcpSocket::setSendBufferSize (const int  size  )  throw ( SocketException ) [virtual]
+
+
+ +

+Sets the send buffer size.

Parameters:
+ + +
size The number of bytes to set the send buffer to.
+
+
Exceptions:
+ + +
SocketException if the operation fails.
+
+ +
+

+ +

+
+ + + + + + + + + +
void TcpSocket::setSoLinger (const int  linger  )  throw ( SocketException ) [virtual]
+
+
+ +

+Sets the linger time.

Parameters:
+ + +
linger The linger time in seconds. If 0, linger is off.
+
+
Exceptions:
+ + +
SocketException if the operation fails.
+
+ +
+

+ +

+
+ + + + + + + + + +
void TcpSocket::setSoTimeout (const int  timeout  )  throw (SocketException) [virtual]
+
+
+ +

+Sets the timeout for socket operations.

Parameters:
+ + +
timeout The timeout in milliseconds for socket operations.
+
+
Exceptions:
+ + +
SocketException Thrown if unable to set the information.
+
+ +
+

+


The documentation for this class was generated from the following files: +
Generated on Tue Aug 1 09:18:15 2006 for activemq-cpp by  + +doxygen 1.4.7
+ + Added: incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_broker_error-members.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_broker_error-members.html?rev=428212&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_broker_error-members.html (added) +++ incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_broker_error-members.html Wed Aug 2 19:24:43 2006 @@ -0,0 +1,29 @@ + + +activemq-cpp: Member List + + + + +
+
+
+
+

activemq::transport::BrokerError Member List

This is the complete list of members for activemq::transport::BrokerError, including all inherited members.

+ + + + + +
BrokerError()activemq::transport::BrokerError [inline]
BrokerError(const exceptions::ActiveMQException &ex)activemq::transport::BrokerError [inline]
BrokerError(const BrokerError &ex)activemq::transport::BrokerError [inline]
BrokerError(const char *file, const int lineNumber, const char *msg,...)activemq::transport::BrokerError [inline]
clone() const activemq::transport::BrokerError [inline, virtual]


Generated on Tue Aug 1 09:18:15 2006 for activemq-cpp by  + +doxygen 1.4.7
+ + Added: incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_broker_error.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_broker_error.html?rev=428212&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_broker_error.html (added) +++ incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_broker_error.html Wed Aug 2 19:24:43 2006 @@ -0,0 +1,185 @@ + + +activemq-cpp: activemq::transport::BrokerError Class Reference + + + + +
+
+
+
+ +

activemq::transport::BrokerError Class Reference

#include <BrokerError.h> +

+List of all members. + + + + + + + + + + + + +

Public Member Functions

 BrokerError ()
 BrokerError (const exceptions::ActiveMQException &ex)
 BrokerError (const BrokerError &ex)
 BrokerError (const char *file, const int lineNumber, const char *msg,...)
virtual exceptions::ActiveMQException * clone () const
+


Detailed Description

+A distributed exception that implies that an error occurred at the broker. +

+


Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
activemq::transport::BrokerError::BrokerError (  )  [inline]
+
+
+ +

+Default Constructor +

+

+ +

+
+ + + + + + + + + +
activemq::transport::BrokerError::BrokerError (const exceptions::ActiveMQException &  ex  )  [inline]
+
+
+ +

+Copy Constructor

Parameters:
+ + +
ex the exception to copy
+
+ +
+

+ +

+
+ + + + + + + + + +
activemq::transport::BrokerError::BrokerError (const BrokerError ex  )  [inline]
+
+
+ +

+Copy Constructor

Parameters:
+ + +
ex the exception to copy, which is an instance of this type
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
activemq::transport::BrokerError::BrokerError (const char *  file,
const int  lineNumber,
const char *  msg,
  ... 
) [inline]
+
+
+ +

+Consturctor

Parameters:
+ + + + +
file name of the file were the exception occured.
lineNumber line where the exception occured
msg the message that was generated
+
+ +
+

+


Member Function Documentation

+ +
+
+ + + + + + + + +
virtual exceptions::ActiveMQException* activemq::transport::BrokerError::clone (  )  const [inline, virtual]
+
+
+ +

+Clones this exception. This is useful for cases where you need to preserve the type of the original exception as well as the message. All subclasses should override.

Returns:
a cloned copy of this exception
+ +
+

+


The documentation for this class was generated from the following file: +
Generated on Tue Aug 1 09:18:15 2006 for activemq-cpp by  + +doxygen 1.4.7
+ + Added: incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_listener-members.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_listener-members.html?rev=428212&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_listener-members.html (added) +++ incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_listener-members.html Wed Aug 2 19:24:43 2006 @@ -0,0 +1,25 @@ + + +activemq-cpp: Member List + + + + +
+
+
+
+

activemq::transport::CommandListener Member List

This is the complete list of members for activemq::transport::CommandListener, including all inherited members.

+ +
onCommand(Command *command)=0activemq::transport::CommandListener [pure virtual]


Generated on Tue Aug 1 09:18:15 2006 for activemq-cpp by  + +doxygen 1.4.7
+ + Added: incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_listener.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_listener.html?rev=428212&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_listener.html (added) +++ incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_listener.html Wed Aug 2 19:24:43 2006 @@ -0,0 +1,74 @@ + + +activemq-cpp: activemq::transport::CommandListener Class Reference + + + + +
+
+
+
+ +

activemq::transport::CommandListener Class Reference

#include <CommandListener.h> +

+

Inheritance diagram for activemq::transport::CommandListener: +

+ +activemq::connector::stomp::StompConnector +activemq::transport::TransportFilter +activemq::transport::ResponseCorrelator +activemq::transport::TcpTransport + +List of all members. + + + + +

Public Member Functions

virtual void onCommand (Command *command)=0
+

Detailed Description

+Interface for an observer of broker commands. +

+


Member Function Documentation

+ +
+
+ + + + + + + + + +
virtual void activemq::transport::CommandListener::onCommand (Command *  command  )  [pure virtual]
+
+
+ +

+Event handler for the receipt of a command.

Parameters:
+ + +
command the received command object.
+
+ +

+Implemented in activemq::connector::stomp::StompConnector, activemq::transport::ResponseCorrelator, and activemq::transport::TransportFilter. +

+

+


The documentation for this class was generated from the following file: +
Generated on Tue Aug 1 09:18:15 2006 for activemq-cpp by  + +doxygen 1.4.7
+ + Added: incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_listener.png URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_listener.png?rev=428212&view=auto ============================================================================== Binary file - no diff available. Propchange: incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_listener.png ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_reader-members.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_reader-members.html?rev=428212&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_reader-members.html (added) +++ incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_reader-members.html Wed Aug 2 19:24:43 2006 @@ -0,0 +1,25 @@ + + +activemq-cpp: Member List + + + + +
+
+
+
+

activemq::transport::CommandReader Member List

This is the complete list of members for activemq::transport::CommandReader, including all inherited members.

+ +
readCommand(void)=0activemq::transport::CommandReader [pure virtual]


Generated on Tue Aug 1 09:18:15 2006 for activemq-cpp by  + +doxygen 1.4.7
+ + Added: incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_reader.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_reader.html?rev=428212&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_reader.html (added) +++ incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_reader.html Wed Aug 2 19:24:43 2006 @@ -0,0 +1,65 @@ + + +activemq-cpp: activemq::transport::CommandReader Class Reference + + + + +
+
+
+
+ +

activemq::transport::CommandReader Class Reference

#include <CommandReader.h> +

+List of all members. + + + + +

Public Member Functions

virtual Command * readCommand (void)=0 throw ( CommandIOException )
+


Detailed Description

+Interface for an object responsible for reading a command from an input stream. +

+


Member Function Documentation

+ +
+
+ + + + + + + + + +
virtual Command* activemq::transport::CommandReader::readCommand (void   )  throw ( CommandIOException ) [pure virtual]
+
+
+ +

+Reads a command from the given input stream.

Returns:
The next command available on the stream.
+
Exceptions:
+ + +
CommandIOException if a problem occurs during the read.
+
+ +
+

+


The documentation for this class was generated from the following file: +
Generated on Tue Aug 1 09:18:15 2006 for activemq-cpp by  + +doxygen 1.4.7
+ + Added: incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_writer-members.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_writer-members.html?rev=428212&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_writer-members.html (added) +++ incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_writer-members.html Wed Aug 2 19:24:43 2006 @@ -0,0 +1,25 @@ + + +activemq-cpp: Member List + + + + +
+
+
+
+

activemq::transport::CommandWriter Member List

This is the complete list of members for activemq::transport::CommandWriter, including all inherited members.

+ +
writeCommand(const Command *command)=0activemq::transport::CommandWriter [pure virtual]


Generated on Tue Aug 1 09:18:15 2006 for activemq-cpp by  + +doxygen 1.4.7
+ + Added: incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_writer.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_writer.html?rev=428212&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_writer.html (added) +++ incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_command_writer.html Wed Aug 2 19:24:43 2006 @@ -0,0 +1,69 @@ + + +activemq-cpp: activemq::transport::CommandWriter Class Reference + + + + +
+
+
+
+ +

activemq::transport::CommandWriter Class Reference

#include <CommandWriter.h> +

+List of all members. + + + + +

Public Member Functions

virtual void writeCommand (const Command *command)=0 throw ( CommandIOException )
+


Detailed Description

+Interface for an object responsible for writing a command to an output stream. +

+


Member Function Documentation

+ +
+
+ + + + + + + + + +
virtual void activemq::transport::CommandWriter::writeCommand (const Command *  command  )  throw ( CommandIOException ) [pure virtual]
+
+
+ +

+Writes a command to the given output stream.

Parameters:
+ + +
command the command to write.
+
+
Exceptions:
+ + +
CommandIOException if a problem occurs during the write.
+
+ +
+

+


The documentation for this class was generated from the following file: +
Generated on Tue Aug 1 09:18:15 2006 for activemq-cpp by  + +doxygen 1.4.7
+ + Added: incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_exception_response-members.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_exception_response-members.html?rev=428212&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_exception_response-members.html (added) +++ incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_exception_response-members.html Wed Aug 2 19:24:43 2006 @@ -0,0 +1,25 @@ + + +activemq-cpp: Member List + + + + +
+
+
+
+

activemq::transport::ExceptionResponse Member List

This is the complete list of members for activemq::transport::ExceptionResponse, including all inherited members.

+ +
getException() const =0activemq::transport::ExceptionResponse [pure virtual]


Generated on Tue Aug 1 09:18:15 2006 for activemq-cpp by  + +doxygen 1.4.7
+ + Added: incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_exception_response.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_exception_response.html?rev=428212&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_exception_response.html (added) +++ incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_exception_response.html Wed Aug 2 19:24:43 2006 @@ -0,0 +1,59 @@ + + +activemq-cpp: activemq::transport::ExceptionResponse Class Reference + + + + +
+
+
+
+ +

activemq::transport::ExceptionResponse Class Reference

#include <ExceptionResponse.h> +

+List of all members. + + + + +

Public Member Functions

virtual const BrokerErrorgetException () const =0
+


Detailed Description

+A response object that indicates an error occurred at the broker. +

+


Member Function Documentation

+ +
+
+ + + + + + + + +
virtual const BrokerError* activemq::transport::ExceptionResponse::getException (  )  const [pure virtual]
+
+
+ +

+Gets the error from the broker.

Returns:
the error provided from the broker
+ +
+

+


The documentation for this class was generated from the following file: +
Generated on Tue Aug 1 09:18:15 2006 for activemq-cpp by  + +doxygen 1.4.7
+ + Added: incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_future_response-members.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_future_response-members.html?rev=428212&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_future_response-members.html (added) +++ incubator/activemq/site/cms/html/classactivemq_1_1transport_1_1_future_response-members.html Wed Aug 2 19:24:43 2006 @@ -0,0 +1,32 @@ + + +activemq-cpp: Member List + + + + +
+
+
+
+

activemq::transport::FutureResponse Member List

This is the complete list of members for activemq::transport::FutureResponse, including all inherited members.

+ + + + + + + + +
getResponse() const activemq::transport::FutureResponse [inline, virtual]
lock()activemq::transport::FutureResponse [inline, virtual]
notify()activemq::transport::FutureResponse [inline, virtual]
notifyAll()activemq::transport::FutureResponse [inline, virtual]
setResponse(Response *response)activemq::transport::FutureResponse [inline, virtual]
unlock()activemq::transport::FutureResponse [inline, virtual]
wait()activemq::transport::FutureResponse [inline, virtual]
wait(unsigned long millisecs)activemq::transport::FutureResponse [inline, virtual]


Generated on Tue Aug 1 09:18:15 2006 for activemq-cpp by  + +doxygen 1.4.7
+ +