Back to index

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

The nsIStreamConverterService is a higher level stream converter factory responsible for locating and creating stream converters (nsIStreamConverter). More...

import "nsIStreamConverterService.idl";

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

List of all members.

Public Member Functions

nsIInputStream convert (in nsIInputStream aFromStream, in string aFromType, in string aToType, in nsISupports aContext)
 SYNCRONOUS VERSION Converts a stream of one type, to a stream of another type.
nsIStreamListener asyncConvertData (in string aFromType, in string aToType, in nsIStreamListener aListener, in nsISupports aContext)
 ASYNCRONOUS VERSION Retrieves a nsIStreamListener that receives the original/raw data via its nsIStreamListener::OnDataAvailable() callback, then converts and pushes the data to aListener.

Detailed Description

The nsIStreamConverterService is a higher level stream converter factory responsible for locating and creating stream converters (nsIStreamConverter).

This service retrieves an interface that can convert data from a particular MIME type, to a particular MIME type. It is responsible for any intermediary conversion required in order to get from X to Z, assuming direct conversion is not possible.

Author:
Jud Valeski
See also:
nsIStreamConverter

Definition at line 59 of file nsIStreamConverterService.idl.


Member Function Documentation

nsIStreamListener nsIStreamConverterService::asyncConvertData ( in string  aFromType,
in string  aToType,
in nsIStreamListener  aListener,
in nsISupports  aContext 
)

ASYNCRONOUS VERSION Retrieves a nsIStreamListener that receives the original/raw data via its nsIStreamListener::OnDataAvailable() callback, then converts and pushes the data to aListener.

Use this method when you want to proxy (and convert) nsIStreamListener callbacks asynchronously.

Parameters:
aFromTypeThe MIME type of the original/raw data.
aToTypeThe MIME type of the converted data.
aListenerThe listener that receives the converted data.
aCtxtEither an opaque context, or a converter specific context (implementation specific).
Returns:
A nsIStreamListener that receives data via its OnDataAvailable() method.
nsIInputStream nsIStreamConverterService::convert ( in nsIInputStream  aFromStream,
in string  aFromType,
in string  aToType,
in nsISupports  aContext 
)

SYNCRONOUS VERSION Converts a stream of one type, to a stream of another type.

Use this method when you have a stream you want to convert.

Parameters:
aFromStreamThe stream representing the original/raw data.
aFromTypeThe MIME type of aFromStream.
aToTypeThe MIME type of the returned stream.
aContextEither an opaque context, or a converter specific context (implementation specific).
Returns:
The converted stream. NOTE: The returned stream may not already be converted. An efficient stream converter implementation will convert data on demand rather than buffering the converted data until it is used.

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