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

docs: Move the GDBusServer 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:52:39 +01:00
parent d52b72a7b2
commit 226e9f16ea
1 changed files with 12 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
gio/gdbusserver.c
View File

@ -63,35 +63,28 @@
G_DBUS_SERVER_FLAGS_AUTHENTICATION_REQUIRE_SAME_USER) G_DBUS_SERVER_FLAGS_AUTHENTICATION_REQUIRE_SAME_USER)
/** /**
* SECTION:gdbusserver * GDBusServer:
* @short_description: Helper for accepting connections
* @include: gio/gio.h
* *
* #GDBusServer is a helper for listening to and accepting D-Bus * `GDBusServer` is a helper for listening to and accepting D-Bus
* connections. This can be used to create a new D-Bus server, allowing two * connections. This can be used to create a new D-Bus server, allowing two
* peers to use the D-Bus protocol for their own specialized communication. * peers to use the D-Bus protocol for their own specialized communication.
* A server instance provided in this way will not perform message routing or * A server instance provided in this way will not perform message routing or
* implement the org.freedesktop.DBus interface. * implement the
* [`org.freedesktop.DBus` interface](https://dbus.freedesktop.org/doc/dbus-specification.html#message-bus-messages).
* *
* To just export an object on a well-known name on a message bus, such as the * To just export an object on a well-known name on a message bus, such as the
* session or system bus, you should instead use g_bus_own_name(). * session or system bus, you should instead use [func@Gio.bus_own_name].
* *
* An example of peer-to-peer communication with GDBus can be found * An example of peer-to-peer communication with GDBus can be found
* in [gdbus-example-peer.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gdbus-example-peer.c). * in [gdbus-example-peer.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gdbus-example-peer.c).
* *
* Note that a minimal #GDBusServer will accept connections from any * Note that a minimal `GDBusServer` will accept connections from any
* peer. In many use-cases it will be necessary to add a #GDBusAuthObserver * peer. In many use-cases it will be necessary to add a
* that only accepts connections that have successfully authenticated * [class@Gio.DBusAuthObserver] that only accepts connections that have
* as the same user that is running the #GDBusServer. Since GLib 2.68 this can * successfully authenticated as the same user that is running the
* be achieved more simply by passing the * `GDBusServer`. Since GLib 2.68 this can be achieved more simply by passing
* %G_DBUS_SERVER_FLAGS_AUTHENTICATION_REQUIRE_SAME_USER flag to the server. * the `G_DBUS_SERVER_FLAGS_AUTHENTICATION_REQUIRE_SAME_USER` flag to the
*/ * server.
/**
* GDBusServer:
*
* The #GDBusServer structure contains only private data and
* should only be accessed using the provided API.
* *
* Since: 2.26 * Since: 2.26
*/ */