io::InputStream Class Reference

This abstract class is the superclass of all classes representing an input stream of bytes. More...

#include <InputStream.h>

Inheritance diagram for io::InputStream:

Inheritance graph
[legend]
Collaboration diagram for io::InputStream:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual int32 read ()=0
virtual int32 read (char *pDataOut, int32 size)=0
virtual int32 skip (int32 n)=0
virtual int32 available () const =0


Detailed Description

This abstract class is the superclass of all classes representing an input stream of bytes.

Note:
Applications that need to define a subclass of InputStream must always provide a method that returns the next byte of input.

Member Function Documentation

virtual int32 io::InputStream::read (  )  [pure virtual]

Returns a byte of data from this input stream.

Implemented in io::ByteArrayInputStream, and io::FileInputStream.

virtual int32 io::InputStream::read ( char *  pDataOut,
int32  size 
) [pure virtual]

Tries to read specified number of bytes from the stream. Doesn't block the caller if specified number of bytes isn't available.

Note:
We don't use the read(byte[] b)
Parameters:
pDataOut The data buffer
size The size of buffer
Returns:
Number of bytes actually read.

Implemented in io::ByteArrayInputStream, and io::FileInputStream.

virtual int32 io::InputStream::skip ( int32  n  )  [pure virtual]

Tries to skip over n bytes from the stream.

Parameters:
n The number to be skipped
Returns:
Number of bytes actually skipped.

Implemented in io::ByteArrayInputStream, and io::FileInputStream.

virtual int32 io::InputStream::available (  )  const [pure virtual]

Returns the number of bytes that can be read from the stream without blocking.

Implemented in io::ByteArrayInputStream, and io::FileInputStream.


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

Generated on Mon Mar 3 10:53:09 2008 for Aika by  doxygen 1.5.5