netwerk/base/public/nsIProtocolProxyCallback.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim:set ts=2 sw=2 sts=2 et cindent: */
   3 /* ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is mozilla.org code.
  17  *
  18  * The Initial Developer of the Original Code is Google Inc.
  19  * Portions created by the Initial Developer are Copyright (C) 2005
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *  Darin Fisher <darin@meer.net>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40
  41 interface nsIURI;
  42 interface nsIProxyInfo;
  43 interface nsICancelable;
  44
  45 /**
  46  * This interface serves as a closure for nsIProtocolProxyService's
  47  * asyncResolve method.
  48  *
  49  * @status UNDER_REVIEW
  50  */
  51 [scriptable, uuid(a9967200-f95e-45c2-beb3-9b060d874bfd)]
  52 interface nsIProtocolProxyCallback : nsISupports
  53 {
  54   /**
  55    * This method is called when proxy info is available or when an error
  56    * in the proxy resolution occurs.
  57    *
  58    * @param aRequest
  59    *        The value returned from asyncResolve.
  60    * @param aURI
  61    *        The URI passed to asyncResolve.
  62    * @param aProxyInfo
  63    *        The resulting proxy info or null if there is no associated proxy
  64    *        info for aURI.  As with the result of nsIProtocolProxyService's
  65    *        resolve method, a null result implies that a direct connection
  66    *        should be used.
  67    * @param aStatus
  68    *        The status of the callback.  This is a failure code if the request
  69    *        could not be satisfied, in which case the value of aStatus
  70    *        indicates the reason for the failure and aProxyInfo will be null.
  71    */
  72   void onProxyAvailable(in nsICancelable aRequest,
  73                         in nsIURI aURI,
  74                         in nsIProxyInfo aProxyInfo,
  75                         in nsresult aStatus);
  76 };