/gecko_sdk/idl/nsIRequestObserver.idl
IDL | 75 lines | 11 code | 4 blank | 60 comment | 0 complexity | 468911b4ca5ff4b5ab077c3d5c785b79 MD5 | raw file
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ 2/* ***** BEGIN LICENSE BLOCK ***** 3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1 4 * 5 * The contents of this file are subject to the Mozilla Public License Version 6 * 1.1 (the "License"); you may not use this file except in compliance with 7 * the License. You may obtain a copy of the License at 8 * http://www.mozilla.org/MPL/ 9 * 10 * Software distributed under the License is distributed on an "AS IS" basis, 11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 12 * for the specific language governing rights and limitations under the 13 * License. 14 * 15 * The Original Code is mozilla.org code. 16 * 17 * The Initial Developer of the Original Code is 18 * Netscape Communications Corporation. 19 * Portions created by the Initial Developer are Copyright (C) 1998 20 * the Initial Developer. All Rights Reserved. 21 * 22 * Contributor(s): 23 * 24 * Alternatively, the contents of this file may be used under the terms of 25 * either the GNU General Public License Version 2 or later (the "GPL"), or 26 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), 27 * in which case the provisions of the GPL or the LGPL are applicable instead 28 * of those above. If you wish to allow use of your version of this file only 29 * under the terms of either the GPL or the LGPL, and not to allow others to 30 * use your version of this file under the terms of the MPL, indicate your 31 * decision by deleting the provisions above and replace them with the notice 32 * and other provisions required by the GPL or the LGPL. If you do not delete 33 * the provisions above, a recipient may use your version of this file under 34 * the terms of any one of the MPL, the GPL or the LGPL. 35 * 36 * ***** END LICENSE BLOCK ***** */ 37 38#include "nsISupports.idl" 39 40interface nsIRequest; 41 42/** 43 * nsIRequestObserver 44 * 45 * @status FROZEN 46 */ 47[scriptable, uuid(fd91e2e0-1481-11d3-9333-00104ba0fd40)] 48interface nsIRequestObserver : nsISupports 49{ 50 /** 51 * Called to signify the beginning of an asynchronous request. 52 * 53 * @param aRequest request being observed 54 * @param aContext user defined context 55 * 56 * An exception thrown from onStartRequest has the side-effect of 57 * causing the request to be canceled. 58 */ 59 void onStartRequest(in nsIRequest aRequest, 60 in nsISupports aContext); 61 62 /** 63 * Called to signify the end of an asynchronous request. This 64 * call is always preceded by a call to onStartRequest. 65 * 66 * @param aRequest request being observed 67 * @param aContext user defined context 68 * @param aStatusCode reason for stopping (NS_OK if completed successfully) 69 * 70 * An exception thrown from onStopRequest is generally ignored. 71 */ 72 void onStopRequest(in nsIRequest aRequest, 73 in nsISupports aContext, 74 in nsresult aStatusCode); 75};