X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsd_bus_negotiate_fds.xml;h=4fbffdf38c9b33bdf1c96f39fe533e6440f7bcc0;hb=8ede9794fdc8e659a6adc1dad4e68e03a36efe13;hp=38e1fad68a68be18ec6602209a26cbb459116762;hpb=ce236b57bee9a081d62db04bcc5be34e3ba6d217;p=elogind.git
diff --git a/man/sd_bus_negotiate_fds.xml b/man/sd_bus_negotiate_fds.xml
index 38e1fad68..4fbffdf38 100644
--- a/man/sd_bus_negotiate_fds.xml
+++ b/man/sd_bus_negotiate_fds.xml
@@ -1,4 +1,4 @@
-
+
@@ -24,7 +24,7 @@ along with systemd; If not, see .
- sd_bus_new
+ sd_bus_negotiate_fdssystemd
@@ -70,6 +70,7 @@ along with systemd; If not, see .
int sd_bus_negotiate_credssd_bus *busint b
+ uint64_t flags
@@ -79,60 +80,69 @@ along with systemd; If not, see .
sd_bus_negotiate_fds() controls whether
file descriptor passing shall be negotiated for the specified bus
- connection. Takes a bus object and a boolean, which when true
- enables file descriptor passing, and when false disables it. Note
+ connection. It takes a bus object and a boolean, which, when true,
+ enables file descriptor passing, and, when false, disables it. Note
that not all transports and servers support file descriptor
passing. To find out whether file descriptor passing is available
- after negotiation use
+ after negotiation, use
sd_bus_can_send3
and pass SD_BUS_TYPE_UNIX_FD. Note that file
descriptor passing is always enabled for both sending and
receiving or for neither, but never only in one direction. By
- default file descriptor passing is negotiated for all
+ default, file descriptor passing is negotiated for all
connections.
- Note that when bus activation is used it is highly
+ Note that when bus activation is used, it is highly
recommended to set the
setting in the .busname unit file to the same
setting as negotiated by the program ultimately activated. By
- default file descriptor passing is enabled for both.
+ default, file descriptor passing is enabled for both.sd_bus_negotiate_timestamps() controls
whether implicit sender timestamps shall be attached automatically
- to all incoming messages. Takes a bus object and a boolean, which
- when true enables timestamping, and when false disables it. If
+ to all incoming messages. Takes a bus object and a boolean, which,
+ when true, enables timestamping, and, when false, disables it. If
this is disabled,
sd_bus_message_get_monotonic_usec3,
sd_bus_message_get_realtime_usec3,
sd_bus_message_get_seqno3
fail with -ENODATA on incoming messages. Note
that not all transports support timestamping of messages. On local
- transports the timestamping is applied by the kernel and cannot be
- manipulated by userspace.
+ transports, the timestamping is applied by the kernel and cannot
+ be manipulated by userspace. By default, message timestamping is
+ not negotiated for all connections.
sd_bus_negotiate_creds() controls
whether implicit sender credentials shall be attached
- automatically to all incoming messages. Takes a bus object and a
- bit mask value, which controls which credential parameters are
- attached. If this is not used,
- sd_bus_message_get_creds3
- fails with -ENODATA on incoming
- messages. Note that not all transports support attaching sender
- credentials to messages, or do not support all types of sender
- credential parameters. On local transports the sender credentials
- are attached by the kernel and cannot be manipulated by
- userspace. By default no sender credentials are attached.
-
- These functions may be called only before the connection has
- been started with
- sd_bus_start3.
+ automatically to all incoming messages. Takes a bus object, a
+ boolean indicating wether to enable or disable the credential
+ parts encoded in the bit mask value argument. Note that not all
+ transports support attaching sender credentials to messages, or do
+ not support all types of sender credential parameters, or might
+ suppress them under certain circumstances for individual
+ messages. On local transports, the sender credentials are attached
+ by the kernel and cannot be manipulated by userspace. By default,
+ no sender credentials are attached.
+
+ The sd_bus_negotiate_fds() function may
+ be called only before the connection has been started with
+ sd_bus_start3. Both
+ sd_bus_negotiate_timestamp() and
+ sd_bus_negotiate_creds() also may be called
+ after a connection has been set up. Note that when operating on a
+ connection that is shared between multiple components of the same
+ program (for example via
+ sd_bus_default3)
+ it is highly recommended to only enable additional per message
+ metadata fields, but never disable them again, in order not to
+ disable functionality needed by other components.Return ValueOn success, these functions returns 0 or a
- positive integer. On failure, it returns a negative errno-style
+ positive integer. On failure, they return a negative errno-style
error code.
@@ -143,7 +153,7 @@ along with systemd; If not, see .
- -EPERM
+ -EPERMThe bus connection has already been started.
@@ -156,7 +166,7 @@ along with systemd; If not, see .
sd_bus_negotiate_fs() and the other
functions described here are available as a shared library, which
can be compiled and linked to with the
- libsystemd pkg-config1
+ libsystemd pkg-config1
file.
@@ -169,7 +179,8 @@ along with systemd; If not, see .
sd_bus_start3,
sd_bus_message_can_send3,
sd_bus_message_get_monotonic_usec3,
- sd_bus_message_get_creds3
+ sd_bus_message_get_creds3,
+ systemd.busname5