summaryrefslogtreecommitdiff
path: root/man/sd_bus_set_server.xml
diff options
context:
space:
mode:
authorDaan De Meyer <daan.j.demeyer@gmail.com>2020-04-21 19:08:25 +0200
committerDaan De Meyer <daan.j.demeyer@gmail.com>2020-04-21 19:08:25 +0200
commit7fffaafaf2e0ef88b0d9835a0da83173cd3438bb (patch)
tree7d4faa83df21f8eff06d7f36f6e0ea16be8edca2 /man/sd_bus_set_server.xml
parent33b58dfb41a0c0db8110f1fc6dd0fc54e0d9cd4a (diff)
downloadsystemd-7fffaafaf2e0ef88b0d9835a0da83173cd3438bb.tar.gz
sd-bus: Rewrap sd_bus_set_server docs at 109 columns
Diffstat (limited to 'man/sd_bus_set_server.xml')
-rw-r--r--man/sd_bus_set_server.xml61
1 files changed, 29 insertions, 32 deletions
diff --git a/man/sd_bus_set_server.xml b/man/sd_bus_set_server.xml
index 6b93b92594..309a535f51 100644
--- a/man/sd_bus_set_server.xml
+++ b/man/sd_bus_set_server.xml
@@ -64,54 +64,51 @@
<refsect1>
<title>Description</title>
- <para><function>sd_bus_set_server()</function> configures the bus object as a server for direct
- D-Bus connections. <parameter>b</parameter> enables/disables the server mode. If zero, the
- server mode is disabled. Otherwise, the server mode is enabled. Configuring a bus object as a
- server is required to allow establishing direct connections between two peers without going via
- the D-Bus daemon. <parameter>id</parameter> must contain a 128-bit integer id for the server. If
- clients add a guid field to their D-Bus address string, the server id must match this guid or
- the D-Bus authentication handshake will fail. If no specific id is defined for the server,
+ <para><function>sd_bus_set_server()</function> configures the bus object as a server for direct D-Bus
+ connections. <parameter>b</parameter> enables/disables the server mode. If zero, the server mode is
+ disabled. Otherwise, the server mode is enabled. Configuring a bus object as a server is required to
+ allow establishing direct connections between two peers without going via the D-Bus daemon.
+ <parameter>id</parameter> must contain a 128-bit integer id for the server. If clients add a guid field
+ to their D-Bus address string, the server id must match this guid or the D-Bus authentication handshake
+ will fail. If no specific id is defined for the server,
<citerefentry><refentrytitle>sd_id128_randomize</refentrytitle><manvolnum>3</manvolnum></citerefentry>
can be used to generate a random id instead.</para>
- <para><function>sd_bus_is_server()</function> returns whether the server mode is enabled for
- the given bus object.</para>
+ <para><function>sd_bus_is_server()</function> returns whether the server mode is enabled for the given
+ bus object.</para>
<para><function>sd_bus_get_bus_id()</function> stores the D-Bus server id configured using
- <function>sd_bus_set_server()</function> (for server bus objects) or received during
- D-Bus authentication (for client bus objects) in <parameter>id</parameter>.</para>
-
- <para><function>sd_bus_set_bus_client()</function> configures the bus object as a D-Bus daemon
- client. <parameter>b</parameter> enables/disables the client mode. If zero, the client mode is
- disabled and the bus object should connect directly to a D-Bus server. Otherwise, the client
- mode is enabled and the bus object should connect to a D-Bus daemon. When connecting to an
- existing bus using any of the functions in the
- <citerefentry><refentrytitle>sd_bus_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+ <function>sd_bus_set_server()</function> (for server bus objects) or received during D-Bus authentication
+ (for client bus objects) in <parameter>id</parameter>.</para>
+
+ <para><function>sd_bus_set_bus_client()</function> configures the bus object as a D-Bus daemon client.
+ <parameter>b</parameter> enables/disables the client mode. If zero, the client mode is disabled and the
+ bus object should connect directly to a D-Bus server. Otherwise, the client mode is enabled and the bus
+ object should connect to a D-Bus daemon. When connecting to an existing bus using any of the functions in
+ the <citerefentry><refentrytitle>sd_bus_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>
family of functions or any of the functions in the
- <citerefentry><refentrytitle>sd_bus_default</refentrytitle><manvolnum>3</manvolnum></citerefentry>
- family of functions, the bus object is automatically configured as a bus client. However, when
- connecting to a D-Bus daemon by calling
+ <citerefentry><refentrytitle>sd_bus_default</refentrytitle><manvolnum>3</manvolnum></citerefentry> family
+ of functions, the bus object is automatically configured as a bus client. However, when connecting to a
+ D-Bus daemon by calling
<citerefentry><refentrytitle>sd_bus_set_address</refentrytitle><manvolnum>3</manvolnum></citerefentry>
followed by
- <citerefentry><refentrytitle>sd_bus_start</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
- the bus object should be manually configured as a bus client using
- <function>sd_bus_set_bus_client()</function>. By default, a bus object is not configured as a
- D-Bus daemon client.</para>
+ <citerefentry><refentrytitle>sd_bus_start</refentrytitle><manvolnum>3</manvolnum></citerefentry>, the bus
+ object should be manually configured as a bus client using <function>sd_bus_set_bus_client()</function>.
+ By default, a bus object is not configured as a D-Bus daemon client.</para>
- <para><function>sd_bus_is_bus_client()</function> returns whether the client mode is
- enabled/disabled for the given bus object.</para>
+ <para><function>sd_bus_is_bus_client()</function> returns whether the client mode is enabled/disabled for
+ the given bus object.</para>
</refsect1>
<refsect1>
<title>Return Value</title>
<para>On success, <function>sd_bus_set_server()</function>,
- <function>sd_bus_get_bus_id()</function> and <function>sd_bus_set_bus_client()</function> return
- a non-negative integer. On failure, they return a negative errno-style error code.</para>
+ <function>sd_bus_get_bus_id()</function> and <function>sd_bus_set_bus_client()</function> return a
+ non-negative integer. On failure, they return a negative errno-style error code.</para>
- <para><function>sd_bus_is_server()</function> and <function>sd_bus_is_bus_client()</function>
- return a positive integer when the server or client mode is enabled, respectively. Otherwise,
- they return zero.
+ <para><function>sd_bus_is_server()</function> and <function>sd_bus_is_bus_client()</function> return a
+ positive integer when the server or client mode is enabled, respectively. Otherwise, they return zero.
</para>
<refsect2>