nsILoadGroup

netwerk/base/public/nsILoadGroup.idlScriptable

A load group maintains a collection of nsIRequest objects.

Inherits from: nsIRequest Last changed in Gecko 1.7

Method overview

void addRequest(in nsIRequest aRequest, in nsISupports aContext);

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

Attributes

Attribute	Type	Description
`activeCount`	`unsigned long`	Returns the count of "active" `requests` (that is `requests` without the LOAD_BACKGROUND bit set). Read only.
`defaultLoadRequest`	`nsIRequest`	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.
`groupObserver`	`nsIRequestObserver`	The group observer is notified when `requests` are added to and removed from this load group. The `groupObserver` is weak referenced.
`notificationCallbacks`	`nsIInterfaceRequestor`	Notification callbacks for the load group.
`requests`	`nsISimpleEnumerator`	Returns the `requests` contained directly in this group. Enumerator element type: `nsIRequest`. Read only.

Methods

addRequest()

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 addRequest(
  in nsIRequest aRequest,
  in nsISupports aContext
);

Parameters

aRequest: The request to be added to the load group.
aContext: The context to be passed to the onStartRequest notification.

removeRequest()

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.

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

Parameters

aRequest: The request to be removed from the load group.
aContext: The context to be passed to the onStopRequest notification.
aStatus: The status to be passed to the onStopRequest notification.

Method overview

Attributes

Methods

addRequest()

Parameters

removeRequest()

Parameters

Document Tags and Contributors