gio/org.gtkkn.bindings.gio/SocketAddressEnumerator

SocketAddressEnumerator

open class SocketAddressEnumerator(pointer: <Error class: unknown class><<Error class: unknown class>>)

#GSocketAddressEnumerator is an enumerator type for #GSocketAddress instances. It is returned by enumeration functions such as g_socket_connectable_enumerate(), which returns a #GSocketAddressEnumerator to list each #GSocketAddress which could be used to connect to that #GSocketConnectable.

Enumeration is typically a blocking operation, so the asynchronous methods g_socket_address_enumerator_next_async() and g_socket_address_enumerator_next_finish() should be used where possible.

Each #GSocketAddressEnumerator can only be enumerated once. Once g_socket_address_enumerator_next() has returned null, further enumeration with that #GSocketAddressEnumerator is not possible, and it can be unreffed.

Inheritors

ProxyAddressEnumerator

Constructors

SocketAddressEnumerator

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

gioSocketAddressEnumeratorPointer

val gioSocketAddressEnumeratorPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

open fun next(cancellable: Cancellable? = null): <Error class: unknown class><SocketAddress>

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

nextAsync

open fun nextAsync(cancellable: Cancellable? = null, callback: AsyncReadyCallback)

Asynchronously retrieves the next #GSocketAddress from @enumerator and then calls @callback, which must call g_socket_address_enumerator_next_finish() to get the result.

nextFinish

open fun nextFinish(result: AsyncResult): <Error class: unknown class><SocketAddress>

Retrieves the result of a completed call to g_socket_address_enumerator_next_async(). See g_socket_address_enumerator_next() for more information about error handling.