activemq::io::InputStream Class Reference

#include <InputStream.h>

Inheritance diagram for activemq::io::InputStream:

List of all members.

Public Member Functions
virtual	~InputStream ()
virtual int	available () const =0
virtual unsigned char	read ()=0 throw ( IOException )
virtual int	read (unsigned char *buffer, const int bufferSize)=0 throw ( IOException )

---

Detailed Description

Base interface for an input stream.

---

Constructor & Destructor Documentation

virtual activemq::io::InputStream::~InputStream (   )  [inline, virtual]

---

Member Function Documentation

virtual int activemq::io::InputStream::available (   )  const [pure virtual]

Indcates the number of bytes avaialable. Returns: the number of bytes available on this input stream. Implemented in activemq::io::BufferedInputStream, activemq::io::ByteArrayInputStream, and activemq::network::SocketInputStream.

virtual int activemq::io::InputStream::read (  unsigned char *  buffer, const int  bufferSize )  throw ( IOException ) [pure 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 or -1 if EOS is detected Exceptions: IOException  thrown if an error occurs. Implemented in activemq::io::BufferedInputStream, activemq::io::ByteArrayInputStream, and activemq::network::SocketInputStream.

virtual unsigned char activemq::io::InputStream::read (   )  throw ( IOException ) [pure virtual]

Reads a single byte from the buffer. Returns: The next byte. Exceptions: IOException  thrown if an error occurs. Implemented in activemq::io::BufferedInputStream, activemq::io::ByteArrayInputStream, and activemq::network::SocketInputStream.

---

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

• activemq-cpp/src/main/activemq/io/InputStream.h

---