Class: Gio::SimpleProxyResolver

Inherits:
Object
  • Object
show all
Defined in:
(unknown)

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.new(default_proxy, ignore_hosts) ⇒ Gio::ProxyResolver

Creates a new GSimple::ProxyResolver. See
GSimple::ProxyResolver:default-proxy and
GSimple::ProxyResolver:ignore-hosts for more details on how the
arguments are interpreted.

Parameters:

  • default_proxy (String) —

    the default proxy to use, eg
    "socks://192.168.1.1"

  • ignore_hosts (Array<String>) —

    an optional list of hosts/IP addresses
    to not use a proxy for.

Returns:

Instance Method Details

#default_proxy ⇒ String

The default proxy URI that will be used for any URI that doesn't
match GSimple::ProxyResolver:ignore-hosts, and doesn't match any
of the schemes set with g_simple_proxy_resolver_set_uri_proxy().

Note that as a special case, if this URI starts with
"socks://", GSimple::ProxyResolver will treat it as referring
to all three of the socks5, socks4a, and socks4 proxy types.

Returns:

  • (String) —

    default-proxy

#default_proxy=(default_proxy) ⇒ String

The default proxy URI that will be used for any URI that doesn't
match GSimple::ProxyResolver:ignore-hosts, and doesn't match any
of the schemes set with g_simple_proxy_resolver_set_uri_proxy().

Note that as a special case, if this URI starts with
"socks://", GSimple::ProxyResolver will treat it as referring
to all three of the socks5, socks4a, and socks4 proxy types.

Parameters:

  • default_proxy (String)

Returns:

  • (String) —

    default-proxy

  • (String) —

    default-proxy

#ignore_hosts ⇒ Gio::

A list of hostnames and IP addresses that the resolver should
allow direct connections to.

Entries can be in one of 4 formats:

  • A hostname, such as "example.com", ".example.com", or
    "*.example.com", any of which match "example.com" or
    any subdomain of it.

  • An IPv4 or IPv6 address, such as "192.168.1.1",
    which matches only that address.

  • A hostname or IP address followed by a port, such as
    "example.com:80", which matches whatever the hostname or IP
    address would match, but only for URLs with the (explicitly)
    indicated port. In the case of an IPv6 address, the address
    part must appear in brackets: "[::1]:443"

  • An IP address range, given by a base address and prefix length,
    such as "fe80::/10", which matches any address in that range.

Note that when dealing with Unicode hostnames, the matching is
done against the ASCII form of the name.

Also note that hostname exclusions apply only to connections made
to hosts identified by name, and IP address exclusions apply only
to connections made to hosts identified by address. That is, if
example.com has an address of 192.168.1.1, and the :ignore-hosts list
contains only "192.168.1.1", then a connection to "example.com"
(eg, via a GNetwork::Address) will use the proxy, and a connection to
"192.168.1.1" (eg, via a GInet::SocketAddress) will not.

These rules match the "ignore-hosts"/"noproxy" rules most
commonly used by other applications.

Returns:

  • (Gio::) —

    ignore-hosts

#ignore_hosts=(ignore_hosts) ⇒ Gio::

A list of hostnames and IP addresses that the resolver should
allow direct connections to.

Entries can be in one of 4 formats:

  • A hostname, such as "example.com", ".example.com", or
    "*.example.com", any of which match "example.com" or
    any subdomain of it.

  • An IPv4 or IPv6 address, such as "192.168.1.1",
    which matches only that address.

  • A hostname or IP address followed by a port, such as
    "example.com:80", which matches whatever the hostname or IP
    address would match, but only for URLs with the (explicitly)
    indicated port. In the case of an IPv6 address, the address
    part must appear in brackets: "[::1]:443"

  • An IP address range, given by a base address and prefix length,
    such as "fe80::/10", which matches any address in that range.

Note that when dealing with Unicode hostnames, the matching is
done against the ASCII form of the name.

Also note that hostname exclusions apply only to connections made
to hosts identified by name, and IP address exclusions apply only
to connections made to hosts identified by address. That is, if
example.com has an address of 192.168.1.1, and the :ignore-hosts list
contains only "192.168.1.1", then a connection to "example.com"
(eg, via a GNetwork::Address) will use the proxy, and a connection to
"192.168.1.1" (eg, via a GInet::SocketAddress) will not.

These rules match the "ignore-hosts"/"noproxy" rules most
commonly used by other applications.

Parameters:

Returns:

  • (Gio::) —

    ignore-hosts

  • (Gio::) —

    ignore-hosts

#set_uri_proxy(uri_scheme, proxy) ⇒ nil

Adds a URI-scheme-specific proxy to resolver; URIs whose scheme
matches uri_scheme (and which don't match
GSimple::ProxyResolver:ignore-hosts) will be proxied via proxy.

As with GSimple::ProxyResolver:default-proxy, if proxy starts with
"socks://", GSimple::ProxyResolver will treat it
as referring to all three of the socks5, socks4a, and socks4 proxy
types.

Parameters:

  • uri_scheme (String) —

    the URI scheme to add a proxy for

  • proxy (String) —

    the proxy to use for uri_scheme

Returns:

  • (nil)