nsIRequest
IID: | ef6bfbd2-fd46-48d8-96b7-9f8f0fd387fe |
Inherits From: | nsISupports |
Status: | FROZEN |
This interface is implemented by the following components:
- @mozilla.org/image/request;1
- @mozilla.org/network/async-stream-copier;1
- @mozilla.org/network/input-stream-channel;1
- @mozilla.org/network/input-stream-pump;1
- @mozilla.org/network/load-group;1
- @mozilla.org/network/protocol/about;1?what=cache-entry
- @mozilla.org/network/stream-io-channel;1
- @mozilla.org/network/urichecker;1
- @mozilla.org/network/incremental-download;1
Constants
Properties
nsLoadFlags loadFlags
The load flags of this request. Bits 0-15 are reserved.
When added to a load group, this request's load flags are merged with the load flags of the load group.
nsILoadGroup loadGroup
The load group of this request. While pending, the request is a member of the load group. It is the responsibility of the request to implement this policy.
readonly AUTF8String name
The name of the request. Often this is the URI of the request.
readonly nsresult status
The error status associated with the request.
Methods
void cancel ( nsresult status )
PRBool isPending ( )
void resume ( )
void suspend ( )
void cancel ( nsresult status )
Cancels the current request. This will close any open input or output streams and terminate any async requests. Users should normally pass NS_BINDING_ABORTED, although other errors may also be passed. The error passed in will become the value of the status attribute.
NOTE: most nsIRequest implementations expect status to be a failure code; however, some implementations may allow status to be a success code such as NS_OK. In general, status should be a failure code.
- Arguments:
- status: the reason for canceling this request.
- Returns:
- FALSE if the request has reached completion (e.g., after OnStopRequest has fired). Suspended requests are still considered pending.
Resumes the current request. This may have the effect of re-opening any underlying transport and will resume the delivery of data to any open streams.
Suspends the current request. This may have the effect of closing any underlying transport (in order to free up resources), although any open streams remain logically opened and will continue delivering data when the transport is resumed.
NOTE: some implementations are unable to immediately suspend, and may continue to deliver events already posted to an event queue. In general, callers should be capable of handling events even after suspending a request.
References
This interface is the type of the following properties:
nsILoadGroup.defaultLoadRequest, nsIMsgSend.runningRequest, nsIStreamLoader.request
This interface is passed as an argument to the following methods:
nsIContentHandler.handleContent, nsIDirIndexListener.onIndexAvailable, nsIDirIndexListener.onInformationAvailable, nsIDocShell.internalLoad, nsIDownloadObserver.onDownloadComplete, nsIDownloadProgressListener.onLocationChange, nsIDownloadProgressListener.onProgressChange, nsIDownloadProgressListener.onSecurityChange, nsIDownloadProgressListener.onStateChange, nsIDownloadProgressListener.onStatusChange, nsIExternalHelperAppService.doContent, nsILoadGroup.addRequest, nsILoadGroup.removeRequest, nsIProgressEventSink.onProgress, nsIProgressEventSink.onStatus, nsIRequestObserver.onStartRequest, nsIRequestObserver.onStopRequest, nsISmtpService.SendMailMessage, nsIStreamListener.onDataAvailable, nsIURIContentListener.doContent, nsIUnicharStreamListener.onUnicharDataAvailable, nsIWebProgressListener.onLocationChange, nsIWebProgressListener.onProgressChange, nsIWebProgressListener.onSecurityChange, nsIWebProgressListener.onStateChange, nsIWebProgressListener.onStatusChange, nsIWebProgressListener2.onProgressChange64
Reference documentation is generated from Mozilla's source.