Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIResumableChannel Interface Reference

import "nsIResumableChannel.idl";

Inheritance diagram for nsIResumableChannel:
Inheritance graph
Collaboration diagram for nsIResumableChannel:
Collaboration graph

List of all members.

Public Member Functions

void resumeAt (in unsigned long long startPos, in ACString entityID)
 Prepare this channel for resuming.

Public Attributes

readonly attribute ACString entityID
 The entity id for this URI.

Detailed Description

Definition at line 42 of file nsIResumableChannel.idl.

Member Function Documentation

void nsIResumableChannel::resumeAt ( in unsigned long long  startPos,
in 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.

startPosthe starting offset, in bytes, to use to download
entityIDinformation about the file, to match before obtaining the file. Pass an empty string to use anything.

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.

Member Data Documentation

The entity id for this URI.

Available after OnStartRequest.

NS_ERROR_NOT_RESUMABLEif this load is not resumable.

Definition at line 69 of file nsIResumableChannel.idl.

The documentation for this interface was generated from the following file: