WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

@mozilla.org/network/incremental-download;1

This component implements the following interfaces:

Constants

No special load flags:
PRUint32 nsIRequest.LOAD_NORMAL = 0
Don't deliver status notifications to the nsIProgressEventSink, or keep this load from completing the nsILoadGroup it may belong to.
PRUint32 nsIRequest.LOAD_BACKGROUND = 1
This flag prevents caching of any kind. It does not, however, prevent cached content from being used to satisfy this request.
PRUint32 nsIRequest.INHIBIT_CACHING = 128
This flag prevents caching on disk (or other persistent media), which may be needed to preserve privacy. For HTTPS, this flag is set auto- matically.
PRUint32 nsIRequest.INHIBIT_PERSISTENT_CACHING = 256
Force an end-to-end download of content data from the origin server. This flag is used for a shift-reload.
PRUint32 nsIRequest.LOAD_BYPASS_CACHE = 512
Load from the cache, bypassing protocol specific validation logic. This flag is used when browsing via history. It is not recommended for normal browsing as it may likely violate reasonable assumptions made by the server and confuse users.
PRUint32 nsIRequest.LOAD_FROM_CACHE = 1024
The following flags control the frequency of cached content validation when neither LOAD_BYPASS_CACHE or LOAD_FROM_CACHE are set. By default, cached content is automatically validated if necessary before reuse.

VALIDATE_ALWAYS forces validation of any cached content independent of its expiration time.

VALIDATE_NEVER disables validation of expired content.

VALIDATE_ONCE_PER_SESSION disables validation of expired content, provided it has already been validated (at least once) since the start of this session.

NOTE TO IMPLEMENTORS: These flags are intended for normal browsing, and they should therefore not apply to content that must be validated before each use. Consider, for example, a HTTP response with a "Cache-control: no-cache" header. According to RFC2616, this response must be validated before it can be taken from a cache. Breaking this requirement could result in incorrect and potentially undesirable side-effects.

PRUint32 nsIRequest.VALIDATE_ALWAYS = 2048
PRUint32 nsIRequest.VALIDATE_NEVER = 4096
PRUint32 nsIRequest.VALIDATE_ONCE_PER_SESSION = 8192

Properties

readonly PRInt64 nsIIncrementalDownload.currentSize

The current number of bytes downloaded so far. This attribute is set just prior to calling OnStartRequest on the observer passed to the start method.

This attribute has a value of -1 if the current size is unknown.

readonly nsIFile nsIIncrementalDownload.destination

The file where the download is being written.

readonly nsIURI nsIIncrementalDownload.finalURI

The URI being fetched after any redirects have been followed. This attribute is set just prior to calling OnStartRequest on the observer passed to the start method.

nsLoadFlags nsIRequest.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 nsIRequest.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 nsIRequest.name

The name of the request. Often this is the URI of the request.

readonly nsresult nsIRequest.status

The error status associated with the request.

readonly PRInt64 nsIIncrementalDownload.totalSize

The total number of bytes for the requested file. This attribute is set just prior to calling OnStartRequest on the observer passed to the start method.

This attribute has a value of -1 if the total size is unknown.

readonly nsIURI nsIIncrementalDownload.URI

The URI being fetched.

Methods

InterfaceMethod
nsIRequest void cancel ( nsresult status )
nsISupportsWeakReference nsIWeakReference GetWeakReference ( )
nsIIncrementalDownload void init ( nsIURI uri , nsIFile destination , PRInt32 chunkSize , PRInt32 intervalInSeconds )
nsIRequest PRBool isPending ( )
nsIObserver void observe ( nsISupports subject , char* topic , PRUnichar* data )
nsIStreamListener void onDataAvailable ( nsIRequest request , nsISupports context , nsIInputStream inputStream , PRUint32 offset , PRUint32 count )
nsIRequestObserver void onStartRequest ( nsIRequest request , nsISupports context )
nsIRequestObserver void onStopRequest ( nsIRequest request , nsISupports context , nsresult statusCode )
nsIRequest void resume ( )
nsIIncrementalDownload void start ( nsIRequestObserver observer , nsISupports ctxt )
nsIRequest void suspend ( )

Reference documentation is generated from Mozilla's source.

Copyright © 1999-2006 XULPlanet.com