Public Member Functions

nsIChannelClassifier Interface Reference

An nsIChannelClassifier object checks a channel's URI against the URI classifier service, and cancels the channel before OnStartRequest if it is found on a blacklist. More...

import "nsIChannelClassifier.idl";

List of all members.

Public Member Functions

void start (in nsIChannel aChannel, in boolean aInstallListener)
 Checks a channel against the URI classifier service (if it exists).
void onRedirect (in nsIChannel aOldChannel, in nsIChannel aNewChannel)
 Notify the classifier that the channel was redirected.
void cancel ()
 Cancel an existing query.

Detailed Description

An nsIChannelClassifier object checks a channel's URI against the URI classifier service, and cancels the channel before OnStartRequest if it is found on a blacklist.


Member Function Documentation

void nsIChannelClassifier::cancel (  ) 

Cancel an existing query.

If a channel has been suspended, it will be resumed.

void nsIChannelClassifier::onRedirect ( in nsIChannel  aOldChannel,
in nsIChannel  aNewChannel 
)

Notify the classifier that the channel was redirected.

The new channel will be suspended pending a new classifier lookup.

Parameters:
aOldChannel The channel that's being redirected.
aNewChannel The new channel. This channel is not opened yet.
void nsIChannelClassifier::start ( in nsIChannel  aChannel,
in boolean  aInstallListener 
)

Checks a channel against the URI classifier service (if it exists).

The channel will be suspended while the classifier is checked. The channel may be cancelled with an error code determined by the classifier before it is resumed.

If there is no URI classifier service, NS_ERROR_FACTORY_NOT_REGISTERED will be returned.

This method must be called immediately after AsyncOpen() has been called on the channel.

Parameters:
aChannel The channel to suspend.
aInstallListener If true, the classifier will install notification callbacks to listen for redirects. The classifier will pass all notifications on to the channel's existing notification callbacks.

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