gi-gio-2.0.35: Gio bindings

Copyright | Will Thompson and Iñaki García Etxebarria
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | Safe-Inferred
Language | Haskell2010

GI.Gio.Objects.ProxyAddressEnumerator

Contents

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

Description

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

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, IsDescendantOf ProxyAddressEnumerator o) => IsProxyAddressEnumerator o
- toProxyAddressEnumerator :: (MonadIO m, IsProxyAddressEnumerator o) => o -> m ProxyAddressEnumerator
- constructProxyAddressEnumeratorConnectable :: (IsProxyAddressEnumerator o, MonadIO m, IsSocketConnectable a) => a -> m (GValueConstruct o)
- getProxyAddressEnumeratorConnectable :: (MonadIO m, IsProxyAddressEnumerator o) => o -> m (Maybe SocketConnectable)
- constructProxyAddressEnumeratorDefaultPort :: (IsProxyAddressEnumerator o, MonadIO m) => Word32 -> m (GValueConstruct o)
- getProxyAddressEnumeratorDefaultPort :: (MonadIO m, IsProxyAddressEnumerator o) => o -> m Word32
- clearProxyAddressEnumeratorProxyResolver :: (MonadIO m, IsProxyAddressEnumerator o) => o -> m ()
- constructProxyAddressEnumeratorProxyResolver :: (IsProxyAddressEnumerator o, MonadIO m, IsProxyResolver a) => a -> m (GValueConstruct o)
- getProxyAddressEnumeratorProxyResolver :: (MonadIO m, IsProxyAddressEnumerator o) => o -> m (Maybe ProxyResolver)
- setProxyAddressEnumeratorProxyResolver :: (MonadIO m, IsProxyAddressEnumerator o, IsProxyResolver a) => o -> a -> m ()
- constructProxyAddressEnumeratorUri :: (IsProxyAddressEnumerator o, MonadIO m) => Text -> m (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

Instances details

Eq ProxyAddressEnumerator Source # |
Instance details Defined in GI.Gio.Objects.ProxyAddressEnumerator Methods (==) :: ProxyAddressEnumerator -> ProxyAddressEnumerator -> Bool Source # (/=) :: ProxyAddressEnumerator -> ProxyAddressEnumerator -> Bool Source #
GObject ProxyAddressEnumerator Source # |
Instance details Defined in GI.Gio.Objects.ProxyAddressEnumerator
ManagedPtrNewtype ProxyAddressEnumerator Source # |
Instance details Defined in GI.Gio.Objects.ProxyAddressEnumerator Methods toManagedPtr :: ProxyAddressEnumerator -> ManagedPtr ProxyAddressEnumerator Source #
TypedObject ProxyAddressEnumerator Source # |
Instance details Defined in GI.Gio.Objects.ProxyAddressEnumerator Methods glibType :: IO GType Source #
HasParentTypes ProxyAddressEnumerator Source # |
Instance details Defined in GI.Gio.Objects.ProxyAddressEnumerator
IsGValue (Maybe ProxyAddressEnumerator) Source # | Convert `ProxyAddressEnumerator` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gio.Objects.ProxyAddressEnumerator Methods gvalueGType_ :: IO GType Source # gvalueSet_ :: Ptr GValue -> Maybe ProxyAddressEnumerator -> IO () Source # gvalueGet_ :: Ptr GValue -> IO (Maybe ProxyAddressEnumerator) Source #
type ParentTypes ProxyAddressEnumerator Source # |
Instance details Defined in GI.Gio.Objects.ProxyAddressEnumerator type ParentTypes ProxyAddressEnumerator = '[SocketAddressEnumerator, Object]

class (GObject o, IsDescendantOf ProxyAddressEnumerator o) => IsProxyAddressEnumerator o Source #

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

#### Instances

Instances details

(GObject o, IsDescendantOf ProxyAddressEnumerator o) => IsProxyAddressEnumerator o 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`.

# Methods

### Click to display all available methods, including inherited ones

Expand

#### Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, next, nextAsync, nextFinish, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

#### Getters

getData, getProperty, getQdata.

#### Setters

setData, setDataFull, setProperty.

# Properties

## connectable

The connectable being enumerated.

constructProxyAddressEnumeratorConnectable :: (IsProxyAddressEnumerator o, MonadIO m, IsSocketConnectable a) => a -> m (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, MonadIO m) => Word32 -> m (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, MonadIO m, IsProxyResolver a) => a -> m (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

The destination URI. Use `none://` for a generic socket.

constructProxyAddressEnumeratorUri :: (IsProxyAddressEnumerator o, MonadIO m) => Text -> m (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