Gio.SocketAddressEnumerator - Classes - Gio 2.0 (original) (raw)
g GObject.Object GObject.Object Gio.SocketAddressEnumerator Gio.SocketAddressEnumerator GObject.Object->Gio.SocketAddressEnumerator
Subclasses:
Methods¶
Inherited:
Structs:
| next (cancellable) |
|---|
| next_async (cancellable, callback, *user_data) |
| next_finish (result) |
Virtual Methods¶
Inherited:
| do_next (cancellable) |
|---|
| do_next_async (cancellable, callback, *user_data) |
| do_next_finish (result) |
Properties¶
None
Signals¶
Inherited:
Fields¶
Inherited:
| Name | Type | Access | Description |
|---|---|---|---|
| parent_instance | GObject.Object | r |
Class Details¶
class Gio.SocketAddressEnumerator(**kwargs)¶
Bases:
Abstract:
Yes
Structure:
Gio.SocketAddressEnumeratorClass
GSocketAddressEnumerator is an enumerator type for [class`Gio`.SocketAddress] instances. It is returned by enumeration functions such as [method`Gio`.SocketConnectable.enumerate], which returns aGSocketAddressEnumerator to list each [class`Gio`.SocketAddress] which could be used to connect to that [iface`Gio`.SocketConnectable].
Enumeration is typically a blocking operation, so the asynchronous methods [method`Gio`.SocketAddressEnumerator.next_async] and [method`Gio`.SocketAddressEnumerator.next_finish] should be used where possible.
Each GSocketAddressEnumerator can only be enumerated once. Once [method`Gio`.SocketAddressEnumerator.next] has returned NULL, further enumeration with that GSocketAddressEnumerator is not possible, and it can be unreffed.
Parameters:
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, None to ignore.
Raises:
Returns:
a Gio.SocketAddress (owned by the caller), or None on error (in which case *error will be set) or if there are no more addresses.
Return type:
Retrieves the next Gio.SocketAddress from self. Note that this may block for some amount of time. (Eg, a Gio.NetworkAddress may need to do a DNS lookup before it can return an address.) UseGio.SocketAddressEnumerator.next_async() if you need to avoid blocking.
If self is expected to yield addresses, but for some reason is unable to (eg, because of a DNS error), then the first call toGio.SocketAddressEnumerator.next() will return an appropriate error in *error. However, if the first call toGio.SocketAddressEnumerator.next() succeeds, then any further internal errors (other than cancellable being triggered) will be ignored.
next_async(cancellable, callback, *user_data)[source]¶
Parameters:
- cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, None to ignore.
- callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when the request is satisfied
- user_data (object or None) – the data to pass to callback function
Asynchronously retrieves the next Gio.SocketAddress from selfand then calls callback, which must callGio.SocketAddressEnumerator.next_finish() to get the result.
It is an error to call this multiple times before the previous callback has finished.
Parameters:
result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:
Returns:
a Gio.SocketAddress (owned by the caller), or None on error (in which case *error will be set) or if there are no more addresses.
Return type:
Retrieves the result of a completed call toGio.SocketAddressEnumerator.next_async(). SeeGio.SocketAddressEnumerator.next() for more information about error handling.
do_next(cancellable) virtual¶
Parameters:
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, None to ignore.
Returns:
a Gio.SocketAddress (owned by the caller), or None on error (in which case *error will be set) or if there are no more addresses.
Return type:
Retrieves the next Gio.SocketAddress from enumerator. Note that this may block for some amount of time. (Eg, a Gio.NetworkAddress may need to do a DNS lookup before it can return an address.) UseGio.SocketAddressEnumerator.next_async() 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 toGio.SocketAddressEnumerator.next() will return an appropriate error in *error. However, if the first call toGio.SocketAddressEnumerator.next() succeeds, then any further internal errors (other than cancellable being triggered) will be ignored.
do_next_async(cancellable, callback, *user_data) virtual¶
Parameters:
- cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, None to ignore.
- callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when the request is satisfied
- user_data (object or None) – the data to pass to callback function
Asynchronously retrieves the next Gio.SocketAddress from enumeratorand then calls callback, which must callGio.SocketAddressEnumerator.next_finish() to get the result.
It is an error to call this multiple times before the previous callback has finished.
do_next_finish(result) virtual¶
Parameters:
result (Gio.AsyncResult) – a Gio.AsyncResult
Returns:
a Gio.SocketAddress (owned by the caller), or None on error (in which case *error will be set) or if there are no more addresses.
Return type:
Retrieves the result of a completed call toGio.SocketAddressEnumerator.next_async(). SeeGio.SocketAddressEnumerator.next() for more information about error handling.