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

docs: Move the GSocketConnection 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:28 +01:00
parent 43b4e7e097
commit 051c5336d4
1 changed files with 11 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
gio/gsocketconnection.c
View File

@ -40,27 +40,24 @@
/**
* SECTION:gsocketconnection
* @short_description: A socket connection
* @include: gio/gio.h
* @see_also: #GIOStream, #GSocketClient, #GSocketListener
* GSocketConnection:
*
* #GSocketConnection is a #GIOStream for a connected socket. They
* can be created either by #GSocketClient when connecting to a host,
* or by #GSocketListener when accepting a new client.
* `GSocketConnection` is a [class@Gio.IOStream] for a connected socket. They
* can be created either by [class@Gio.SocketClient] when connecting to a host,
* or by [class@Gio.SocketListener] when accepting a new client.
*
* The type of the #GSocketConnection object returned from these calls
* The type of the `GSocketConnection` object returned from these calls
* depends on the type of the underlying socket that is in use. For
* instance, for a TCP/IP connection it will be a #GTcpConnection.
* instance, for a TCP/IP connection it will be a [class@Gio.TcpConnection].
*
* Choosing what type of object to construct is done with the socket
* connection factory, and it is possible for 3rd parties to register
* connection factory, and it is possible for third parties to register
* custom socket connection types for specific combination of socket
* family/type/protocol using g_socket_connection_factory_register_type().
* family/type/protocol using [func@Gio.SocketConnection.factory_register_type].
*
* To close a #GSocketConnection, use g_io_stream_close(). Closing both
* substreams of the #GIOStream separately will not close the underlying
* #GSocket.
* To close a `GSocketConnection`, use [method@Gio.IOStream.close]. Closing both
* substreams of the [class@Gio.IOStream] separately will not close the
* underlying [class@Gio.Socket].
*
* Since: 2.22
*/