luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-09-12 21:36:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Move the GDtlsConnection SECTIONs

Browse Source 
Move them to the struct docs, for all DTLS classes.

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

Helps: #3037
This commit is contained in:
Philip Withnall 2023-10-23 00:28:40 +01:00
parent 92d8da4895
commit bd5219a0c0
4 changed files with 26 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
gio/gdtlsclientconnection.c
View File

@ -31,26 +31,14 @@
#include "gtlscertificate.h"
#include "glibintl.h"
/**
* SECTION:gdtlsclientconnection
* @short_description: DTLS client-side connection
* @include: gio/gio.h
*
* #GDtlsClientConnection is the client-side subclass of
* #GDtlsConnection, representing a client-side DTLS connection.
*
* Since: 2.48
*/
/**
* GDtlsClientConnection:
*
* Abstract base class for the backend-specific client connection
* type.
* `GDtlsClientConnection` is the client-side subclass of
* [iface@Gio.DtlsConnection], representing a client-side DTLS connection.
*
* Since: 2.48
*/
G_DEFINE_INTERFACE (GDtlsClientConnection, g_dtls_client_connection,
G_TYPE_DTLS_CONNECTION)

52
gio/gdtlsconnection.c
View File

@ -35,43 +35,33 @@
#include "glibintl.h"
#include "gmarshal-internal.h"
/**
* SECTION:gdtlsconnection
* @short_description: DTLS connection type
* @include: gio/gio.h
*
* #GDtlsConnection is the base DTLS connection class type, which wraps
* a #GDatagramBased and provides DTLS encryption on top of it. Its
* subclasses, #GDtlsClientConnection and #GDtlsServerConnection,
* implement client-side and server-side DTLS, respectively.
*
* For TLS support, see #GTlsConnection.
*
* As DTLS is datagram based, #GDtlsConnection implements #GDatagramBased,
* presenting a datagram-socket-like API for the encrypted connection. This
* operates over a base datagram connection, which is also a #GDatagramBased
* (#GDtlsConnection:base-socket).
*
* To close a DTLS connection, use g_dtls_connection_close().
*
* Neither #GDtlsServerConnection or #GDtlsClientConnection set the peer address
* on their base #GDatagramBased if it is a #GSocket — it is up to the caller to
* do that if they wish. If they do not, and g_socket_close() is called on the
* base socket, the #GDtlsConnection will not raise a %G_IO_ERROR_NOT_CONNECTED
* error on further I/O.
*
* Since: 2.48
*/
/**
* GDtlsConnection:
*
* Abstract base class for the backend-specific #GDtlsClientConnection
* and #GDtlsServerConnection types.
* `GDtlsConnection` is the base DTLS connection class type, which wraps
* a [iface@Gio.DatagramBased] and provides DTLS encryption on top of it. Its
* subclasses, [iface@Gio.DtlsClientConnection] and
* [iface@Gio.DtlsServerConnection], implement client-side and server-side DTLS,
* respectively.
*
* For TLS support, see [class@Gio.TlsConnection].
*
* As DTLS is datagram based, `GDtlsConnection` implements
* [iface@Gio.DatagramBased], presenting a datagram-socket-like API for the
* encrypted connection. This operates over a base datagram connection, which is
* also a `GDatagramBased` ([property@Gio.DtlsConnection:base-socket]).
*
* To close a DTLS connection, use [method@Gio.DtlsConnection.close].
*
* Neither [iface@Gio.DtlsServerConnection] or [iface@Gio.DtlsClientConnection]
* set the peer address on their base [iface@Gio.DatagramBased] if it is a
* [class@Gio.Socket] — it is up to the caller to do that if they wish. If they
* do not, and [method@Gio.Socket.close] is called on the base socket, the
* `GDtlsConnection` will not raise a `G_IO_ERROR_NOT_CONNECTED` error on
* further I/O.
*
* Since: 2.48
*/
G_DEFINE_INTERFACE (GDtlsConnection, g_dtls_connection, G_TYPE_DATAGRAM_BASED)
enum {

9
gio/gdtlsserverconnection.c
View File

@ -31,16 +31,13 @@
#include "glibintl.h"
/**
* SECTION:gdtlsserverconnection
* @short_description: DTLS server-side connection
* @include: gio/gio.h
* GDtlsServerConnection:
*
* #GDtlsServerConnection is the server-side subclass of #GDtlsConnection,
* representing a server-side DTLS connection.
* `GDtlsServerConnection` is the server-side subclass of
* [iface@Gio.DtlsConnection], representing a server-side DTLS connection.
*
* Since: 2.48
*/
G_DEFINE_INTERFACE (GDtlsServerConnection, g_dtls_server_connection,
G_TYPE_DTLS_CONNECTION)

8
gio/gdtlsserverconnection.h
View File

@ -35,14 +35,6 @@ G_BEGIN_DECLS
#define G_IS_DTLS_SERVER_CONNECTION(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), G_TYPE_DTLS_SERVER_CONNECTION))
#define G_DTLS_SERVER_CONNECTION_GET_INTERFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), G_TYPE_DTLS_SERVER_CONNECTION, GDtlsServerConnectionInterface))
/**
* GDtlsServerConnection:
*
* DTLS server-side connection. This is the server-side implementation
* of a #GDtlsConnection.
*
* Since: 2.48
*/
typedef struct _GDtlsServerConnectionInterface GDtlsServerConnectionInterface;
/**