netwerk/base/nsIProxiedChannel.idl

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 #include "nsISupports.idl"
   6
   7 interface nsIProxyInfo;
   8
   9 /**
  10  * An interface for accessing the proxy info that a channel was
  11  * constructed with.
  12  *
  13  * @see nsIProxiedProtocolHandler
  14  */
  15 [scriptable, uuid(6238f134-8c3f-4354-958f-dfd9d54a4446)]
  16 interface nsIProxiedChannel : nsISupports
  17 {
  18   /**
  19    * Gets the proxy info the channel was constructed with. null or a
  20    * proxyInfo with type "direct" mean no proxy.
  21    *
  22    * The returned proxy info must not be modified.
  23    */
  24   readonly attribute nsIProxyInfo proxyInfo;
  25
  26   /**
  27    * The HTTP response code returned from the proxy to the CONNECT method.
  28    * The response code is only available when we get the response from
  29    * the proxy server, so this value is known in and after OnStartRequest.
  30    *
  31    * If CONNECT method is not used, httpProxyConnectResponseCode is always -1.
  32    * After OnStartRequest, httpProxyConnectResponseCode is the real HTTP
  33    * response code or 0 if we can't reach to the proxy.
  34    */
  35   readonly attribute int32_t httpProxyConnectResponseCode;
  36 };