GI.Gio.Objects.SimpleProxyResolver

SimpleProxyResolver is a simple 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.

SimpleProxyResolver 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 socketClientSetProxyResolver.

Exported types

newtype SimpleProxyResolver

Constructors

SimpleProxyResolver (ManagedPtr SimpleProxyResolver)

Instances

GObject SimpleProxyResolver

Methods

gobjectType :: SimpleProxyResolver -> IO GType

IsObject SimpleProxyResolver

IsProxyResolver SimpleProxyResolver

IsSimpleProxyResolver SimpleProxyResolver

class GObject o => IsSimpleProxyResolver o

Instances

(GObject a, UnknownAncestorError Constraint SimpleProxyResolver a) => IsSimpleProxyResolver a

IsSimpleProxyResolver SimpleProxyResolver

toSimpleProxyResolver :: (MonadIO m, IsSimpleProxyResolver o) => o -> m SimpleProxyResolver

noSimpleProxyResolver :: Maybe SimpleProxyResolver

Methods

new

simpleProxyResolverNew

Arguments

:: (HasCallStack, MonadIO m)

=> Maybe Text

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

-> Maybe Text

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

-> m ProxyResolver

Returns: a new SimpleProxyResolver

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

Since: 2.36

setDefaultProxy

simpleProxyResolverSetDefaultProxy

Arguments

:: (HasCallStack, MonadIO m, IsSimpleProxyResolver a)

=> a

resolver: a SimpleProxyResolver

-> Text

defaultProxy: the default proxy to use

-> m ()

Sets the default proxy on resolver, to be used for any URIs that don't match SimpleProxyResolver:ignore-hosts or a proxy set via simpleProxyResolverSetUriProxy.

If defaultProxy starts with "socks://", SimpleProxyResolver will treat it as referring to all three of the socks5, socks4a, and socks4 proxy types.

Since: 2.36

setIgnoreHosts

simpleProxyResolverSetIgnoreHosts

Arguments

:: (HasCallStack, MonadIO m, IsSimpleProxyResolver a)

=> a

resolver: a SimpleProxyResolver

-> Text

ignoreHosts: Nothing-terminated list of hosts/IP addresses to not use a proxy for

-> m ()

Sets the list of ignored hosts.

See SimpleProxyResolver:ignore-hosts for more details on how the ignoreHosts argument is interpreted.

Since: 2.36

setUriProxy

simpleProxyResolverSetUriProxy

Arguments

:: (HasCallStack, MonadIO m, IsSimpleProxyResolver a)

=> a

resolver: a SimpleProxyResolver

-> Text

uriScheme: the URI scheme to add a proxy for

-> Text

proxy: the proxy to use for uriScheme

-> m ()

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

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

Since: 2.36

Properties

defaultProxy

constructSimpleProxyResolverDefaultProxy :: IsSimpleProxyResolver o => Text -> IO (GValueConstruct o)

getSimpleProxyResolverDefaultProxy :: (MonadIO m, IsSimpleProxyResolver o) => o -> m (Maybe Text)

setSimpleProxyResolverDefaultProxy :: (MonadIO m, IsSimpleProxyResolver o) => o -> Text -> m ()

ignoreHosts

clearSimpleProxyResolverIgnoreHosts :: (MonadIO m, IsSimpleProxyResolver o) => o -> m ()

constructSimpleProxyResolverIgnoreHosts :: IsSimpleProxyResolver o => [Text] -> IO (GValueConstruct o)

getSimpleProxyResolverIgnoreHosts :: (MonadIO m, IsSimpleProxyResolver o) => o -> m (Maybe [Text])

setSimpleProxyResolverIgnoreHosts :: (MonadIO m, IsSimpleProxyResolver o) => o -> [Text] -> m ()