GI.Gio.Interfaces.ProxyResolver

ProxyResolver provides synchronous and asynchronous network proxy resolution. ProxyResolver is used within SocketClient through the method socketConnectableProxyEnumerate.

Exported types

newtype ProxyResolver

Constructors

ProxyResolver (ManagedPtr ProxyResolver)

Instances

GObject ProxyResolver

Methods

gobjectType :: ProxyResolver -> IO GType

IsObject ProxyResolver

IsProxyResolver ProxyResolver

((~) * info (ResolveProxyResolverMethod t ProxyResolver), MethodInfo * info ProxyResolver p) => IsLabel t (ProxyResolver -> p)

Methods

fromLabel :: Proxy# Symbol t -> ProxyResolver -> p

((~) * info (ResolveProxyResolverMethod t ProxyResolver), MethodInfo * info ProxyResolver p) => IsLabelProxy t (ProxyResolver -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> ProxyResolver -> p

HasAttributeList * ProxyResolver

type AttributeList ProxyResolver

type AttributeList ProxyResolver

type SignalList ProxyResolver

type SignalList ProxyResolver

noProxyResolver :: Maybe ProxyResolver

class GObject o => IsProxyResolver o

Instances

(GObject a, UnknownAncestorError Constraint ProxyResolver a) => IsProxyResolver a

IsProxyResolver ProxyResolver

IsProxyResolver SimpleProxyResolver

toProxyResolver :: IsProxyResolver o => o -> IO ProxyResolver

Methods

getDefault

proxyResolverGetDefault

Arguments

:: (HasCallStack, MonadIO m)

=> m ProxyResolver

Returns: the default ProxyResolver.

Gets the default ProxyResolver for the system.

Since: 2.26

isSupported

data ProxyResolverIsSupportedMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsProxyResolver a) => MethodInfo * ProxyResolverIsSupportedMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ProxyResolverIsSupportedMethodInfo a -> signature -> s

proxyResolverIsSupported

Arguments

:: (HasCallStack, MonadIO m, IsProxyResolver a)

=> a

resolver: a ProxyResolver

-> m Bool

Returns: True if resolver is supported.

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

Since: 2.26

lookup

data ProxyResolverLookupMethodInfo

Instances

((~) * signature (Text -> Maybe b -> m [Text]), MonadIO m, IsProxyResolver a, IsCancellable b) => MethodInfo * ProxyResolverLookupMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ProxyResolverLookupMethodInfo a -> signature -> s

proxyResolverLookup

Arguments

:: (HasCallStack, MonadIO m, IsProxyResolver a, IsCancellable b)

=> a

resolver: a ProxyResolver

-> Text

uri: a URI representing the destination to connect to

-> Maybe b

cancellable: a Cancellable, or Nothing

-> m [Text]

Returns: A NULL-terminated array of proxy URIs. Must be freed with strfreev. (Can throw GError)

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.

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.

Since: 2.26

lookupAsync

data ProxyResolverLookupAsyncMethodInfo

Instances

((~) * signature (Text -> Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsProxyResolver a, IsCancellable b) => MethodInfo * ProxyResolverLookupAsyncMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ProxyResolverLookupAsyncMethodInfo a -> signature -> s

proxyResolverLookupAsync

Arguments

:: (HasCallStack, MonadIO m, IsProxyResolver a, IsCancellable b)

=> a

resolver: a ProxyResolver

-> Text

uri: a URI representing the destination to connect to

-> Maybe b

cancellable: a Cancellable, or Nothing

-> Maybe AsyncReadyCallback

callback: callback to call after resolution completes

-> m ()

Asynchronous lookup of proxy. See proxyResolverLookup for more details.

Since: 2.26

lookupFinish

data ProxyResolverLookupFinishMethodInfo

Instances

((~) * signature (b -> m [Text]), MonadIO m, IsProxyResolver a, IsAsyncResult b) => MethodInfo * ProxyResolverLookupFinishMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ProxyResolverLookupFinishMethodInfo a -> signature -> s

proxyResolverLookupFinish

Arguments

:: (HasCallStack, MonadIO m, IsProxyResolver a, IsAsyncResult b)

=> a

resolver: a ProxyResolver

-> b

result: the result passed to your AsyncReadyCallback

-> m [Text]

Returns: A NULL-terminated array of proxy URIs. Must be freed with strfreev. (Can throw GError)

Call this function to obtain the array of proxy URIs when proxyResolverLookupAsync is complete. See proxyResolverLookup for more details.

Since: 2.26