InputStream Class Reference
[Various accompanying utilities]

Inheritance diagram for InputStream:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 read ($length)
 reads a maximum of $length bytes
 isEof ()
 mark ()
 
Returns:
InputStream

 markSupported ()
 reset ()
 skip ($count)
 available ()
 close ()
 
Returns:
InputStream


Detailed Description

Definition at line 16 of file InputStream.class.php.


Member Function Documentation

InputStream::read ( length  )  [abstract]

reads a maximum of $length bytes

returns null on eof or if length == 0. Otherwise MUST return at least one byte or throw IOException

NOTE: if length is too large to read all data at once and eof has not been reached, it MUST BLOCK until all data is read or eof is reached or throw IOException.

It is abnormal state. Maybe you should use some kind of non-blocking channels instead?

Reimplemented in BufferedInputStream, FileInputStream, SocketInputStream, and StringInputStream.

Referenced by skip().

InputStream::isEof (  ) 

Reimplemented in BufferedInputStream, FileInputStream, SocketInputStream, and StringInputStream.

Definition at line 35 of file InputStream.class.php.

InputStream::mark (  ) 

Returns:
InputStream

Reimplemented in BufferedInputStream, FileInputStream, and StringInputStream.

Definition at line 43 of file InputStream.class.php.

Referenced by reset().

InputStream::markSupported (  ) 

Reimplemented in BufferedInputStream, FileInputStream, and StringInputStream.

Definition at line 50 of file InputStream.class.php.

InputStream::reset (  ) 

Reimplemented in BufferedInputStream, FileInputStream, and StringInputStream.

Definition at line 55 of file InputStream.class.php.

References mark().

Here is the call graph for this function:

InputStream::skip ( count  ) 

Definition at line 62 of file InputStream.class.php.

References read().

Here is the call graph for this function:

InputStream::available (  ) 

Reimplemented in BufferedInputStream.

Definition at line 67 of file InputStream.class.php.

InputStream::close (  ) 

Returns:
InputStream

Reimplemented in BufferedInputStream, FileInputStream, and StringInputStream.

Definition at line 75 of file InputStream.class.php.


The documentation for this class was generated from the following file:
Generated on Sun Dec 9 21:57:48 2007 for onPHP by  doxygen 1.5.4