BufferedInputStream Class Reference
[Various accompanying utilities]

Inheritance diagram for BufferedInputStream:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 __construct (InputStream $in)
 close ()
 
Returns:
BufferedInputStream

 isEof ()
 markSupported ()
 mark ()
 
Returns:
BufferedInputStream

 reset ()
 
Returns:
BufferedInputStream

 available ()
 setRunAheadBytes ($runAheadBytes)
 
Returns:
BufferedInputStream

 read ($count)
 reads a maximum of $length bytes

Static Public Member Functions

static create (InputStream $in)
 
Returns:
BufferedInputStream


Private Attributes

 $runAheadBytes = 0
 $in = null
 $closed = false
 $buffer = null
 $bufferLength = 0
 $position = 0
 $markPosition = null


Detailed Description

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


Constructor & Destructor Documentation

BufferedInputStream::__construct ( InputStream in  ) 

Definition at line 29 of file BufferedInputStream.class.php.


Member Function Documentation

static BufferedInputStream::create ( InputStream in  )  [static]

Returns:
BufferedInputStream

Definition at line 37 of file BufferedInputStream.class.php.

BufferedInputStream::close (  ) 

Returns:
BufferedInputStream

Reimplemented from InputStream.

Definition at line 45 of file BufferedInputStream.class.php.

BufferedInputStream::isEof (  ) 

Reimplemented from InputStream.

Definition at line 52 of file BufferedInputStream.class.php.

BufferedInputStream::markSupported (  ) 

Reimplemented from InputStream.

Definition at line 57 of file BufferedInputStream.class.php.

BufferedInputStream::mark (  ) 

Returns:
BufferedInputStream

Reimplemented from InputStream.

Definition at line 65 of file BufferedInputStream.class.php.

BufferedInputStream::reset (  ) 

Returns:
BufferedInputStream

Reimplemented from InputStream.

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

BufferedInputStream::available (  ) 

Reimplemented from InputStream.

Definition at line 82 of file BufferedInputStream.class.php.

Referenced by read().

BufferedInputStream::setRunAheadBytes ( runAheadBytes  ) 

Returns:
BufferedInputStream

Definition at line 93 of file BufferedInputStream.class.php.

References $runAheadBytes.

BufferedInputStream::read ( length  ) 

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 from InputStream.

Definition at line 100 of file BufferedInputStream.class.php.

References available().

Here is the call graph for this function:


Member Data Documentation

BufferedInputStream::$runAheadBytes = 0 [private]

Definition at line 18 of file BufferedInputStream.class.php.

Referenced by setRunAheadBytes().

BufferedInputStream::$in = null [private]

Definition at line 20 of file BufferedInputStream.class.php.

BufferedInputStream::$closed = false [private]

Definition at line 21 of file BufferedInputStream.class.php.

BufferedInputStream::$buffer = null [private]

Definition at line 23 of file BufferedInputStream.class.php.

BufferedInputStream::$bufferLength = 0 [private]

Definition at line 24 of file BufferedInputStream.class.php.

BufferedInputStream::$position = 0 [private]

Definition at line 26 of file BufferedInputStream.class.php.

BufferedInputStream::$markPosition = null [private]

Definition at line 27 of file BufferedInputStream.class.php.


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