Back to index

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

This interface provides a way to stream data to the web browser. More...

import "nsIWebBrowserStream.idl";

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

List of all members.

Public Member Functions

void openStream (in nsIURI aBaseURI, in ACString aContentType)
 Prepare to load a stream of data.
void appendToStream ([const, array, size_is(aLen)] in octet aData, in unsigned long aLen)
 Append data to this stream.
void closeStream ()
 Notifies the browser that all the data has been appended.

Detailed Description

This interface provides a way to stream data to the web browser.

This allows loading of data from sources which can not be accessed using URIs and nsIWebNavigation.

FROZEN

Definition at line 51 of file nsIWebBrowserStream.idl.


Member Function Documentation

void nsIWebBrowserStream::appendToStream ( [const, array, size_is(aLen)] in octet  aData,
in unsigned long  aLen 
)

Append data to this stream.

Parameters:
aDataThe data to append
aLenLength of the data to append.
Note:
To append more than 4 GB of data, call this method multiple times.

Notifies the browser that all the data has been appended.

This may notify the user that the browser is "done loading" in some form.

Exceptions:
NS_ERROR_UNEXPECTEDThis method was called without a preceding openStream.
void nsIWebBrowserStream::openStream ( in nsIURI  aBaseURI,
in ACString  aContentType 
)

Prepare to load a stream of data.

When this function returns successfully, it must be paired by a call to closeStream.

Parameters:
aBaseURIThe base URI of the data. Must not be null. Relative URIs will be resolved relative to this URI.
aContentTypeASCII string giving the content type of the data. If rendering content of this type is not supported, this method fails. This string may include a charset declaration, for example: text/html;charset=ISO-8859-1
Exceptions:
NS_ERROR_NOT_AVAILABLEThe requested content type is not supported.
NS_ERROR_IN_PROGRESSopenStream was called twice without an intermediate closeStream.

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