netwerk/base/public/nsIRequestObserver.idl

Thu, 22 Jan 2015 13:21:57 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 22 Jan 2015 13:21:57 +0100
branch
TOR_BUG_9701
changeset 15
b8a032363ba2
permissions
-rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

michael@0 1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
michael@0 2 /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0 3 * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0 4 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0 5
michael@0 6 #include "nsISupports.idl"
michael@0 7
michael@0 8 interface nsIRequest;
michael@0 9
michael@0 10 /**
michael@0 11 * nsIRequestObserver
michael@0 12 */
michael@0 13 [scriptable, uuid(fd91e2e0-1481-11d3-9333-00104ba0fd40)]
michael@0 14 interface nsIRequestObserver : nsISupports
michael@0 15 {
michael@0 16 /**
michael@0 17 * Called to signify the beginning of an asynchronous request.
michael@0 18 *
michael@0 19 * @param aRequest request being observed
michael@0 20 * @param aContext user defined context
michael@0 21 *
michael@0 22 * An exception thrown from onStartRequest has the side-effect of
michael@0 23 * causing the request to be canceled.
michael@0 24 */
michael@0 25 void onStartRequest(in nsIRequest aRequest,
michael@0 26 in nsISupports aContext);
michael@0 27
michael@0 28 /**
michael@0 29 * Called to signify the end of an asynchronous request. This
michael@0 30 * call is always preceded by a call to onStartRequest.
michael@0 31 *
michael@0 32 * @param aRequest request being observed
michael@0 33 * @param aContext user defined context
michael@0 34 * @param aStatusCode reason for stopping (NS_OK if completed successfully)
michael@0 35 *
michael@0 36 * An exception thrown from onStopRequest is generally ignored.
michael@0 37 */
michael@0 38 void onStopRequest(in nsIRequest aRequest,
michael@0 39 in nsISupports aContext,
michael@0 40 in nsresult aStatusCode);
michael@0 41 };

mercurial