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.

nsIResumableChannel

IID:4ad136fa-83af-4a22-a76e-503642c0f4a8
Inherits From:nsISupports

Properties

readonly ACString entityID

The entity id for this URI. Available after OnStartRequest.


Methods

void resumeAt ( PRUint64 startPos , ACString entityID )

void resumeAt ( PRUint64 startPos , ACString entityID )

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, eg 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.

Arguments:
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.

Reference documentation is generated from Mozilla's source.