2014-11-21 20:44:48 +01:00
|
|
|
|
<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
|
2014-03-18 21:05:16 +01:00
|
|
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
|
|
|
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
|
|
|
|
|
|
|
|
|
<!--
|
2015-03-14 03:26:47 +01:00
|
|
|
|
This file is part of systemd.
|
2014-03-18 21:05:16 +01:00
|
|
|
|
|
2015-03-14 03:26:47 +01:00
|
|
|
|
Copyright 2014 Lennart Poettering
|
2014-03-18 21:05:16 +01:00
|
|
|
|
|
2015-03-14 03:26:47 +01:00
|
|
|
|
systemd is free software; you can redistribute it and/or modify it
|
|
|
|
|
under the terms of the GNU Lesser General Public License as published by
|
|
|
|
|
the Free Software Foundation; either version 2.1 of the License, or
|
|
|
|
|
(at your option) any later version.
|
2014-03-18 21:05:16 +01:00
|
|
|
|
|
2015-03-14 03:26:47 +01:00
|
|
|
|
systemd is distributed in the hope that it will be useful, but
|
|
|
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
|
Lesser General Public License for more details.
|
2014-03-18 21:05:16 +01:00
|
|
|
|
|
2015-03-14 03:26:47 +01:00
|
|
|
|
You should have received a copy of the GNU Lesser General Public License
|
|
|
|
|
along with systemd; If not, see <http://www.gnu.org/licenses/>.
|
2014-03-18 21:05:16 +01:00
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
<refentry id="sd_bus_negotiate_fds" conditional="ENABLE_KDBUS">
|
|
|
|
|
|
|
|
|
|
<refentryinfo>
|
2014-04-01 19:12:59 +02:00
|
|
|
|
<title>sd_bus_negotiate_fds</title>
|
2014-03-18 21:05:16 +01:00
|
|
|
|
<productname>systemd</productname>
|
|
|
|
|
|
|
|
|
|
<authorgroup>
|
|
|
|
|
<author>
|
|
|
|
|
<contrib>Developer</contrib>
|
|
|
|
|
<firstname>Lennart</firstname>
|
|
|
|
|
<surname>Poettering</surname>
|
|
|
|
|
<email>lennart@poettering.net</email>
|
|
|
|
|
</author>
|
|
|
|
|
</authorgroup>
|
|
|
|
|
</refentryinfo>
|
|
|
|
|
|
|
|
|
|
<refmeta>
|
|
|
|
|
<refentrytitle>sd_bus_negotiate_fds</refentrytitle>
|
|
|
|
|
<manvolnum>3</manvolnum>
|
|
|
|
|
</refmeta>
|
|
|
|
|
|
|
|
|
|
<refnamediv>
|
|
|
|
|
<refname>sd_bus_negotiate_fds</refname>
|
|
|
|
|
<refname>sd_bus_negotiate_timestamps</refname>
|
|
|
|
|
<refname>sd_bus_negotiate_creds</refname>
|
|
|
|
|
|
|
|
|
|
<refpurpose>Control feature negotiation on bus connections</refpurpose>
|
|
|
|
|
</refnamediv>
|
|
|
|
|
|
|
|
|
|
<refsynopsisdiv>
|
|
|
|
|
<funcsynopsis>
|
|
|
|
|
<funcsynopsisinfo>#include <systemd/sd-bus.h></funcsynopsisinfo>
|
|
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
|
<funcdef>int <function>sd_bus_negotiate_fds</function></funcdef>
|
|
|
|
|
<paramdef>sd_bus *<parameter>bus</parameter></paramdef>
|
|
|
|
|
<paramdef>int <parameter>b</parameter></paramdef>
|
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
|
<funcdef>int <function>sd_bus_negotiate_timestamp</function></funcdef>
|
|
|
|
|
<paramdef>sd_bus *<parameter>bus</parameter></paramdef>
|
|
|
|
|
<paramdef>int <parameter>b</parameter></paramdef>
|
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
|
<funcdef>int <function>sd_bus_negotiate_creds</function></funcdef>
|
|
|
|
|
<paramdef>sd_bus *<parameter>bus</parameter></paramdef>
|
|
|
|
|
<paramdef>int <parameter>b</parameter></paramdef>
|
2014-11-26 02:20:28 +01:00
|
|
|
|
<paramdef>uint64_t <parameter>flags</parameter></paramdef>
|
2014-03-18 21:05:16 +01:00
|
|
|
|
</funcprototype>
|
|
|
|
|
</funcsynopsis>
|
|
|
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>Description</title>
|
|
|
|
|
|
|
|
|
|
<para><function>sd_bus_negotiate_fds()</function> controls whether
|
|
|
|
|
file descriptor passing shall be negotiated for the specified bus
|
2014-05-08 01:28:45 +02:00
|
|
|
|
connection. It takes a bus object and a boolean, which, when true,
|
|
|
|
|
enables file descriptor passing, and, when false, disables it. Note
|
2014-03-18 21:05:16 +01:00
|
|
|
|
that not all transports and servers support file descriptor
|
|
|
|
|
passing. To find out whether file descriptor passing is available
|
2014-05-08 01:28:45 +02:00
|
|
|
|
after negotiation, use
|
2014-03-18 21:05:16 +01:00
|
|
|
|
<citerefentry><refentrytitle>sd_bus_can_send</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
|
|
|
|
and pass <constant>SD_BUS_TYPE_UNIX_FD</constant>. Note that file
|
|
|
|
|
descriptor passing is always enabled for both sending and
|
|
|
|
|
receiving or for neither, but never only in one direction. By
|
2014-05-08 01:28:45 +02:00
|
|
|
|
default, file descriptor passing is negotiated for all
|
2014-03-18 21:05:16 +01:00
|
|
|
|
connections.</para>
|
|
|
|
|
|
2014-05-08 01:28:45 +02:00
|
|
|
|
<para>Note that when bus activation is used, it is highly
|
2014-03-18 21:05:16 +01:00
|
|
|
|
recommended to set the <option>AcceptFileDescriptors=</option>
|
|
|
|
|
setting in the <filename>.busname</filename> unit file to the same
|
|
|
|
|
setting as negotiated by the program ultimately activated. By
|
2014-05-08 01:28:45 +02:00
|
|
|
|
default, file descriptor passing is enabled for both.</para>
|
2014-03-18 21:05:16 +01:00
|
|
|
|
|
|
|
|
|
<para><function>sd_bus_negotiate_timestamps()</function> controls
|
|
|
|
|
whether implicit sender timestamps shall be attached automatically
|
2014-05-08 01:28:45 +02:00
|
|
|
|
to all incoming messages. Takes a bus object and a boolean, which,
|
|
|
|
|
when true, enables timestamping, and, when false, disables it. If
|
2014-03-18 21:05:16 +01:00
|
|
|
|
this is disabled,
|
|
|
|
|
<citerefentry><refentrytitle>sd_bus_message_get_monotonic_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
|
|
|
|
<citerefentry><refentrytitle>sd_bus_message_get_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
2015-03-14 03:25:52 +01:00
|
|
|
|
<citerefentry><refentrytitle>sd_bus_message_get_seqnum</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
2014-03-18 21:05:16 +01:00
|
|
|
|
fail with <constant>-ENODATA</constant> on incoming messages. Note
|
|
|
|
|
that not all transports support timestamping of messages. On local
|
2014-11-26 02:20:28 +01:00
|
|
|
|
transports, the timestamping is applied by the kernel and cannot
|
|
|
|
|
be manipulated by userspace. By default, message timestamping is
|
|
|
|
|
not negotiated for all connections.</para>
|
2014-03-18 21:05:16 +01:00
|
|
|
|
|
|
|
|
|
<para><function>sd_bus_negotiate_creds()</function> controls
|
|
|
|
|
whether implicit sender credentials shall be attached
|
2014-11-26 02:20:28 +01:00
|
|
|
|
automatically to all incoming messages. Takes a bus object, a
|
2014-12-29 10:45:58 +01:00
|
|
|
|
boolean indicating whether to enable or disable the credential
|
2014-11-26 02:20:28 +01:00
|
|
|
|
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.</para>
|
|
|
|
|
|
|
|
|
|
<para>The <function>sd_bus_negotiate_fds()</function> function may
|
|
|
|
|
be called only before the connection has been started with
|
|
|
|
|
<citerefentry><refentrytitle>sd_bus_start</refentrytitle><manvolnum>3</manvolnum></citerefentry>. Both
|
|
|
|
|
<function>sd_bus_negotiate_timestamp()</function> and
|
|
|
|
|
<function>sd_bus_negotiate_creds()</function> 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
|
|
|
|
|
<citerefentry><refentrytitle>sd_bus_default</refentrytitle><manvolnum>3</manvolnum></citerefentry>)
|
|
|
|
|
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.</para>
|
2014-03-18 21:05:16 +01:00
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>Return Value</title>
|
|
|
|
|
|
|
|
|
|
<para>On success, these functions returns 0 or a
|
2014-04-01 19:12:59 +02:00
|
|
|
|
positive integer. On failure, they return a negative errno-style
|
2014-03-18 21:05:16 +01:00
|
|
|
|
error code.</para>
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>Errors</title>
|
|
|
|
|
|
|
|
|
|
<para>Returned errors may indicate the following problems:</para>
|
|
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
|
<varlistentry>
|
2014-09-25 23:27:46 +02:00
|
|
|
|
<term><constant>-EPERM</constant></term>
|
2014-03-18 21:05:16 +01:00
|
|
|
|
|
|
|
|
|
<listitem><para>The bus connection has already been started.</para></listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
</variablelist>
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>Notes</title>
|
|
|
|
|
|
|
|
|
|
<para><function>sd_bus_negotiate_fs()</function> and the other
|
|
|
|
|
functions described here are available as a shared library, which
|
|
|
|
|
can be compiled and linked to with the
|
man: add a mapping for external manpages
It is annoying when we have dead links on fd.o.
Add project='man-pages|die-net|archlinux' to <citerefentry>-ies.
In generated html, add external links to
http://man7.org/linux/man-pages/man, http://linux.die.net/man/,
https://www.archlinux.org/.
By default, pages in sections 2 and 4 go to man7, since Michael
Kerrisk is the autorative source on kernel related stuff.
The rest of links goes to linux.die.net, because they have the
manpages.
Except for the pacman stuff, since it seems to be only available from
archlinux.org.
Poor gummiboot gets no link, because gummitboot(8) ain't to be found
on the net. According to common wisdom, that would mean that it does
not exist. But I have seen Kay using it, so I know it does, and
deserves to be found. Can somebody be nice and put it up somewhere?
2014-07-08 00:25:54 +02:00
|
|
|
|
<constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
2014-03-18 21:05:16 +01:00
|
|
|
|
file.</para>
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>See Also</title>
|
|
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
|
|
|
|
<citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
|
|
|
|
<citerefentry><refentrytitle>sd_bus_start</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
|
|
|
|
<citerefentry><refentrytitle>sd_bus_message_can_send</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
|
|
|
|
<citerefentry><refentrytitle>sd_bus_message_get_monotonic_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
2014-11-26 02:20:28 +01:00
|
|
|
|
<citerefentry><refentrytitle>sd_bus_message_get_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
|
|
|
|
<citerefentry><refentrytitle>systemd.busname</refentrytitle><manvolnum>5</manvolnum></citerefentry>
|
2014-03-18 21:05:16 +01:00
|
|
|
|
</para>
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
</refentry>
|