Back to index

lightning-sunbird  0.9+nobinonly
nsIRequest.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #include "nsISupports.idl"
00039 
00040 interface nsILoadGroup;
00041 
00042 typedef unsigned long nsLoadFlags;
00043 
00049 [scriptable, uuid(ef6bfbd2-fd46-48d8-96b7-9f8f0fd387fe)]
00050 interface nsIRequest : nsISupports
00051 {
00055     readonly attribute AUTF8String name;
00056 
00072     boolean isPending();
00073 
00077     readonly attribute nsresult status;
00078 
00093     void cancel(in nsresult aStatus);
00094 
00106     void suspend();
00107 
00113     void resume();
00114 
00120     attribute nsILoadGroup loadGroup;
00121 
00128     attribute nsLoadFlags loadFlags;
00129 
00130     /**************************************************************************
00131      * Listed below are the various load flags which may be or'd together.
00132      */
00133 
00137     const unsigned long LOAD_NORMAL = 0;
00138 
00143     const unsigned long LOAD_BACKGROUND = 1 << 0; 
00144 
00145     /**************************************************************************
00146      * The following flags control the flow of data into the cache.
00147      */
00148 
00153     const unsigned long INHIBIT_CACHING = 1 << 7;
00154 
00160     const unsigned long INHIBIT_PERSISTENT_CACHING = 1 << 8;
00161 
00162     /**************************************************************************
00163      * The following flags control what happens when the cache contains data
00164      * that could perhaps satisfy this request.  They are listed in descending
00165      * order of precidence.
00166      */
00167 
00172     const unsigned long LOAD_BYPASS_CACHE = 1 << 9;
00173 
00180     const unsigned long LOAD_FROM_CACHE   = 1 << 10;
00181 
00204     const unsigned long VALIDATE_ALWAYS           = 1 << 11;
00205     const unsigned long VALIDATE_NEVER            = 1 << 12;
00206     const unsigned long VALIDATE_ONCE_PER_SESSION = 1 << 13;
00207 };