Public Member Functions | Public Attributes

nsILoadGroup Interface Reference

A load group maintains a collection of nsIRequest objects. More...

import "nsILoadGroup.idl";

Inheritance diagram for nsILoadGroup:
Collaboration diagram for nsILoadGroup:

List of all members.

Public Member Functions

void addRequest (in nsIRequest aRequest, in nsISupports aContext)
 Adds a new request to the group.
void removeRequest (in nsIRequest aRequest, in nsISupports aContext, in nsresult aStatus)
 Removes a request from the group.

Public Attributes

attribute nsIRequestObserver groupObserver
 The group observer is notified when requests are added to and removed from this load group.
attribute nsIRequest defaultLoadRequest
 Accesses the default load request for the group.
readonly attribute
nsISimpleEnumerator 
requests
 Returns the requests contained directly in this group.
readonly attribute unsigned long activeCount
 Returns the count of "active" requests (ie.
attribute nsIInterfaceRequestor notificationCallbacks
 Notification callbacks for the load group.

Detailed Description

A load group maintains a collection of nsIRequest objects.

Status:
FROZEN

Member Function Documentation

void nsILoadGroup::addRequest ( in nsIRequest  aRequest,
in nsISupports  aContext 
)

Adds a new request to the group.

This will cause the default load flags to be applied to the request. If this is a foreground request then the groupObserver's onStartRequest will be called.

If the request is the default load request or if the default load request is null, then the load group will inherit its load flags from the request.

void nsILoadGroup::removeRequest ( in nsIRequest  aRequest,
in nsISupports  aContext,
in nsresult  aStatus 
)

Removes a request from the group.

If this is a foreground request then the groupObserver's onStopRequest will be called.

By the time this call ends, aRequest will have been removed from the loadgroup, even if this function throws an exception.


Member Data Documentation

readonly attribute unsigned long nsILoadGroup::activeCount

Returns the count of "active" requests (ie.

requests without the LOAD_BACKGROUND bit set).

Accesses the default load request for the group.

Each time a number of requests are added to a group, the defaultLoadRequest may be set to indicate that all of the requests are related to a base request.

The load group inherits its load flags from the default load request. If the default load request is NULL, then the group's load flags are not changed.

The group observer is notified when requests are added to and removed from this load group.

The groupObserver is weak referenced.

Notification callbacks for the load group.

Returns the requests contained directly in this group.

Enumerator element type: nsIRequest.


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