Visit Mozilla.org

nsIInputStream

From MDC

« XPCOM API Reference

[edit] Summary

The nsIInputStream interface represents a readable data source.

  #include "nsIInputStream.h"

  [scriptable, uuid=(fa9c7f6c-61b3-11d4-9877-00c04fa0cf4a)]
  interface nsIInputStream : nsISupports { ... };

nsIInputStream is defined in xpcom/io/nsIInputStream.idl. It is scriptable and has been frozen since Mozilla 1.0.

[edit] Methods

close
This method closes the input stream.
available
This method returns the number of bytes currently available for reading from the stream.
read
This method copies data from the stream into a buffer. Not scriptable.
readSegments
This method provides direct access to the stream's internal buffer. Not scriptable.
isNonBlocking
This method returns true if the stream is non-blocking.

[edit] History

This interface was frozen for Mozilla 1.0. See bug 124465 for details.