Struct xpcom::interfaces::nsIProxyInfo [] [src]

#[repr(C)]
pub struct nsIProxyInfo { /* fields omitted */ }

interface nsIProxyInfo : nsISupports

/**
 * This interface identifies a proxy server.
 */

Methods

impl nsIProxyInfo
[src]

[src]

Cast this nsIProxyInfo to one of its base interfaces.

impl nsIProxyInfo
[src]

TRANSPARENT_PROXY_RESOLVES_HOST: i64 = 1
/****************************************************************************
   * The following "Proxy Flags" may be bit-wise combined to construct the
   * flags attribute defined on this interface.  All unspecified bits are
   * reserved for future use.
   */
/**
   * This flag is set if the proxy is to perform name resolution itself.  If
   * this is the case, the hostname is used in some fashion, and we shouldn't
   * do any form of DNS lookup ourselves.
   */

[src]

/**
   * This attribute specifies the hostname of the proxy server.
   */

readonly attribute AUTF8String host;

[src]

/**
   * This attribute specifies the port number of the proxy server.
   */

readonly attribute long port;

[src]

/**
   * This attribute specifies the type of the proxy server as an ASCII string.
   *
   * Some special values for this attribute include (but are not limited to)
   * the following:
   *   "http"     HTTP proxy (or SSL CONNECT for HTTPS)
   *   "https"    HTTP proxying over TLS connection to proxy
   *   "socks"    SOCKS v5 proxy
   *   "socks4"   SOCKS v4 proxy
   *   "direct"   no proxy
   *   "unknown"  unknown proxy (see nsIProtocolProxyService::resolve)
   *
   * A future version of this interface may define additional types.
   */

readonly attribute ACString type;

[src]

/**
   * This attribute specifies flags that modify the proxy type.  The value of
   * this attribute is the bit-wise combination of the Proxy Flags defined
   * below.  Any undefined bits are reserved for future use.
   */

readonly attribute unsigned long flags;

[src]

/**
   * This attribute specifies flags that were used by nsIProxyProtocolService when
   * creating this ProxyInfo element.
   */

readonly attribute unsigned long resolveFlags;

[src]

/**
   * Specifies a proxy username.
   */

readonly attribute ACString username;

[src]

/**
   * Specifies a proxy password.
   */

readonly attribute ACString password;

[src]

/**
   * This attribute specifies the failover timeout in seconds for this proxy.
   * If a nsIProxyInfo is reported as failed via nsIProtocolProxyService::
   * getFailoverForProxy, then the failed proxy will not be used again for this
   * many seconds.
   */

readonly attribute unsigned long failoverTimeout;

[src]

/**
   * This attribute specifies the proxy to failover to when this proxy fails.
   */

attribute nsIProxyInfo failoverProxy;

[src]

/**
   * This attribute specifies the proxy to failover to when this proxy fails.
   */

attribute nsIProxyInfo failoverProxy;

Methods from Deref<Target = nsISupports>

[src]

Cast this nsISupports to one of its base interfaces.

[src]

void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);

[src]

[noscript,notxpcom] nsrefcnt AddRef ();

[src]

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for nsIProxyInfo
[src]

IID: nsIID = nsID(1677717874, 9572, 16696, [150, 198, 58, 231, 210, 69, 251, 237])

[src]

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise. Read more

impl RefCounted for nsIProxyInfo
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIProxyInfo
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.