Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIMIMEInputStream Interface Reference

The MIME stream separates headers and a datastream. More...

import "nsIMIMEInputStream.idl";

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

List of all members.

Public Member Functions

void addHeader (in string name, in string value)
 Adds an additional header to the stream on the form "name: value".
void setData (in nsIInputStream stream)
 Sets data-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 ()

Public Attributes

attribute boolean addContentLength
 When true a "Content-Length" header is automatically added to the stream.

Detailed Description

The MIME stream separates headers and a datastream.

It also allows automatic creation of the content-length header.

Definition at line 47 of file nsIMIMEInputStream.idl.


Member Function Documentation

Adds an additional header to the stream on the form "name: value".

May not be called once the stream has been started to be read.

Parameters:
namename of the header
valuevalue of the header
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).

Sets data-stream.

May not be called once the stream has been started to be read. The cursor of the new stream should be located at the beginning of the stream if the implementation of the nsIMIMEInputStream also is used as an nsISeekableStream.

Parameters:
streamstream containing the data for the stream

Member Data Documentation

When true a "Content-Length" header is automatically added to the stream.

The value of the content-length is automatically calculated using the available() method on the data stream. The value is recalculated every time the stream is rewinded to the start. Not allowed to be changed once the stream has been started to be read.

Definition at line 56 of file nsIMIMEInputStream.idl.


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