---

stdbase::io::InputStream Class Reference

Abstract input stream class. More...

Inheritance diagram for stdbase::io::InputStream::

List of all members.

Public Methods
virtual int	available ()=0 throw (IOException)
	Get the number of bytes that can be read or skipped before the next read would block.
virtual void	close ()=0 throw (IOException)
	Closes the stream and releases any resources.
virtual void	mark (int readlimit)=0
	Marks the current position in the input stream incase the caller need return to this point - done by calling reset(). More...
virtual void	reset ()=0 throw (IOException)
	Returns the caller to a previously marked position in the input stream (if supported). More...
virtual bool	markSupported ()=0
	Test to see whether the InputStream implementation supports the mark()/reset() methods.
virtual int	read (byte buffer[], int len)=0 throw (IOException)
	Read a buffer of bytes - NEEDS Array.
virtual int	read ()=0 throw (IOException)
	Read a single byte from the stream and return it as an integer. More...
virtual long	skip (long n)=0 throw (IOException)
	Skip the next n bytes from the input stream. More...
Protected Methods
virtual	~InputStream ()
virtual void	inc () const
	Reference count re-direct method - inc(). More...
virtual unsigned	dec () const
	Reference count re-direct method - inc(). More...

---

Detailed Description

Abstract input stream class.

Revision:

1.1

Author:

w-molloy

Date:

2002/08/08 12:21:26

Definition at line 53 of file InputStream.

---

Member Function Documentation

virtual unsigned stdbase::io::InputStream::dec (  )  const [inline, protected, virtual]

Reference count re-direct method - inc(). This is intended to call the Object::* version of inc() in cases where there are multiple inheritence paths back to Abstract. Definition at line 72 of file InputStream.

virtual void stdbase::io::InputStream::inc (  )  const [inline, protected, virtual]

Reference count re-direct method - inc(). This is intended to call the Object::* version of inc() in cases where there are multiple inheritence paths back to Abstract. Definition at line 64 of file InputStream.

virtual void stdbase::io::InputStream::mark (  int readlimit )  [pure virtual]

Marks the current position in the input stream incase the caller need return to this point - done by calling reset(). Parameters: readlimit   the maximum limit of bytes before the marked position becomes invalid. Reimplemented in stdbase::io::BufferedInputStream, stdbase::io::FileInputStream, and stdbase::io::FilterInputStream.

virtual int stdbase::io::InputStream::read (  )  throw (IOException) [pure virtual]

Read a single byte from the stream and return it as an integer. Returns: the number of bytes read. Reimplemented in stdbase::io::BufferedInputStream, stdbase::io::FileInputStream, and stdbase::io::FilterInputStream.

virtual void stdbase::io::InputStream::reset (  )  throw (IOException) [pure virtual]

Returns the caller to a previously marked position in the input stream (if supported). Exceptions: IOException   if mark/reset not supported or if the number of bytes read exceeds the mark readlimit when mark() was called. Reimplemented in stdbase::io::BufferedInputStream, stdbase::io::FileInputStream, and stdbase::io::FilterInputStream.

virtual long stdbase::io::InputStream::skip (  long n )  throw (IOException) [pure virtual]

Skip the next n bytes from the input stream. Returns: the number of bytes skipped. Reimplemented in stdbase::io::FileInputStream, and stdbase::io::FilterInputStream.

---

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

• InputStream

---