Back to index

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

A parser for application/http-index-format. More...

import "nsIDirIndexListener.idl";

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

List of all members.

Public Member Functions

void onDataAvailable (in nsIRequest aRequest, in nsISupports aContext, in nsIInputStream aInputStream, in unsigned long aOffset, in unsigned long aCount)
 Called when the next chunk of data (corresponding to the request) may be read without blocking the calling thread.
void onStartRequest (in nsIRequest aRequest, in nsISupports aContext)
 Called to signify the beginning of an asynchronous request.
void onStopRequest (in nsIRequest aRequest, in nsISupports aContext, in nsresult aStatusCode)
 Called to signify the end of an asynchronous request.

Public Attributes

attribute nsIDirIndexListener listener
 The interface to use as a callback for new entries.
readonly attribute string comment
 The comment given, if any This result is only valid after OnStopRequest has occurred, because it can occur anywhere in the datastream.
attribute string encoding
 The encoding to use.

Detailed Description

A parser for application/http-index-format.

Definition at line 82 of file nsIDirIndexListener.idl.


Member Function Documentation

void nsIStreamListener::onDataAvailable ( in nsIRequest  aRequest,
in nsISupports  aContext,
in nsIInputStream  aInputStream,
in unsigned long  aOffset,
in unsigned long  aCount 
) [inherited]

Called when the next chunk of data (corresponding to the request) may be read without blocking the calling thread.

The onDataAvailable impl must read exactly |aCount| bytes of data before returning.

Parameters:
aRequestrequest corresponding to the source of the data
aContextuser defined context
aInputStreaminput stream containing the data chunk
aOffsetNumber of bytes that were sent in previous onDataAvailable calls for this request. In other words, the sum of all previous count parameters. If that number is greater than or equal to 2^32, this parameter will be PR_UINT32_MAX (2^32 - 1).
aCountnumber of bytes available in the stream

NOTE: The aInputStream parameter must implement readSegments.

An exception thrown from onDataAvailable has the side-effect of causing the request to be canceled.

void nsIRequestObserver::onStartRequest ( in nsIRequest  aRequest,
in nsISupports  aContext 
) [inherited]

Called to signify the beginning of an asynchronous request.

Parameters:
aRequestrequest being observed
aContextuser defined context

An exception thrown from onStartRequest has the side-effect of causing the request to be canceled.

Here is the caller graph for this function:

void nsIRequestObserver::onStopRequest ( in nsIRequest  aRequest,
in nsISupports  aContext,
in nsresult  aStatusCode 
) [inherited]

Called to signify the end of an asynchronous request.

This call is always preceded by a call to onStartRequest.

Parameters:
aRequestrequest being observed
aContextuser defined context
aStatusCodereason for stopping (NS_OK if completed successfully)

An exception thrown from onStopRequest is generally ignored.

Here is the caller graph for this function:


Member Data Documentation

The comment given, if any This result is only valid after OnStopRequest has occurred, because it can occur anywhere in the datastream.

Definition at line 93 of file nsIDirIndexListener.idl.

The encoding to use.

Definition at line 98 of file nsIDirIndexListener.idl.

The interface to use as a callback for new entries.

Definition at line 86 of file nsIDirIndexListener.idl.


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