GI.Gio.Objects.SocketAddressEnumerator

GSocketAddressEnumerator is an enumerator type for SocketAddress instances. It is returned by enumeration functions such as socketConnectableEnumerate, which returns a GSocketAddressEnumerator to list each SocketAddress which could be used to connect to that SocketConnectable.

Enumeration is typically a blocking operation, so the asynchronous methods socketAddressEnumeratorNextAsync and socketAddressEnumeratorNextFinish should be used where possible.

Each GSocketAddressEnumerator can only be enumerated once. Once socketAddressEnumeratorNext has returned NULL, further enumeration with that GSocketAddressEnumerator is not possible, and it can be unreffed.

Exported types

newtype SocketAddressEnumerator

Memory-managed wrapper type.

Constructors

SocketAddressEnumerator (ManagedPtr SocketAddressEnumerator)

Instances

Eq SocketAddressEnumerator

Defined in GI.Gio.Objects.SocketAddressEnumerator

Methods

(==) :: SocketAddressEnumerator -> SocketAddressEnumerator -> Bool

(/=) :: SocketAddressEnumerator -> SocketAddressEnumerator -> Bool

GObject SocketAddressEnumerator

Defined in GI.Gio.Objects.SocketAddressEnumerator

ManagedPtrNewtype SocketAddressEnumerator

Defined in GI.Gio.Objects.SocketAddressEnumerator

Methods

toManagedPtr :: SocketAddressEnumerator -> ManagedPtr SocketAddressEnumerator

TypedObject SocketAddressEnumerator

Defined in GI.Gio.Objects.SocketAddressEnumerator

Methods

glibType :: IO GType

HasParentTypes SocketAddressEnumerator

Defined in GI.Gio.Objects.SocketAddressEnumerator

IsGValue (Maybe SocketAddressEnumerator)

Convert SocketAddressEnumerator to and from GValue. See toGValue and fromGValue.

Defined in GI.Gio.Objects.SocketAddressEnumerator

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe SocketAddressEnumerator -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe SocketAddressEnumerator)

type ParentTypes SocketAddressEnumerator

Defined in GI.Gio.Objects.SocketAddressEnumerator

type ParentTypes SocketAddressEnumerator = '[Object]

class (GObject o, IsDescendantOf SocketAddressEnumerator o) => IsSocketAddressEnumerator o

Type class for types which can be safely cast to SocketAddressEnumerator, for instance with toSocketAddressEnumerator.

Instances

(GObject o, IsDescendantOf SocketAddressEnumerator o) => IsSocketAddressEnumerator o

Defined in GI.Gio.Objects.SocketAddressEnumerator

toSocketAddressEnumerator :: (MonadIO m, IsSocketAddressEnumerator o) => o -> m SocketAddressEnumerator

Cast to SocketAddressEnumerator, 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

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.

next

socketAddressEnumeratorNext

Arguments

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

=> a

enumerator: a SocketAddressEnumerator

-> Maybe b

cancellable: optional Cancellable object, Nothing to ignore.

-> m (Maybe SocketAddress)

Returns: a SocketAddress (owned by the caller), or Nothing on error (in which case *error will be set) or if there are no more addresses. (Can throw GError)

Retrieves the next SocketAddress from enumerator. Note that this may block for some amount of time. (Eg, a NetworkAddress may need to do a DNS lookup before it can return an address.) Use socketAddressEnumeratorNextAsync if you need to avoid blocking.

If enumerator is expected to yield addresses, but for some reason is unable to (eg, because of a DNS error), then the first call to socketAddressEnumeratorNext will return an appropriate error in *error. However, if the first call to socketAddressEnumeratorNext succeeds, then any further internal errors (other than cancellable being triggered) will be ignored.

nextAsync

socketAddressEnumeratorNextAsync

Arguments

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

=> a

enumerator: a SocketAddressEnumerator

-> Maybe b

cancellable: optional Cancellable object, Nothing to ignore.

-> Maybe AsyncReadyCallback

callback: a AsyncReadyCallback to call when the request is satisfied

-> m ()

Asynchronously retrieves the next SocketAddress from enumerator and then calls callback, which must call socketAddressEnumeratorNextFinish to get the result.

It is an error to call this multiple times before the previous callback has finished.

nextFinish

socketAddressEnumeratorNextFinish

Arguments

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

=> a

enumerator: a SocketAddressEnumerator

-> b

result: a AsyncResult

-> m (Maybe SocketAddress)

Returns: a SocketAddress (owned by the caller), or Nothing on error (in which case *error will be set) or if there are no more addresses. (Can throw GError)

Retrieves the result of a completed call to socketAddressEnumeratorNextAsync. See socketAddressEnumeratorNext for more information about error handling.