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

activemq::network::SocketInputStream Class Reference

#include <SocketInputStream.h> +

+

Inheritance diagram for activemq::network::SocketInputStream: +

+ +activemq::io::InputStream +cms::Closeable +activemq::concurrent::Synchronizable + +List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

 SocketInputStream (Socket::SocketHandle socket)
virtual ~SocketInputStream ()
virtual void setDebug (const bool debug)
virtual void lock () throw ( exceptions::ActiveMQException )
virtual void unlock () throw ( exceptions::ActiveMQException )
virtual void wait () throw ( exceptions::ActiveMQException )
virtual void wait (unsigned long millisecs) throw ( exceptions::ActiveMQException )
virtual void notify () throw ( exceptions::ActiveMQException )
virtual void notifyAll () throw ( exceptions::ActiveMQException )
virtual int available () const
virtual unsigned char read () throw ( io::IOException )
virtual int read (unsigned char *buffer, const int bufferSize) throw (io::IOException)
virtual void close () throw ( cms::CMSException )
+

Detailed Description

+Input stream for performing reads on a socket. +

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + +
SocketInputStream::SocketInputStream (Socket::SocketHandle  socket  ) 
+
+
+ +

+Constructor.

Parameters:
+ + +
socket the socket handle.
+
+ +
+

+ +

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

+Destructor. +

+

+

Member Function Documentation

+ +
+
+ + + + + + + + +
int SocketInputStream::available (  )  const [virtual]
+
+
+ +

+Polls instantaneously to see if data is available on the socket.

Returns:
1 if data is currently available on the socket, otherwise 0.
+ +

+Implements activemq::io::InputStream. +

+

+ +

+
+ + + + + + + + + +
virtual void activemq::network::SocketInputStream::close (void   )  throw ( cms::CMSException ) [inline, virtual]
+
+
+ +

+Close - does nothing. It is the responsibility of the owner of the socket object to close it.

Exceptions:
+ + +
CMSException 
+
+ +

+Implements cms::Closeable. +

+

+ +

+
+ + + + + + + + +
virtual void activemq::network::SocketInputStream::lock (  )  throw ( exceptions::ActiveMQException ) [inline, virtual]
+
+
+ +

+Locks the object.

Exceptions:
+ + +
ActiveMQException 
+
+ +

+Implements activemq::concurrent::Synchronizable. +

+

+ +

+
+ + + + + + + + +
virtual void activemq::network::SocketInputStream::notify (  )  throw ( exceptions::ActiveMQException ) [inline, virtual]
+
+
+ +

+Signals a waiter on this object that it can now wake up and continue. Must have this object locked before calling.

Exceptions:
+ + +
ActiveMQException 
+
+ +

+Implements activemq::concurrent::Synchronizable. +

+

+ +

+
+ + + + + + + + +
virtual void activemq::network::SocketInputStream::notifyAll (  )  throw ( exceptions::ActiveMQException ) [inline, virtual]
+
+
+ +

+Signals the waiters on this object that it can now wake up and continue. Must have this object locked before calling.

Exceptions:
+ + +
ActiveMQException 
+
+ +

+Implements activemq::concurrent::Synchronizable. +

+

+ +

+
+ + + + + + + + + + + + + + + + + + +
int SocketInputStream::read (unsigned char *  buffer,
const int  bufferSize 
) throw (io::IOException) [virtual]
+
+
+ +

+Reads an array of bytes from the buffer.

Parameters:
+ + + +
buffer (out) the target buffer.
bufferSize the size of the output buffer.
+
+
Returns:
The number of bytes read.
+
Exceptions:
+ + +
IOException thrown if an error occurs.
+
+ +

+Implements activemq::io::InputStream. +

+

+ +

+
+ + + + + + + + +
unsigned char SocketInputStream::read (  )  throw ( io::IOException ) [virtual]
+
+
+ +

+Reads a single byte from the buffer.

Returns:
The next byte.
+
Exceptions:
+ + +
IOException thrown if an error occurs.
+
+ +

+Implements activemq::io::InputStream. +

+

+ +

+
+ + + + + + + + + +
virtual void activemq::network::SocketInputStream::setDebug (const bool  debug  )  [inline, virtual]
+
+
+ +

+Enables socket level output of the recieved data

Parameters:
+ + +
debug true to turn on debugging
+
+ +
+

+ +

+
+ + + + + + + + +
virtual void activemq::network::SocketInputStream::unlock (  )  throw ( exceptions::ActiveMQException ) [inline, virtual]
+
+
+ +

+Unlocks the object.

Exceptions:
+ + +
ActiveMQException 
+
+ +

+Implements activemq::concurrent::Synchronizable. +

+

+ +

+
+ + + + + + + + + +
virtual void activemq::network::SocketInputStream::wait (unsigned long  millisecs  )  throw ( exceptions::ActiveMQException ) [inline, virtual]
+
+
+ +

+Waits on a signal from this object, which is generated by a call to Notify. Must have this object locked before calling. This wait will timeout after the specified time interval.

Parameters:
+ + +
millisecs time in millisecsonds to wait, or WAIT_INIFINITE
+
+
Exceptions:
+ + +
ActiveMQException 
+
+ +

+Implements activemq::concurrent::Synchronizable. +

+

+ +

+
+ + + + + + + + +
virtual void activemq::network::SocketInputStream::wait (  )  throw ( exceptions::ActiveMQException ) [inline, virtual]
+
+
+ +

+Waits on a signal from this object, which is generated by a call to Notify. Must have this object locked before calling.

Exceptions:
+ + +
ActiveMQException 
+
+ +

+Implements activemq::concurrent::Synchronizable. +

+

+

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_1network_1_1_socket_input_stream.png URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1network_1_1_socket_input_stream.png?rev=428212&view=auto ============================================================================== Binary file - no diff available. Propchange: incubator/activemq/site/cms/html/classactivemq_1_1network_1_1_socket_input_stream.png ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: incubator/activemq/site/cms/html/classactivemq_1_1network_1_1_socket_output_stream-members.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1network_1_1_socket_output_stream-members.html?rev=428212&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classactivemq_1_1network_1_1_socket_output_stream-members.html (added) +++ incubator/activemq/site/cms/html/classactivemq_1_1network_1_1_socket_output_stream-members.html Wed Aug 2 19:24:43 2006 @@ -0,0 +1,36 @@ + + +activemq-cpp: Member List + + + + +
+
+
+
+

activemq::network::SocketOutputStream Member List

This is the complete list of members for activemq::network::SocketOutputStream, including all inherited members.

+ + + + + + + + + + + + +
close()activemq::network::SocketOutputStream [inline, virtual]
flush()activemq::network::SocketOutputStream [inline, virtual]
lock()activemq::network::SocketOutputStream [inline, virtual]
notify()activemq::network::SocketOutputStream [inline, virtual]
notifyAll()activemq::network::SocketOutputStream [inline, virtual]
setDebug(const bool debug)activemq::network::SocketOutputStream [inline, virtual]
SocketOutputStream(Socket::SocketHandle socket)activemq::network::SocketOutputStream
unlock()activemq::network::SocketOutputStream [inline, virtual]
wait()activemq::network::SocketOutputStream [inline, virtual]
wait(unsigned long millisecs)activemq::network::SocketOutputStream [inline, virtual]
write(const unsigned char c)activemq::network::SocketOutputStream [virtual]
write(const unsigned char *buffer, const int len)activemq::network::SocketOutputStream [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_1network_1_1_socket_output_stream.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1network_1_1_socket_output_stream.html?rev=428212&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classactivemq_1_1network_1_1_socket_output_stream.html (added) +++ incubator/activemq/site/cms/html/classactivemq_1_1network_1_1_socket_output_stream.html Wed Aug 2 19:24:43 2006 @@ -0,0 +1,404 @@ + + +activemq-cpp: activemq::network::SocketOutputStream Class Reference + + + + +
+
+
+
+
+activemq::network::SocketOutputStream
+

activemq::network::SocketOutputStream Class Reference

#include <SocketOutputStream.h> +

+

Inheritance diagram for activemq::network::SocketOutputStream: +

+ +activemq::io::OutputStream +cms::Closeable +activemq::concurrent::Synchronizable + +List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

 SocketOutputStream (Socket::SocketHandle socket)
virtual void setDebug (const bool debug)
virtual void lock () throw ( exceptions::ActiveMQException )
virtual void unlock () throw ( exceptions::ActiveMQException )
virtual void wait () throw ( exceptions::ActiveMQException )
virtual void wait (unsigned long millisecs) throw ( exceptions::ActiveMQException )
virtual void notify () throw ( exceptions::ActiveMQException )
virtual void notifyAll () throw ( exceptions::ActiveMQException )
virtual void write (const unsigned char c) throw ( io::IOException )
virtual void write (const unsigned char *buffer, const int len) throw ( io::IOException )
virtual void flush () throw ( io::IOException )
virtual void close () throw ( cms::CMSException )
+

Detailed Description

+Output stream for performing write operations on a socket. +

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + +
SocketOutputStream::SocketOutputStream (Socket::SocketHandle  socket  ) 
+
+
+ +

+Constructor.

Parameters:
+ + +
socket the socket handle.
+
+ +
+

+

Member Function Documentation

+ +
+
+ + + + + + + + + +
virtual void activemq::network::SocketOutputStream::close (void   )  throw ( cms::CMSException ) [inline, virtual]
+
+
+ +

+Close - does nothing. It is the responsibility of the owner of the socket object to close it.

Exceptions:
+ + +
CMSException 
+
+ +

+Implements cms::Closeable. +

+

+ +

+
+ + + + + + + + + +
virtual void activemq::network::SocketOutputStream::flush (void   )  throw ( io::IOException ) [inline, virtual]
+
+
+ +

+Flush - does nothing.

Exceptions:
+ + +
IOException 
+
+ +

+Implements activemq::io::OutputStream. +

+

+ +

+
+ + + + + + + + +
virtual void activemq::network::SocketOutputStream::lock (  )  throw ( exceptions::ActiveMQException ) [inline, virtual]
+
+
+ +

+Locks the object.

Exceptions:
+ + +
ActiveMQException 
+
+ +

+Implements activemq::concurrent::Synchronizable. +

+

+ +

+
+ + + + + + + + +
virtual void activemq::network::SocketOutputStream::notify (  )  throw ( exceptions::ActiveMQException ) [inline, virtual]
+
+
+ +

+Signals a waiter on this object that it can now wake up and continue. Must have this object locked before calling.

Exceptions:
+ + +
ActiveMQException 
+
+ +

+Implements activemq::concurrent::Synchronizable. +

+

+ +

+
+ + + + + + + + +
virtual void activemq::network::SocketOutputStream::notifyAll (  )  throw ( exceptions::ActiveMQException ) [inline, virtual]
+
+
+ +

+Signals the waiters on this object that it can now wake up and continue. Must have this object locked before calling. +

+Implements activemq::concurrent::Synchronizable. +

+

+ +

+
+ + + + + + + + + +
virtual void activemq::network::SocketOutputStream::setDebug (const bool  debug  )  [inline, virtual]
+
+
+ +

+Enables Debugging of Socket Data

Parameters:
+ + +
debug true to enable
+
+ +
+

+ +

+
+ + + + + + + + +
virtual void activemq::network::SocketOutputStream::unlock (  )  throw ( exceptions::ActiveMQException ) [inline, virtual]
+
+
+ +

+Unlocks the object.

Exceptions:
+ + +
ActiveMQException 
+
+ +

+Implements activemq::concurrent::Synchronizable. +

+

+ +

+
+ + + + + + + + + +
virtual void activemq::network::SocketOutputStream::wait (unsigned long  millisecs  )  throw ( exceptions::ActiveMQException ) [inline, virtual]
+
+
+ +

+Waits on a signal from this object, which is generated by a call to Notify. Must have this object locked before calling. This wait will timeout after the specified time interval.

Parameters:
+ + +
millisecs time in millisecsonds to wait, or WAIT_INIFINITE
+
+
Exceptions:
+ + +
ActiveMQException 
+
+ +

+Implements activemq::concurrent::Synchronizable. +

+

+ +

+
+ + + + + + + + +
virtual void activemq::network::SocketOutputStream::wait (  )  throw ( exceptions::ActiveMQException ) [inline, virtual]
+
+
+ +

+Waits on a signal from this object, which is generated by a call to Notify. Must have this object locked before calling.

Exceptions:
+ + +
ActiveMQException 
+
+ +

+Implements activemq::concurrent::Synchronizable. +

+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void SocketOutputStream::write (const unsigned char *  buffer,
const int  len 
) throw ( io::IOException ) [virtual]
+
+
+ +

+Writes an array of bytes to the output stream.

Parameters:
+ + + +
buffer The array of bytes to write.
len The number of bytes from the buffer to be written.
+
+
Exceptions:
+ + +
IOException thrown if an error occurs.
+
+ +

+Implements activemq::io::OutputStream. +

+

+ +

+
+ + + + + + + + + +
void SocketOutputStream::write (const unsigned char  c  )  throw ( io::IOException ) [virtual]
+
+
+ +

+Writes a single byte to the output stream.

Parameters:
+ + +
c the byte.
+
+
Exceptions:
+ + +
IOException thrown if an error occurs.
+
+ +

+Implements activemq::io::OutputStream. +

+

+

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_1network_1_1_socket_output_stream.png URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1network_1_1_socket_output_stream.png?rev=428212&view=auto ============================================================================== Binary file - no diff available. Propchange: incubator/activemq/site/cms/html/classactivemq_1_1network_1_1_socket_output_stream.png ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: incubator/activemq/site/cms/html/classactivemq_1_1network_1_1_tcp_socket-members.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/cms/html/classactivemq_1_1network_1_1_tcp_socket-members.html?rev=428212&view=auto ============================================================================== --- incubator/activemq/site/cms/html/classactivemq_1_1network_1_1_tcp_socket-members.html (added) +++ incubator/activemq/site/cms/html/classactivemq_1_1network_1_1_tcp_socket-members.html Wed Aug 2 19:24:43 2006 @@ -0,0 +1,45 @@ + + +activemq-cpp: Member List + + + + +
+
+
+
+

activemq::network::TcpSocket Member List

This is the complete list of members for activemq::network::TcpSocket, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + +
close()activemq::network::TcpSocket [virtual]
connect(const char *host, const int port)activemq::network::TcpSocket [virtual]
getInputStream()activemq::network::TcpSocket [virtual]
getKeepAlive() const activemq::network::TcpSocket [virtual]
getOutputStream()activemq::network::TcpSocket [virtual]
getReceiveBufferSize() const activemq::network::TcpSocket [virtual]
getReuseAddress() const activemq::network::TcpSocket [virtual]
getSendBufferSize() const activemq::network::TcpSocket [virtual]
getSocketHandle()activemq::network::TcpSocket [inline]
getSoLinger() const activemq::network::TcpSocket [virtual]
getSoTimeout() const activemq::network::TcpSocket [virtual]
isConnected() const activemq::network::TcpSocket [inline, virtual]
setKeepAlive(const bool keepAlive)activemq::network::TcpSocket [virtual]
setReceiveBufferSize(const int size)activemq::network::TcpSocket [virtual]
setReuseAddress(const bool reuse)activemq::network::TcpSocket [virtual]
setSendBufferSize(const int size)activemq::network::TcpSocket [virtual]
setSoLinger(const int linger)activemq::network::TcpSocket [virtual]
setSoTimeout(const int timeout)activemq::network::TcpSocket [virtual]
TcpSocket()activemq::network::TcpSocket
TcpSocket(SocketHandle socketHandle)activemq::network::TcpSocket
~TcpSocket()activemq::network::TcpSocket [virtual]

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