summaryrefslogtreecommitdiff
path: root/man/sd_bus_set_description.xml
blob: b855008eb8ecbf16310c74381f308d72bb439549 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1+ -->

<refentry id="sd_bus_set_description" xmlns:xi="http://www.w3.org/2001/XInclude">

  <refentryinfo>
    <title>sd_bus_set_description</title>
    <productname>systemd</productname>
  </refentryinfo>

  <refmeta>
    <refentrytitle>sd_bus_set_description</refentrytitle>
    <manvolnum>3</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>sd_bus_set_description</refname>
    <refname>sd_bus_get_description</refname>
    <refname>sd_bus_set_anonymous</refname>
    <refname>sd_bus_is_anonymous</refname>
    <refname>sd_bus_set_trusted</refname>
    <refname>sd_bus_is_trusted</refname>
    <refname>sd_bus_set_allow_interactive_authorization</refname>
    <refname>sd_bus_get_allow_interactive_authorization</refname>

    <refpurpose>Set or query properties of a bus object</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <funcsynopsis>
      <funcsynopsisinfo>#include &lt;systemd/sd-bus.h&gt;</funcsynopsisinfo>

      <funcprototype>
        <funcdef>int <function>sd_bus_set_description</function></funcdef>
        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
        <paramdef>const char *<parameter>description</parameter></paramdef>
      </funcprototype>

      <funcprototype>
        <funcdef>int <function>sd_bus_get_description</function></funcdef>
        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
        <paramdef>const char **<parameter>description</parameter></paramdef>
      </funcprototype>

      <funcprototype>
        <funcdef>int <function>sd_bus_set_anonymous</function></funcdef>
        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
        <paramdef>int <parameter>b</parameter></paramdef>
      </funcprototype>

      <funcprototype>
        <funcdef>int <function>sd_bus_is_anonymous</function></funcdef>
        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
      </funcprototype>

      <funcprototype>
        <funcdef>int <function>sd_bus_set_trusted</function></funcdef>
        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
        <paramdef>int <parameter>b</parameter></paramdef>
      </funcprototype>

      <funcprototype>
        <funcdef>int <function>sd_bus_is_trusted</function></funcdef>
        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
      </funcprototype>

      <funcprototype>
        <funcdef>int <function>sd_bus_set_allow_interactive_authorization</function></funcdef>
        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
        <paramdef>int <parameter>b</parameter></paramdef>
      </funcprototype>

      <funcprototype>
        <funcdef>int <function>sd_bus_get_allow_interactive_authorization</function></funcdef>
        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para><function>sd_bus_set_description()</function> sets the description string
    that is used in logging to the specified string. The string is copied internally
    and freed when the bus object is deallocated. The
    <parameter>description</parameter> argument may be <constant>NULL</constant>, in
    which case the description is unset. This function must be called before the bus
    is started.</para>

    <para><function>sd_bus_get_description()</function> returns a description string
    in <parameter>description</parameter>. This string may have been previously set
    with <function>sd_bus_set_description()</function> or
    <citerefentry><refentrytitle>sd_bus_open_with_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>
    or similar. If not set this way, a default string like <literal>system</literal>
    or <literal>user</literal> will be returned for the system or user buses,
    and <constant>NULL</constant> otherwise.</para>

    <para><function>sd_bus_set_anonymous()</function> enables or disables "anonymous
    authentication", i.e. lack of authentication, of the bus peer. This function must
    be called before the bus is started. See the <ulink
    url="view-source:https://dbus.freedesktop.org/doc/dbus-specification.html#auth-mechanisms">Authentication
    Mechanisms</ulink> section of the D-Bus specification for details.</para>

    <para><function>sd_bus_is_anonymous()</function> returns true if the bus connection allows anonymous
    authentication (in the sense described in previous paragraph).</para>

    <para><function>sd_bus_set_trusted()</function> sets the "trusted" state on the
    <parameter>bus</parameter> object. If true, all connections on the bus are
    trusted and access to all privileged and unprivileged methods is granted. This
    function must be called before the bus is started.</para>

    <para><function>sd_bus_is_trusted()</function> returns true if the bus connection is trusted (in the
    sense described in previous paragraph).</para>

    <para><function>sd_bus_set_allow_interactive_authorization()</function>
    enables or disables interactive authorization for method calls. If true,
    messages are marked with the
    <constant>ALLOW_INTERACTIVE_AUTHORIZATION</constant> flag specified by the
    <ulink
    url="view-source:https://dbus.freedesktop.org/doc/dbus-specification.html">D-Bus</ulink>
    specification, informing the receiving side that the caller is prepared to
    wait for interactive authorization, which might take a considerable time to
    complete. If this flag is set, the user may be queried for passwords or
    confirmation via <ulink
    url="http://www.freedesktop.org/wiki/Software/polkit">polkit</ulink> or a
    similar framework.</para>

    <para><function>sd_bus_get_allow_interactive_authorization()</function> returns
    true if interactive authorization is allowed and false if not.</para>
  </refsect1>

  <refsect1>
    <title>Return Value</title>

    <para>On success, these functions return a non-negative integer. On failure, they return a
    negative errno-style error code.</para>

    <refsect2>
      <title>Errors</title>

      <para>Returned errors may indicate the following problems:</para>

      <variablelist>
        <varlistentry>
          <term><constant>-EINVAL</constant></term>

          <listitem><para>An argument is invalid.</para></listitem>
        </varlistentry>

        <varlistentry>
          <term><constant>-ENOPKG</constant></term>

          <listitem><para>The bus cannot be resolved.</para></listitem>
        </varlistentry>

        <varlistentry>
          <term><constant>-EPERM</constant></term>

          <listitem><para>The bus has already been started.</para></listitem>
        </varlistentry>

        <varlistentry>
          <term><constant>-ECHILD</constant></term>

          <listitem><para>The bus was created in a different process.</para></listitem>
        </varlistentry>

        <varlistentry>
          <term><constant>-ENOMEM</constant></term>

          <listitem><para>Memory allocation failed.</para></listitem>
        </varlistentry>
      </variablelist>

    </refsect2>
  </refsect1>

  <xi:include href="libsystemd-pkgconfig.xml" />

  <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_default_user</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>sd_bus_default_system</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>sd_bus_open_user</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>sd_bus_open_system</refentrytitle><manvolnum>3</manvolnum></citerefentry>
    </para>
  </refsect1>

</refentry>