FileInputStream Class Reference
[Various accompanying utilities]

Inheritance diagram for FileInputStream:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 __construct ($nameOrFd)
 __destruct ()
 isEof ()
 mark ()
 
Returns:
FileInputStream

 markSupported ()
 reset ()
 
Returns:
FileInputStream

 close ()
 
Returns:
FileInputStream

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

Static Public Member Functions

static create ($nameOrFd)
 
Returns:
FileInputStream


Private Attributes

 $fd = null
 $mark = null


Detailed Description

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


Constructor & Destructor Documentation

FileInputStream::__construct ( nameOrFd  ) 

Definition at line 22 of file FileInputStream.class.php.

FileInputStream::__destruct (  ) 

Definition at line 39 of file FileInputStream.class.php.

References close().

Here is the call graph for this function:


Member Function Documentation

static FileInputStream::create ( nameOrFd  )  [static]

Returns:
FileInputStream

Definition at line 51 of file FileInputStream.class.php.

FileInputStream::isEof (  ) 

Reimplemented from InputStream.

Definition at line 56 of file FileInputStream.class.php.

FileInputStream::mark (  ) 

Returns:
FileInputStream

Reimplemented from InputStream.

Definition at line 64 of file FileInputStream.class.php.

Referenced by reset().

FileInputStream::markSupported (  ) 

Reimplemented from InputStream.

Definition at line 71 of file FileInputStream.class.php.

FileInputStream::reset (  ) 

Returns:
FileInputStream

Reimplemented from InputStream.

Definition at line 79 of file FileInputStream.class.php.

References mark().

Here is the call graph for this function:

FileInputStream::close (  ) 

Returns:
FileInputStream

Reimplemented from InputStream.

Definition at line 92 of file FileInputStream.class.php.

Referenced by __destruct().

FileInputStream::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 FileInputStream.class.php.


Member Data Documentation

FileInputStream::$fd = null [private]

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

FileInputStream::$mark = null [private]

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


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