11a1589223
Files which are installed as-is (any .service and other unit files, .conf files, .policy files, etc), are left as is. My assumption is that SPDX identifiers are not yet that well known, so it's better to retain the extended header to avoid any doubt. I also kept any copyright lines. We can probably remove them, but it'd nice to obtain explicit acks from all involved authors before doing that.
124 lines
4.4 KiB
XML
124 lines
4.4 KiB
XML
<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
|
||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
||
|
||
<!--
|
||
SPDX-License-Identifier: LGPL-2.1+
|
||
|
||
This file is part of systemd.
|
||
|
||
Copyright 2017 Lennart Poettering
|
||
-->
|
||
|
||
<refentry id="sd_bus_set_sender">
|
||
|
||
<refentryinfo>
|
||
<title>sd_bus_set_sender</title>
|
||
<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_set_sender</refentrytitle>
|
||
<manvolnum>3</manvolnum>
|
||
</refmeta>
|
||
|
||
<refnamediv>
|
||
<refname>sd_bus_set_sender</refname>
|
||
<refname>sd_bus_get_sender</refname>
|
||
|
||
<refpurpose>Configure default sender for outgoing messages</refpurpose>
|
||
</refnamediv>
|
||
|
||
<refsynopsisdiv>
|
||
<funcsynopsis>
|
||
<funcsynopsisinfo>#include <systemd/sd-bus.h></funcsynopsisinfo>
|
||
|
||
<funcprototype>
|
||
<funcdef>int <function>sd_bus_set_sender</function></funcdef>
|
||
<paramdef>sd_bus *<parameter>bus</parameter></paramdef>
|
||
<paramdef>const char* <parameter>name</parameter></paramdef>
|
||
</funcprototype>
|
||
|
||
<funcprototype>
|
||
<funcdef>int <function>sd_bus_get_sender</function></funcdef>
|
||
<paramdef>sd_bus *<parameter>bus</parameter></paramdef>
|
||
<paramdef>const char** <parameter>name</parameter></paramdef>
|
||
</funcprototype>
|
||
|
||
</funcsynopsis>
|
||
</refsynopsisdiv>
|
||
|
||
<refsect1>
|
||
<title>Description</title>
|
||
|
||
<para><function>sd_bus_set_sender()</function> configures the default sender service name to use for outgoing
|
||
messages. The service name specified in the <parameter>name</parameter> parameter is set on all outgoing messages
|
||
that are sent on the connection and have no sender set yet, for example through
|
||
<citerefentry><refentrytitle>sd_bus_message_set_sender</refentrytitle><manvolnum>3</manvolnum></citerefentry>. Note
|
||
that this function is only supported on direct connections, i.e. not on connections to a bus broker as the broker
|
||
will fill in the sender service name automatically anyway. By default no sender name is configured, and hence
|
||
messages are sent without sender field set. If the <parameter>name</parameter> parameter is specified as
|
||
<constant>NULL</constant> the default sender service name is cleared, returning to the default state if a default
|
||
sender service name was set before. If passed as non-<constant>NULL</constant> the specified name must be a valid
|
||
unique or well-known service name.</para>
|
||
|
||
<para><function>sd_bus_get_sender()</function> may be used to query the current default service name for outgoing
|
||
messages.</para>
|
||
</refsect1>
|
||
|
||
<refsect1>
|
||
<title>Return Value</title>
|
||
|
||
<para>On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style
|
||
error code.</para>
|
||
</refsect1>
|
||
|
||
<refsect1>
|
||
<title>Errors</title>
|
||
|
||
<para>Returned errors may indicate the following problems:</para>
|
||
|
||
<variablelist>
|
||
<varlistentry>
|
||
<term><constant>-ECHILD</constant></term>
|
||
|
||
<listitem><para>The bus connection has been created in a different process.</para></listitem>
|
||
</varlistentry>
|
||
|
||
<varlistentry>
|
||
<term><constant>-EPERM</constant></term>
|
||
|
||
<listitem><para>The specified bus connection object is a not a direct but a brokered connection.</para></listitem>
|
||
</varlistentry>
|
||
</variablelist>
|
||
</refsect1>
|
||
|
||
<refsect1>
|
||
<title>Notes</title>
|
||
|
||
<para><function>sd_bus_set_sender()</function> and <function>sd_bus_get_sender()</function> are available as
|
||
a shared library, which can be compiled and linked to with the <constant>libsystemd</constant> <citerefentry
|
||
project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> 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_message_set_sender</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
||
</para>
|
||
</refsect1>
|
||
|
||
</refentry>
|