nsIResumableChannel

This interface is meant to be implemented by the channels that support resuming broken downloads (for example Necko's HTML and FTP channels).
Inherits from: nsISupports Last changed in Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

Method overview

void asyncOpenAt(in nsIStreamListener listener, in nsISupports ctxt, in unsigned long startPos, in nsIResumableEntityID entityID); Obsolete since Gecko 1.8
void resumeAt(in unsigned long long startPos, in ACString entityID);

Attributes

Attribute Type Description
entityID ACString The entity id for this URI. Available after OnStartRequest. Read only.
Exceptions thrown
NS_ERROR_NOT_RESUMABLE
If this load is not resumable.

Methods

Obsolete since Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

asyncOpenAt()

Open this channel, and read starting at the specified offset.

The request given to the nsIStreamListener will be QIable to nsIResumableInfo.

void asyncOpenAt(
  in nsIStreamListener listener,
  in nsISupports ctxt,
  in unsigned long startPos,
  in nsIResumableEntityID entityID
);
Parameters
listener
As for asyncOpen.
ctxt
As for asyncOpen.
startPos
The starting offset, in bytes, to use to download.
entityID
Information about the file, to match before obtaining the file. Pass an empty string to use anything.

Requires Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

resumeAt()

Prepare this channel for resuming. The request will not start until asyncOpen or open is called. Calling resumeAt after open or asyncOpen has been called has undefined behaviour.

During OnStartRequest, this channel will have a status of NS_ERROR_NOT_RESUMABLE if the file cannot be resumed, for example because the server doesn't support this. This error may occur even if startPos is 0, so that the front end can warn the user.

Similarly, the status of this channel during OnStartRequest may be NS_ERROR_ENTITY_CHANGED, which indicates that the entity has changed, as indicated by a changed entityID.

In both of these cases, no OnDataAvailable will be called, and OnStopRequest will immediately follow with the same status code.

void resumeAt(
  in unsigned long long startPos,
  in ACString entityID
);
Parameters
startPos
The starting offset, in bytes, to use to download.
entityID
Information about the file, to match before obtaining the file. Pass an empty string to use anything.

See also

Document Tags and Contributors

Contributors to this page: Sheppy, trevorh, Ted_Mielczarek, Nickolay
Last updated by: Sheppy,