gio/org.gtkkn.bindings.gio/SimpleProxyResolver

SimpleProxyResolver

open class SimpleProxyResolver( val gioSimpleProxyResolverPointer: <Error class: unknown class><<Error class: unknown class>>) : ProxyResolver(source)

GSimpleProxyResolver is a simple iface@Gio.ProxyResolver implementation that handles a single default proxy, multiple URI-scheme-specific proxies, and a list of hosts that proxies should not be used for.

GSimpleProxyResolver is never the default proxy resolver, but it can be used as the base class for another proxy resolver implementation, or it can be created and used manually, such as with method@Gio.SocketClient.set_proxy_resolver.

Skipped during bindings generation

method default-proxy: Property has no getter
method ignore-hosts: Property has no getter

Since

2.36

Constructors

SimpleProxyResolver

constructor(gioSimpleProxyResolverPointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

gioProxyPointer

abstract val gioProxyPointer: <Error class: unknown class><<Error class: unknown class>>

gioProxyResolverPointer

open override val gioProxyResolverPointer: <Error class: unknown class><<Error class: unknown class>>

gioSimpleProxyResolverPointer

val gioSimpleProxyResolverPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

connect

open fun connect(connection: IoStream, proxyAddress: ProxyAddress, cancellable: Cancellable? = null): <Error class: unknown class><IoStream>

Given @connection to communicate with a proxy (eg, a #GSocketConnection that is connected to the proxy server), this does the necessary handshake to connect to @proxy_address, and if required, wraps the #GIOStream to handle proxy payload.

connectAsync

open fun connectAsync(connection: IoStream, proxyAddress: ProxyAddress, cancellable: Cancellable? = null, callback: AsyncReadyCallback?)

Asynchronous version of g_proxy_connect().

connectFinish

open fun connectFinish(result: AsyncResult): <Error class: unknown class><IoStream>

See g_proxy_connect().

isSupported

open fun isSupported(): Boolean

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.)

lookup

open fun lookup(uri: String, cancellable: Cancellable? = null): <Error class: unknown class><List<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[:password]@]host[:port] or direct://, where <protocol> could be http, rtsp, socks or other proxying protocol.

lookupAsync

open fun lookupAsync(uri: String, cancellable: Cancellable? = null, callback: AsyncReadyCallback?)

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

lookupFinish

open fun lookupFinish(result: AsyncResult): <Error class: unknown class><List<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.

setDefaultProxy

open fun setDefaultProxy(defaultProxy: String? = null)

Sets the default proxy on @resolver, to be used for any URIs that don't match #GSimpleProxyResolver:ignore-hosts or a proxy set via g_simple_proxy_resolver_set_uri_proxy().

setIgnoreHosts

open fun setIgnoreHosts(ignoreHosts: List<String>)

Sets the list of ignored hosts.

setUriProxy

open fun setUriProxy(uriScheme: String, proxy: String)

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

supportsHostname

open fun supportsHostname(): Boolean

Some proxy protocols expect to be passed a hostname, which they will resolve to an IP address themselves. Others, like SOCKS4, do not allow this. This function will return false if @proxy is implementing such a protocol. When false is returned, the caller should resolve the destination hostname first, and then pass a #GProxyAddress containing the stringified IP address to g_proxy_connect() or g_proxy_connect_async().