gi-gio-2.0.19: Gio bindings

Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell | None
Language | Haskell2010

GI.Gio.Objects.ProxyAddressEnumerator

Contents

- Exported types
- Properties
  - connectable
  - defaultPort
  - proxyResolver
  - uri

Description

`ProxyAddressEnumerator` is a wrapper around `SocketAddressEnumerator` which takes the `SocketAddress` instances returned by the `SocketAddressEnumerator` and wraps them in `ProxyAddress` instances, using the given `ProxyAddressEnumerator`:`proxy-resolver`.

This enumerator will be returned (for example, by `socketConnectableEnumerate`) as appropriate when a proxy is configured; there should be no need to manually wrap a `SocketAddressEnumerator` instance with one.

Synopsis

- newtype ProxyAddressEnumerator = ProxyAddressEnumerator (ManagedPtr ProxyAddressEnumerator)
- class GObject o => IsProxyAddressEnumerator o
- toProxyAddressEnumerator :: (MonadIO m, IsProxyAddressEnumerator o) => o -> m ProxyAddressEnumerator
- noProxyAddressEnumerator :: Maybe ProxyAddressEnumerator
- constructProxyAddressEnumeratorConnectable :: (IsProxyAddressEnumerator o, IsSocketConnectable a) => a -> IO (GValueConstruct o)
- getProxyAddressEnumeratorConnectable :: (MonadIO m, IsProxyAddressEnumerator o) => o -> m (Maybe SocketConnectable)
- constructProxyAddressEnumeratorDefaultPort :: IsProxyAddressEnumerator o => Word32 -> IO (GValueConstruct o)
- getProxyAddressEnumeratorDefaultPort :: (MonadIO m, IsProxyAddressEnumerator o) => o -> m Word32
- clearProxyAddressEnumeratorProxyResolver :: (MonadIO m, IsProxyAddressEnumerator o) => o -> m ()
- constructProxyAddressEnumeratorProxyResolver :: (IsProxyAddressEnumerator o, IsProxyResolver a) => a -> IO (GValueConstruct o)
- getProxyAddressEnumeratorProxyResolver :: (MonadIO m, IsProxyAddressEnumerator o) => o -> m (Maybe ProxyResolver)
- setProxyAddressEnumeratorProxyResolver :: (MonadIO m, IsProxyAddressEnumerator o, IsProxyResolver a) => o -> a -> m ()
- constructProxyAddressEnumeratorUri :: IsProxyAddressEnumerator o => Text -> IO (GValueConstruct o)
- getProxyAddressEnumeratorUri :: (MonadIO m, IsProxyAddressEnumerator o) => o -> m (Maybe Text)

# Exported types

newtype ProxyAddressEnumerator Source #

Memory-managed wrapper type.

Constructors

ProxyAddressEnumerator (ManagedPtr ProxyAddressEnumerator) |

Instances

GObject ProxyAddressEnumerator Source # |
Instance details Defined in GI.Gio.Objects.ProxyAddressEnumerator Methods gobjectType :: ProxyAddressEnumerator -> IO GType Source #
IsObject ProxyAddressEnumerator Source # |
Instance details Defined in GI.Gio.Objects.ProxyAddressEnumerator
IsSocketAddressEnumerator ProxyAddressEnumerator Source # |
Instance details Defined in GI.Gio.Objects.ProxyAddressEnumerator
IsProxyAddressEnumerator ProxyAddressEnumerator Source # |
Instance details Defined in GI.Gio.Objects.ProxyAddressEnumerator

class GObject o => IsProxyAddressEnumerator o Source #

Type class for types which can be safely cast to `ProxyAddressEnumerator`, for instance with `toProxyAddressEnumerator`.

Instances

(GObject a, (UnknownAncestorError ProxyAddressEnumerator a :: Constraint)) => IsProxyAddressEnumerator a Source # |
Instance details Defined in GI.Gio.Objects.ProxyAddressEnumerator
IsProxyAddressEnumerator ProxyAddressEnumerator Source # |
Instance details Defined in GI.Gio.Objects.ProxyAddressEnumerator

toProxyAddressEnumerator :: (MonadIO m, IsProxyAddressEnumerator o) => o -> m ProxyAddressEnumerator Source #

Cast to `ProxyAddressEnumerator`, for types for which this is known to be safe. For general casts, use `castTo`.

noProxyAddressEnumerator :: Maybe ProxyAddressEnumerator Source #

A convenience alias for `Nothing` :: `Maybe` `ProxyAddressEnumerator`.

# Properties

## connectable

No description available in the introspection data.

constructProxyAddressEnumeratorConnectable :: (IsProxyAddressEnumerator o, IsSocketConnectable a) => a -> IO (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`connectable`” property. This is rarely needed directly, but it is used by `new`.

getProxyAddressEnumeratorConnectable :: (MonadIO m, IsProxyAddressEnumerator o) => o -> m (Maybe SocketConnectable) Source #

Get the value of the “`connectable`” property. When overloading is enabled, this is equivalent to

    get proxyAddressEnumerator #connectable

## defaultPort

The default port to use if `ProxyAddressEnumerator`:`uri` does not specify one.

Since: 2.38

constructProxyAddressEnumeratorDefaultPort :: IsProxyAddressEnumerator o => Word32 -> IO (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`default-port`” property. This is rarely needed directly, but it is used by `new`.

getProxyAddressEnumeratorDefaultPort :: (MonadIO m, IsProxyAddressEnumerator o) => o -> m Word32 Source #

Get the value of the “`default-port`” property. When overloading is enabled, this is equivalent to

    get proxyAddressEnumerator #defaultPort

## proxyResolver

The proxy resolver to use.

Since: 2.36

clearProxyAddressEnumeratorProxyResolver :: (MonadIO m, IsProxyAddressEnumerator o) => o -> m () Source #

Set the value of the “`proxy-resolver`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #proxyResolver

constructProxyAddressEnumeratorProxyResolver :: (IsProxyAddressEnumerator o, IsProxyResolver a) => a -> IO (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`proxy-resolver`” property. This is rarely needed directly, but it is used by `new`.

getProxyAddressEnumeratorProxyResolver :: (MonadIO m, IsProxyAddressEnumerator o) => o -> m (Maybe ProxyResolver) Source #

Get the value of the “`proxy-resolver`” property. When overloading is enabled, this is equivalent to

    get proxyAddressEnumerator #proxyResolver

setProxyAddressEnumeratorProxyResolver :: (MonadIO m, IsProxyAddressEnumerator o, IsProxyResolver a) => o -> a -> m () Source #

Set the value of the “`proxy-resolver`” property. When overloading is enabled, this is equivalent to

    set proxyAddressEnumerator [ #proxyResolver := value ]

## uri

No description available in the introspection data.

constructProxyAddressEnumeratorUri :: IsProxyAddressEnumerator o => Text -> IO (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`uri`” property. This is rarely needed directly, but it is used by `new`.

getProxyAddressEnumeratorUri :: (MonadIO m, IsProxyAddressEnumerator o) => o -> m (Maybe Text) Source #

Get the value of the “`uri`” property. When overloading is enabled, this is equivalent to

    get proxyAddressEnumerator #uri