Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
GI.Gio.Objects.SocketAddressEnumerator
Description
tSocketAddressEnumerator
is an enumerator type for tSocketAddress
instances. It is returned by enumeration functions such as
socketConnectableEnumerate
, which returns a tSocketAddressEnumerator
to list each tSocketAddress
which could be used to connect to that
tSocketConnectable
.
Enumeration is typically a blocking operation, so the asynchronous methods
socketAddressEnumeratorNextAsync
and
socketAddressEnumeratorNextFinish
should be used where possible.
Each tSocketAddressEnumerator
can only be enumerated once. Once
socketAddressEnumeratorNext
has returned Nothing
(and no error), further
enumeration with that tSocketAddressEnumerator
is not possible, and it can
be unreffed.
Synopsis
- newtype SocketAddressEnumerator = SocketAddressEnumerator (ManagedPtr SocketAddressEnumerator)
- class (GObject o, IsDescendantOf SocketAddressEnumerator o) => IsSocketAddressEnumerator o
- toSocketAddressEnumerator :: (MonadIO m, IsSocketAddressEnumerator o) => o -> m SocketAddressEnumerator
- noSocketAddressEnumerator :: Maybe SocketAddressEnumerator
- socketAddressEnumeratorNext :: (HasCallStack, MonadIO m, IsSocketAddressEnumerator a, IsCancellable b) => a -> Maybe b -> m SocketAddress
- socketAddressEnumeratorNextAsync :: (HasCallStack, MonadIO m, IsSocketAddressEnumerator a, IsCancellable b) => a -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- socketAddressEnumeratorNextFinish :: (HasCallStack, MonadIO m, IsSocketAddressEnumerator a, IsAsyncResult b) => a -> b -> m SocketAddress
Exported types
newtype SocketAddressEnumerator Source #
Memory-managed wrapper type.
Constructors
SocketAddressEnumerator (ManagedPtr SocketAddressEnumerator) |
Instances
Eq SocketAddressEnumerator Source # | |
Defined in GI.Gio.Objects.SocketAddressEnumerator Methods (==) :: SocketAddressEnumerator -> SocketAddressEnumerator -> Bool (/=) :: SocketAddressEnumerator -> SocketAddressEnumerator -> Bool | |
GObject SocketAddressEnumerator Source # | |
Defined in GI.Gio.Objects.SocketAddressEnumerator Methods gobjectType :: IO GType | |
IsGValue SocketAddressEnumerator Source # | Convert |
Defined in GI.Gio.Objects.SocketAddressEnumerator Methods toGValue :: SocketAddressEnumerator -> IO GValue fromGValue :: GValue -> IO SocketAddressEnumerator | |
HasParentTypes SocketAddressEnumerator Source # | |
Defined in GI.Gio.Objects.SocketAddressEnumerator | |
type ParentTypes SocketAddressEnumerator Source # | |
Defined in GI.Gio.Objects.SocketAddressEnumerator type ParentTypes SocketAddressEnumerator = Object ': ([] :: [Type]) |
class (GObject o, IsDescendantOf SocketAddressEnumerator o) => IsSocketAddressEnumerator o Source #
Type class for types which can be safely cast to SocketAddressEnumerator
, for instance with toSocketAddressEnumerator
.
Instances
(GObject o, IsDescendantOf SocketAddressEnumerator o) => IsSocketAddressEnumerator o Source # | |
Defined in GI.Gio.Objects.SocketAddressEnumerator |
toSocketAddressEnumerator :: (MonadIO m, IsSocketAddressEnumerator o) => o -> m SocketAddressEnumerator Source #
Cast to SocketAddressEnumerator
, for types for which this is known to be safe. For general casts, use castTo
.
noSocketAddressEnumerator :: Maybe SocketAddressEnumerator Source #
A convenience alias for Nothing
:: Maybe
SocketAddressEnumerator
.
Methods
Overloaded methods
next
socketAddressEnumeratorNext Source #
Arguments
:: (HasCallStack, MonadIO m, IsSocketAddressEnumerator a, IsCancellable b) | |
=> a |
|
-> Maybe b |
|
-> m SocketAddress | Returns: a t |
Retrieves the next tSocketAddress
from enumerator
. Note that this
may block for some amount of time. (Eg, a tNetworkAddress
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 Source #
Arguments
:: (HasCallStack, MonadIO m, IsSocketAddressEnumerator a, IsCancellable b) | |
=> a |
|
-> Maybe b |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Asynchronously retrieves the next tSocketAddress
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 Source #
Arguments
:: (HasCallStack, MonadIO m, IsSocketAddressEnumerator a, IsAsyncResult b) | |
=> a |
|
-> b |
|
-> m SocketAddress | Returns: a t |
Retrieves the result of a completed call to
socketAddressEnumeratorNextAsync
. See
socketAddressEnumeratorNext
for more information about
error handling.