luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-07-24 02:47:52 +02:00
Code Issues Packages Projects Releases Wiki Activity

gio: Add missing documentation for G{Proxy,Socket}AddressEnumerator

Browse Source 
Signed-off-by: Philip Withnall <withnall@endlessm.com>
This commit is contained in:
Philip Withnall
2018-11-28 13:10:55 +00:00
parent 778132d54c
commit c3fbfbd2bd
4 changed files with 54 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
gio/gsocketaddressenumerator.c
View File

@@ -22,6 +22,26 @@
#include "gtask.h"
/**
* SECTION:gsocketaddressenumerator
* @short_description: Enumerator for socket addresses
* @include: gio/gio.h
*
* #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 all the #GSocketAddresses 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 (and no error), further
* enumeration with that #GSocketAddressEnumerator is not possible, and it can
* be unreffed.
*/
G_DEFINE_ABSTRACT_TYPE (GSocketAddressEnumerator, g_socket_address_enumerator, G_TYPE_OBJECT)