Module: Gio::ProxyResolver

Defined in:
(unknown)

Overview

GProxy::Resolver provides synchronous and asynchronous network proxy resolution. GProxy::Resolver is used within #GSocketClient through the method g_socket_connectable_proxy_enumerate().

Implementations of GProxy::Resolver based on libproxy and GNOME settings can be found in glib-networking. GIO comes with an implementation for use inside Flatpak portals.

Instance Method Summary collapse

Instance Method Details

#is_supportedTrueClass

Checks if resolver can be used on this system. (This is used internally; g_proxy_resolver_get_default() will only return a proxy resolver that returns true for this method.)

Returns:

  • (TrueClass)

    true if resolver is supported.

#lookup(uri, cancellable) ⇒ Array<String>

Looks into the system proxy configuration to determine what proxy, if any, to use to connect to uri. The returned proxy URIs are of the form ‘<protocol>://[user@]host:port` or `direct://`, where <protocol> could be http, rtsp, socks or other proxying protocol.

If you don’t know what network protocol is being used on the socket, you should use ‘none` as the URI protocol. In this case, the resolver might still return a generic proxy type (such as SOCKS), but would not return protocol-specific proxy types (such as http).

‘direct://` is used when no proxy is needed. Direct connection should not be attempted unless it is part of the returned array of proxies.

Parameters:

  • uri (String)

    a URI representing the destination to connect to

  • cancellable (Gio::Cancellable)

    a #GCancellable, or nil

Returns:

  • (Array<String>)

    A NULL-terminated array of proxy URIs. Must be freed with g_strfreev().

#lookup_async(uri, cancellable, callback, user_data) ⇒ nil

Asynchronous lookup of proxy. See g_proxy_resolver_lookup() for more details.

Parameters:

  • uri (String)

    a URI representing the destination to connect to

  • cancellable (Gio::Cancellable)

    a #GCancellable, or nil

  • callback (Gio::AsyncReadyCallback)

    callback to call after resolution completes

  • user_data (GObject)

    data for callback

Returns:

  • (nil)

#lookup_finish(result) ⇒ Array<String>

Call this function to obtain the array of proxy URIs when g_proxy_resolver_lookup_async() is complete. See g_proxy_resolver_lookup() for more details.

Parameters:

Returns:

  • (Array<String>)

    A NULL-terminated array of proxy URIs. Must be freed with g_strfreev().