luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-12 07:26:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Move the GSocketClient SECTION

Browse Source 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
This commit is contained in:
Philip Withnall 2023-10-24 10:58:10 +01:00
parent 4f4ca75b4d
commit 43b4e7e097
1 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
gio/gsocketclient.c
View File

@ -64,23 +64,20 @@
#define HAPPY_EYEBALLS_CONNECTION_ATTEMPT_TIMEOUT_MS 250 #define HAPPY_EYEBALLS_CONNECTION_ATTEMPT_TIMEOUT_MS 250
/** /**
* SECTION:gsocketclient * GSocketClient:
* @short_description: Helper for connecting to a network service
* @include: gio/gio.h
* @see_also: #GSocketConnection, #GSocketListener
* *
* #GSocketClient is a lightweight high-level utility class for connecting to * `GSocketClient` is a lightweight high-level utility class for connecting to
* a network host using a connection oriented socket type. * a network host using a connection oriented socket type.
* *
* You create a #GSocketClient object, set any options you want, and then * You create a `GSocketClient` object, set any options you want, and then
* call a sync or async connect operation, which returns a #GSocketConnection * call a sync or async connect operation, which returns a
* subclass on success. * [class@Gio.SocketConnection] subclass on success.
* *
* The type of the #GSocketConnection object returned depends on the type of * The type of the [class@Gio.SocketConnection] object returned depends on the
* the underlying socket that is in use. For instance, for a TCP/IP connection * type of the underlying socket that is in use. For instance, for a TCP/IP
* it will be a #GTcpConnection. * connection it will be a [class@Gio.TcpConnection].
* *
* As #GSocketClient is a lightweight object, you don't need to cache it. You * As `GSocketClient` is a lightweight object, you don't need to cache it. You
* can just create a new one any time you need one. * can just create a new one any time you need one.
* *
* Since: 2.22 * Since: 2.22