mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-07-29 21:33:30 +02:00
docs: Move the GSocketControlMessage SECTION
Move it to the struct docs. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3037
This commit is contained in:
@@ -155,12 +155,6 @@ typedef struct _GSimpleAsyncResult GSimpleAsyncResult;
|
||||
**/
|
||||
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;
|
||||
/**
|
||||
* GSocketClient:
|
||||
|
@@ -15,32 +15,28 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* SECTION:gsocketcontrolmessage
|
||||
* @title: GSocketControlMessage
|
||||
* @short_description: A GSocket control message
|
||||
* @include: gio/gio.h
|
||||
* @see_also: #GSocket.
|
||||
* GSocketControlMessage:
|
||||
*
|
||||
* A #GSocketControlMessage is a special-purpose utility message that
|
||||
* can be sent to or received from a #GSocket. These types of
|
||||
* messages are often called "ancillary data".
|
||||
* A `GSocketControlMessage` is a special-purpose utility message that
|
||||
* can be sent to or received from a [class@Gio.Socket]. These types of
|
||||
* messages are often called ‘ancillary data’.
|
||||
*
|
||||
* The message can represent some sort of special instruction to or
|
||||
* information from the socket or can represent a special kind of
|
||||
* transfer to the peer (for example, sending a file descriptor over
|
||||
* a UNIX socket).
|
||||
*
|
||||
* These messages are sent with g_socket_send_message() and received
|
||||
* with g_socket_receive_message().
|
||||
* These messages are sent with [method@Gio.Socket.send_message] and received
|
||||
* with [method@Gio.Socket.receive_message].
|
||||
*
|
||||
* 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.
|
||||
*
|
||||
* To extend the set of control messages that can be received, subclass
|
||||
* this class and implement the deserialize method. Also, make sure your
|
||||
* class is registered with the GType typesystem before calling
|
||||
* g_socket_receive_message() to read such a message.
|
||||
* this class and implement the `deserialize` method. Also, make sure your
|
||||
* class is registered with the [type@GObject.Type] type system before calling
|
||||
* [method@Gio.Socket.receive_message] to read such a message.
|
||||
*
|
||||
* Since: 2.22
|
||||
*/
|
||||
|
Reference in New Issue
Block a user