Logo Search packages:      
Sourcecode: xulrunner version File versions  Download package

nsIInputStream Interface Reference

import "nsIInputStream.idl";

Inheritance diagram for nsIInputStream:

nsISupports imgIEncoder nsIAsyncInputStream nsIBinaryInputStream nsIBufferedInputStream nsIFileInputStream nsIInputStreamTee nsIMIMEInputStream nsIMultiplexInputStream nsIPluginInputStream nsIStringInputStream

List of all members.

Detailed Description


An interface describing a readable stream of data. An input stream may be "blocking" or "non-blocking" (see the IsNonBlocking method). A blocking input stream may suspend the calling thread in order to satisfy a call to Close, Available, Read, or ReadSegments. A non-blocking input stream, on the other hand, must not block the calling thread of execution.

NOTE: blocking input streams are often read on a background thread to avoid locking up the main application thread. For this reason, it is generally the case that a blocking input stream should be implemented using thread- safe AddRef and Release.


Definition at line 98 of file nsIInputStream.idl.

Public Member Functions

unsigned long available ()
void close ()
boolean isNonBlocking ()
unsigned long read (in charPtr aBuf, in unsigned long aCount)
unsigned long readSegments (in nsWriteSegmentFun aWriter, in voidPtr aClosure, in unsigned long aCount)
 NS_IMETHOD_ (nsrefcnt) Release(void)=0
 NS_IMETHOD_ (nsrefcnt) AddRef(void)=0
NS_IMETHOD QueryInterface (REFNSIID aIID, void **aInstancePtr)=0

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

Generated by  Doxygen 1.6.0   Back to index