Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIStringInputStream Interface Reference

Based on original code from nsIStringStream.h. More...

import "nsIStringStream.idl";

Inheritance diagram for nsIStringInputStream:
Inheritance graph
[legend]
Collaboration diagram for nsIStringInputStream:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void setData (in string data, in long dataLen)
 SetData - assign data to the input stream (copied on assignment).
void adoptData (in charPtr data, in long dataLen)
 NOTE: the following methods are designed to give C++ code added control over the ownership and lifetime of the stream data.
void shareData (in string data, in long dataLen)
 ShareData - assign data to the input stream.
void close ()
 Close the stream.
unsigned long available ()
unsigned long read (in charPtr aBuf, in unsigned long aCount)
 Read data from the stream.
unsigned long readSegments (in nsWriteSegmentFun aWriter, in voidPtr aClosure, in unsigned long aCount)
 Low-level read method that has access to the stream's underlying buffer.
boolean isNonBlocking ()

Detailed Description

Based on original code from nsIStringStream.h.

nsIStringInputStream

Provides scriptable and specialized C++ only methods for initializing a nsIInputStream implementation with a simple character array.

Definition at line 55 of file nsIStringStream.idl.


Member Function Documentation

void nsIStringInputStream::adoptData ( in charPtr  data,
in long  dataLen 
)

NOTE: the following methods are designed to give C++ code added control over the ownership and lifetime of the stream data.

Use with care :-) AdoptData - assign data to the input stream. the input stream takes ownership of the given data buffer and will nsMemory::Free it when the input stream is destroyed.

Parameters:
data- stream data
dataLen- stream data length (-1 if length should be computed)
unsigned long nsIInputStream::available ( ) [inherited]
Returns:
number of bytes currently available in the stream
void nsIInputStream::close ( ) [inherited]

Close the stream.

Returns:
true if stream is non-blocking
unsigned long nsIInputStream::read ( in charPtr  aBuf,
in unsigned long  aCount 
) [inherited]

Read data from the stream.

Parameters:
aBufthe buffer into which the data is to be read
aCountthe maximum number of bytes to be read
Returns:
number of bytes read (may be less than aCount).
0 if reached end of file
Exceptions:
NS_BASE_STREAM_WOULD_BLOCKif reading from the input stream would block the calling thread (non-blocking mode only)
<other-error>on failure
unsigned long nsIInputStream::readSegments ( in nsWriteSegmentFun  aWriter,
in voidPtr  aClosure,
in unsigned long  aCount 
) [inherited]

Low-level read method that has access to the stream's underlying buffer.

The writer function may be called multiple times for segmented buffers. ReadSegments is expected to keep calling the writer until either there is nothing left to read or the writer returns an error. ReadSegments should not call the writer with zero bytes to consume.

Parameters:
aWriterthe "consumer" of the data to be read
aClosureopaque parameter passed to writer
aCountthe maximum number of bytes to be read
Returns:
number of bytes read (may be less than aCount)
0 if reached end of file (or if aWriter refused to consume data)
Exceptions:
NS_BASE_STREAM_WOULD_BLOCKif reading from the input stream would block the calling thread (non-blocking mode only)
<other-error>on failure

NOTE: this function may be unimplemented if a stream has no underlying buffer (e.g., socket input stream).

SetData - assign data to the input stream (copied on assignment).

Parameters:
data- stream data
dataLen- stream data length (-1 if length should be computed)

NOTE: C++ code should consider using AdoptData or ShareData to avoid making an extra copy of the stream data.

ShareData - assign data to the input stream.

the input stream references the given data buffer until the input stream is destroyed. the given data buffer must outlive the input stream.

Parameters:
data- stream data
dataLen- stream data length (-1 if length should be computed)

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