mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-01-12 15:36:17 +01:00
docs: Move the GCredentials SECTION
Move contents to struct docs. Helps: #3037
This commit is contained in:
parent
dad6ec9651
commit
926f56c7c7
@ -35,58 +35,48 @@
|
|||||||
|
|
||||||
#include "glibintl.h"
|
#include "glibintl.h"
|
||||||
|
|
||||||
/**
|
|
||||||
* SECTION:gcredentials
|
|
||||||
* @short_description: An object containing credentials
|
|
||||||
* @include: gio/gio.h
|
|
||||||
*
|
|
||||||
* The #GCredentials type is a reference-counted wrapper for native
|
|
||||||
* credentials. This information is typically used for identifying,
|
|
||||||
* authenticating and authorizing other processes.
|
|
||||||
*
|
|
||||||
* Some operating systems supports looking up the credentials of the
|
|
||||||
* remote peer of a communication endpoint - see e.g.
|
|
||||||
* g_socket_get_credentials().
|
|
||||||
*
|
|
||||||
* Some operating systems supports securely sending and receiving
|
|
||||||
* credentials over a Unix Domain Socket, see
|
|
||||||
* #GUnixCredentialsMessage, g_unix_connection_send_credentials() and
|
|
||||||
* g_unix_connection_receive_credentials() for details.
|
|
||||||
*
|
|
||||||
* On Linux, the native credential type is a `struct ucred` - see the
|
|
||||||
* unix(7) man page for details. This corresponds to
|
|
||||||
* %G_CREDENTIALS_TYPE_LINUX_UCRED.
|
|
||||||
*
|
|
||||||
* On Apple operating systems (including iOS, tvOS, and macOS),
|
|
||||||
* the native credential type is a `struct xucred`.
|
|
||||||
* This corresponds to %G_CREDENTIALS_TYPE_APPLE_XUCRED.
|
|
||||||
*
|
|
||||||
* On FreeBSD, Debian GNU/kFreeBSD, and GNU/Hurd, the native
|
|
||||||
* credential type is a `struct cmsgcred`. This corresponds
|
|
||||||
* to %G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED.
|
|
||||||
*
|
|
||||||
* On NetBSD, the native credential type is a `struct unpcbid`.
|
|
||||||
* This corresponds to %G_CREDENTIALS_TYPE_NETBSD_UNPCBID.
|
|
||||||
*
|
|
||||||
* On OpenBSD, the native credential type is a `struct sockpeercred`.
|
|
||||||
* This corresponds to %G_CREDENTIALS_TYPE_OPENBSD_SOCKPEERCRED.
|
|
||||||
*
|
|
||||||
* On Solaris (including OpenSolaris and its derivatives), the native
|
|
||||||
* credential type is a `ucred_t`. This corresponds to
|
|
||||||
* %G_CREDENTIALS_TYPE_SOLARIS_UCRED.
|
|
||||||
*
|
|
||||||
* Since GLib 2.72, on Windows, the native credentials may contain the PID of a
|
|
||||||
* process. This corresponds to %G_CREDENTIALS_TYPE_WIN32_PID.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* GCredentials:
|
* GCredentials:
|
||||||
*
|
*
|
||||||
* The #GCredentials structure contains only private data and
|
* The `GCredentials` type is a reference-counted wrapper for native
|
||||||
* should only be accessed using the provided API.
|
* credentials.
|
||||||
|
*
|
||||||
|
* The information in `GCredentials` is typically used for identifying,
|
||||||
|
* authenticating and authorizing other processes.
|
||||||
|
*
|
||||||
|
* Some operating systems supports looking up the credentials of the remote
|
||||||
|
* peer of a communication endpoint - see e.g. [method@Gio.Socket.get_credentials].
|
||||||
|
*
|
||||||
|
* Some operating systems supports securely sending and receiving
|
||||||
|
* credentials over a Unix Domain Socket, see [struct@Gio.UnixCredentialsMessage],
|
||||||
|
* [method@Gio.UnixConnection.send_credentials] and
|
||||||
|
* [method@Gio.UnixConnection.receive_credentials] for details.
|
||||||
|
*
|
||||||
|
* On Linux, the native credential type is a `struct ucred` - see the
|
||||||
|
* [`unix(7)` man page](man:unix(7)) for details. This corresponds to
|
||||||
|
* `G_CREDENTIALS_TYPE_LINUX_UCRED`.
|
||||||
|
*
|
||||||
|
* On Apple operating systems (including iOS, tvOS, and macOS), the native credential
|
||||||
|
* type is a `struct xucred`. This corresponds to `G_CREDENTIALS_TYPE_APPLE_XUCRED`.
|
||||||
|
*
|
||||||
|
* On FreeBSD, Debian GNU/kFreeBSD, and GNU/Hurd, the native credential type is a
|
||||||
|
* `struct cmsgcred`. This corresponds to `G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED`.
|
||||||
|
*
|
||||||
|
* On NetBSD, the native credential type is a `struct unpcbid`.
|
||||||
|
* This corresponds to `G_CREDENTIALS_TYPE_NETBSD_UNPCBID`.
|
||||||
|
*
|
||||||
|
* On OpenBSD, the native credential type is a `struct sockpeercred`.
|
||||||
|
* This corresponds to `G_CREDENTIALS_TYPE_OPENBSD_SOCKPEERCRED`.
|
||||||
|
*
|
||||||
|
* On Solaris (including OpenSolaris and its derivatives), the native credential type
|
||||||
|
* is a `ucred_t`. This corresponds to `G_CREDENTIALS_TYPE_SOLARIS_UCRED`.
|
||||||
|
*
|
||||||
|
* Since GLib 2.72, on Windows, the native credentials may contain the PID of a
|
||||||
|
* process. This corresponds to `G_CREDENTIALS_TYPE_WIN32_PID`.
|
||||||
*
|
*
|
||||||
* Since: 2.26
|
* Since: 2.26
|
||||||
*/
|
*/
|
||||||
|
|
||||||
struct _GCredentials
|
struct _GCredentials
|
||||||
{
|
{
|
||||||
/*< private >*/
|
/*< private >*/
|
||||||
|
Loading…
Reference in New Issue
Block a user