/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.1 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is Bradley Baetz
 * Portions created by the Initial Developer are Copyright (C) 2001, 2002
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s): Bradley Baetz <bbaetz@student.usyd.edu.au>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or 
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"
 
interface nsIStreamListener;
interface nsIResumableEntityID;

[scriptable, uuid(87cccd68-1dd2-11b2-8b66-cbf10a1b6438)]
interface nsIResumableChannel : nsISupports {
    /**
     * Open this channel, and read starting at the specified offset.
     * @param listener - As for asyncOpen
     * @param ctxt - As for asyncOpen
     * @param startPos - the starting offset, in bytes, to use to download
     * @param info - information about the file, to match before obtaining
     *  the file. Pass null to use anything.
     * OnStartRequest wil have a status of NS_ERROR_NOT_RESUMABLE if the file
     *  cannot be resumed, eg because the server doesn't support this, or the
     *  nsIFileInfo doesn't match. This error may be occur even if startPos
     *  is 0, so that the front end can warn the user.
     *
     * 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);

    /**
     * The nsIResumableEntityID for this uri. Available after OnStartRequest
     * If this attribute is null, then this load is not resumable.
     */
    readonly attribute nsIResumableEntityID entityID;
};