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

docs: Move the GSocketControlMessage SECTION

Browse Source 
Move it to the struct docs.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>

Helps: #3037
This commit is contained in:
Philip Withnall
2023-11-14 14:26:38 +00:00
parent 8af86abefb
commit 7f6a126f39
2 changed files with 10 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
gio/giotypes.h
View File

@@ -155,12 +155,6 @@ typedef struct _GSimpleAsyncResult GSimpleAsyncResult;
**/ **/
typedef struct _GSocket GSocket; typedef struct _GSocket GSocket;
/**
* GSocketControlMessage:
*
* Base class for socket-type specific control messages that can be sent and
* received over #GSocket.
**/
typedef struct _GSocketControlMessage GSocketControlMessage; typedef struct _GSocketControlMessage GSocketControlMessage;
/** /**
* GSocketClient: * GSocketClient:

24
gio/gsocketcontrolmessage.c
View File

@@ -15,32 +15,28 @@
*/ */
/** /**
* SECTION:gsocketcontrolmessage * GSocketControlMessage:
* @title: GSocketControlMessage
* @short_description: A GSocket control message
* @include: gio/gio.h
* @see_also: #GSocket.
* *
* A #GSocketControlMessage is a special-purpose utility message that * A `GSocketControlMessage` is a special-purpose utility message that
* can be sent to or received from a #GSocket. These types of * can be sent to or received from a [class@Gio.Socket]. These types of
* messages are often called "ancillary data". * messages are often called ‘ancillary data’.
* *
* The message can represent some sort of special instruction to or * The message can represent some sort of special instruction to or
* information from the socket or can represent a special kind of * information from the socket or can represent a special kind of
* transfer to the peer (for example, sending a file descriptor over * transfer to the peer (for example, sending a file descriptor over
* a UNIX socket). * a UNIX socket).
* *
* These messages are sent with g_socket_send_message() and received * These messages are sent with [method@Gio.Socket.send_message] and received
* with g_socket_receive_message(). * with [method@Gio.Socket.receive_message].
* *
* To extend the set of control message that can be sent, subclass this * To extend the set of control message that can be sent, subclass this
* class and override the get_size, get_level, get_type and serialize * class and override the `get_size`, `get_level`, `get_type` and `serialize`
* methods. * methods.
* *
* To extend the set of control messages that can be received, subclass * To extend the set of control messages that can be received, subclass
* this class and implement the deserialize method. Also, make sure your * this class and implement the `deserialize` method. Also, make sure your
* class is registered with the GType typesystem before calling * class is registered with the [type@GObject.Type] type system before calling
* g_socket_receive_message() to read such a message. * [method@Gio.Socket.receive_message] to read such a message.
* *
* Since: 2.22 * Since: 2.22
*/ */