man/sd-bus-errors.xml

   1 <?xml version='1.0'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
   5
   6 <refentry id="sd-bus-errors"
   7           xmlns:xi="http://www.w3.org/2001/XInclude">
   8
   9   <refentryinfo>
  10     <title>sd-bus-errors</title>
  11     <productname>systemd</productname>
  12   </refentryinfo>
  13
  14   <refmeta>
  15     <refentrytitle>sd-bus-errors</refentrytitle>
  16     <manvolnum>3</manvolnum>
  17   </refmeta>
  18
  19   <refnamediv>
  20     <refname>sd-bus-errors</refname>
  21     <refname>SD_BUS_ERROR_FAILED</refname>
  22     <refname>SD_BUS_ERROR_NO_MEMORY</refname>
  23     <refname>SD_BUS_ERROR_SERVICE_UNKNOWN</refname>
  24     <refname>SD_BUS_ERROR_NAME_HAS_NO_OWNER</refname>
  25     <refname>SD_BUS_ERROR_NO_REPLY</refname>
  26     <refname>SD_BUS_ERROR_IO_ERROR</refname>
  27     <refname>SD_BUS_ERROR_BAD_ADDRESS</refname>
  28     <refname>SD_BUS_ERROR_NOT_SUPPORTED</refname>
  29     <refname>SD_BUS_ERROR_LIMITS_EXCEEDED</refname>
  30     <refname>SD_BUS_ERROR_ACCESS_DENIED</refname>
  31     <refname>SD_BUS_ERROR_AUTH_FAILED</refname>
  32     <refname>SD_BUS_ERROR_NO_SERVER</refname>
  33     <refname>SD_BUS_ERROR_TIMEOUT</refname>
  34     <refname>SD_BUS_ERROR_NO_NETWORK</refname>
  35     <refname>SD_BUS_ERROR_ADDRESS_IN_USE</refname>
  36     <refname>SD_BUS_ERROR_DISCONNECTED</refname>
  37     <refname>SD_BUS_ERROR_INVALID_ARGS</refname>
  38     <refname>SD_BUS_ERROR_FILE_NOT_FOUND</refname>
  39     <refname>SD_BUS_ERROR_FILE_EXISTS</refname>
  40     <refname>SD_BUS_ERROR_UNKNOWN_METHOD</refname>
  41     <refname>SD_BUS_ERROR_UNKNOWN_OBJECT</refname>
  42     <refname>SD_BUS_ERROR_UNKNOWN_INTERFACE</refname>
  43     <refname>SD_BUS_ERROR_UNKNOWN_PROPERTY</refname>
  44     <refname>SD_BUS_ERROR_PROPERTY_READ_ONLY</refname>
  45     <refname>SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN</refname>
  46     <refname>SD_BUS_ERROR_INVALID_SIGNATURE</refname>
  47     <refname>SD_BUS_ERROR_INCONSISTENT_MESSAGE</refname>
  48     <refname>SD_BUS_ERROR_TIMED_OUT</refname>
  49     <refname>SD_BUS_ERROR_MATCH_RULE_NOT_FOUND</refname>
  50     <refname>SD_BUS_ERROR_MATCH_RULE_INVALID</refname>
  51     <refname>SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED</refname>
  52     <refname>SD_BUS_ERROR_INVALID_FILE_CONTENT</refname>
  53     <refname>SD_BUS_ERROR_SELINUX_SECURITY_CONTEXT_UNKNOWN</refname>
  54     <refname>SD_BUS_ERROR_OBJECT_PATH_IN_USE</refname>
  55
  56     <refpurpose>Standard D-Bus error names</refpurpose>
  57   </refnamediv>
  58
  59   <refsynopsisdiv>
  60     <funcsynopsis>
  61       <funcsynopsisinfo>#include &lt;systemd/sd-bus.h&gt;</funcsynopsisinfo>
  62
  63       <funcsynopsisinfo>
  64 #define SD_BUS_ERROR_FAILED                  "org.freedesktop.DBus.Error.Failed"
  65 #define SD_BUS_ERROR_NO_MEMORY               "org.freedesktop.DBus.Error.NoMemory"
  66 #define SD_BUS_ERROR_SERVICE_UNKNOWN         "org.freedesktop.DBus.Error.ServiceUnknown"
  67 #define SD_BUS_ERROR_NAME_HAS_NO_OWNER       "org.freedesktop.DBus.Error.NameHasNoOwner"
  68 #define SD_BUS_ERROR_NO_REPLY                "org.freedesktop.DBus.Error.NoReply"
  69 #define SD_BUS_ERROR_IO_ERROR                "org.freedesktop.DBus.Error.IOError"
  70 #define SD_BUS_ERROR_BAD_ADDRESS             "org.freedesktop.DBus.Error.BadAddress"
  71 #define SD_BUS_ERROR_NOT_SUPPORTED           "org.freedesktop.DBus.Error.NotSupported"
  72 #define SD_BUS_ERROR_LIMITS_EXCEEDED         "org.freedesktop.DBus.Error.LimitsExceeded"
  73 #define SD_BUS_ERROR_ACCESS_DENIED           "org.freedesktop.DBus.Error.AccessDenied"
  74 #define SD_BUS_ERROR_AUTH_FAILED             "org.freedesktop.DBus.Error.AuthFailed"
  75 #define SD_BUS_ERROR_NO_SERVER               "org.freedesktop.DBus.Error.NoServer"
  76 #define SD_BUS_ERROR_TIMEOUT                 "org.freedesktop.DBus.Error.Timeout"
  77 #define SD_BUS_ERROR_NO_NETWORK              "org.freedesktop.DBus.Error.NoNetwork"
  78 #define SD_BUS_ERROR_ADDRESS_IN_USE          "org.freedesktop.DBus.Error.AddressInUse"
  79 #define SD_BUS_ERROR_DISCONNECTED            "org.freedesktop.DBus.Error.Disconnected"
  80 #define SD_BUS_ERROR_INVALID_ARGS            "org.freedesktop.DBus.Error.InvalidArgs"
  81 #define SD_BUS_ERROR_FILE_NOT_FOUND          "org.freedesktop.DBus.Error.FileNotFound"
  82 #define SD_BUS_ERROR_FILE_EXISTS             "org.freedesktop.DBus.Error.FileExists"
  83 #define SD_BUS_ERROR_UNKNOWN_METHOD          "org.freedesktop.DBus.Error.UnknownMethod"
  84 #define SD_BUS_ERROR_UNKNOWN_OBJECT          "org.freedesktop.DBus.Error.UnknownObject"
  85 #define SD_BUS_ERROR_UNKNOWN_INTERFACE       "org.freedesktop.DBus.Error.UnknownInterface"
  86 #define SD_BUS_ERROR_UNKNOWN_PROPERTY        "org.freedesktop.DBus.Error.UnknownProperty"
  87 #define SD_BUS_ERROR_PROPERTY_READ_ONLY      "org.freedesktop.DBus.Error.PropertyReadOnly"
  88 #define SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN "org.freedesktop.DBus.Error.UnixProcessIdUnknown"
  89 #define SD_BUS_ERROR_INVALID_SIGNATURE       "org.freedesktop.DBus.Error.InvalidSignature"
  90 #define SD_BUS_ERROR_INCONSISTENT_MESSAGE    "org.freedesktop.DBus.Error.InconsistentMessage"
  91 #define SD_BUS_ERROR_TIMED_OUT               "org.freedesktop.DBus.Error.TimedOut"
  92 #define SD_BUS_ERROR_MATCH_RULE_NOT_FOUND    "org.freedesktop.DBus.Error.MatchRuleNotFound"
  93 #define SD_BUS_ERROR_MATCH_RULE_INVALID      "org.freedesktop.DBus.Error.MatchRuleInvalid"
  94 #define SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED \
  95                                              "org.freedesktop.DBus.Error.InteractiveAuthorizationRequired"
  96 #define SD_BUS_ERROR_INVALID_FILE_CONTENT    "org.freedesktop.DBus.Error.InvalidFileContent"
  97 #define SD_BUS_ERROR_SELINUX_SECURITY_CONTEXT_UNKNOWN \
  98                                              "org.freedesktop.DBus.Error.SELinuxSecurityContextUnknown"
  99 #define SD_BUS_ERROR_OBJECT_PATH_IN_USE      "org.freedesktop.DBus.Error.ObjectPathInUse"
 100       </funcsynopsisinfo>
 101     </funcsynopsis>
 102   </refsynopsisdiv>
 103
 104   <refsect1>
 105     <title>Description</title>
 106
 107     <para>In addition to the error names user programs define, D-Bus
 108     knows a number of generic, standardized error names that are
 109     listed below.</para>
 110
 111     <para>In addition to this list, in sd-bus, the special error
 112     namespace <literal>System.Error.</literal> is used to map
 113     arbitrary Linux system errors (as defined by <citerefentry
 114     project='man-pages'><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>)
 115     to D-Bus errors and back. For example, the error
 116     <constant>EUCLEAN</constant> is mapped to
 117     <literal>System.Error.EUCLEAN</literal> and back.</para>
 118
 119     <variablelist>
 120
 121       <varlistentry>
 122          <term><constant>SD_BUS_ERROR_FAILED</constant></term>
 123          <listitem><para>A generic error indication. See the error
 124          message for further details. This error name should be
 125          avoided, in favor of a more expressive error
 126          name.</para>
 127
 128          <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 129       </varlistentry>
 130
 131       <varlistentry>
 132         <term><constant>SD_BUS_ERROR_NO_MEMORY</constant></term>
 133         <listitem><para>A memory allocation failed, and the requested
 134         operation could not be completed.</para>
 135
 136         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 137       </varlistentry>
 138
 139       <varlistentry>
 140         <term><constant>SD_BUS_ERROR_SERVICE_UNKNOWN</constant></term>
 141         <listitem><para>The contacted bus service is unknown and
 142         cannot be activated.</para>
 143
 144         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 145       </varlistentry>
 146
 147       <varlistentry>
 148         <term><constant>SD_BUS_ERROR_NAME_HAS_NO_OWNER</constant></term>
 149         <listitem><para>The specified bus service name currently has
 150         no owner.</para>
 151
 152         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 153       </varlistentry>
 154       <varlistentry>
 155         <term><constant>SD_BUS_ERROR_NO_REPLY</constant></term>
 156         <listitem><para>A message did not receive a reply. This error
 157         is usually generated after a timeout.</para>
 158
 159         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 160       </varlistentry>
 161       <varlistentry>
 162         <term><constant>SD_BUS_ERROR_IO_ERROR</constant></term>
 163         <listitem><para>Generic input/output error, for example when
 164         accessing a socket or other I/O context.</para>
 165
 166         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 167       </varlistentry>
 168       <varlistentry>
 169         <term><constant>SD_BUS_ERROR_BAD_ADDRESS</constant></term>
 170         <listitem><para>The specified D-Bus bus address string is
 171         malformed.</para>
 172
 173         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 174       </varlistentry>
 175       <varlistentry>
 176         <term><constant>SD_BUS_ERROR_NOT_SUPPORTED</constant></term>
 177         <listitem><para>The requested operation is not supported on
 178         the local system.</para>
 179
 180         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 181       </varlistentry>
 182       <varlistentry>
 183         <term><constant>SD_BUS_ERROR_LIMITS_EXCEEDED</constant></term>
 184         <listitem><para>Some limited resource has been
 185         exhausted.</para>
 186
 187         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 188       </varlistentry>
 189       <varlistentry>
 190         <term><constant>SD_BUS_ERROR_ACCESS_DENIED</constant></term>
 191         <listitem><para>Access to a resource has been denied due to security restrictions.</para>
 192
 193         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 194       </varlistentry>
 195       <varlistentry>
 196         <term><constant>SD_BUS_ERROR_AUTH_FAILED</constant></term>
 197         <listitem><para>Authentication did not complete successfully.</para>
 198
 199         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 200       </varlistentry>
 201       <varlistentry>
 202         <term><constant>SD_BUS_ERROR_NO_SERVER</constant></term>
 203         <listitem><para>Unable to connect to the specified server.</para>
 204
 205         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 206       </varlistentry>
 207       <varlistentry>
 208         <term><constant>SD_BUS_ERROR_TIMEOUT</constant></term>
 209         <listitem><para>An operation timed out. Note that method calls
 210         which timeout generate a
 211         <constant>SD_BUS_ERROR_NO_REPLY</constant>.</para>
 212
 213         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 214       </varlistentry>
 215       <varlistentry>
 216         <term><constant>SD_BUS_ERROR_NO_NETWORK</constant></term>
 217         <listitem><para>No network available to execute requested network operation on.</para>
 218
 219         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 220       </varlistentry>
 221       <varlistentry>
 222         <term><constant>SD_BUS_ERROR_ADDRESS_IN_USE</constant></term>
 223         <listitem><para>The specified network address is already being listened on.</para>
 224
 225         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 226       </varlistentry>
 227       <varlistentry>
 228         <term><constant>SD_BUS_ERROR_DISCONNECTED</constant></term>
 229         <listitem><para>The connection has been terminated.</para>
 230
 231         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 232       </varlistentry>
 233       <varlistentry>
 234         <term><constant>SD_BUS_ERROR_INVALID_ARGS</constant></term>
 235         <listitem><para>One or more invalid arguments have been passed.</para>
 236
 237         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 238       </varlistentry>
 239       <varlistentry>
 240         <term><constant>SD_BUS_ERROR_FILE_NOT_FOUND</constant></term>
 241         <listitem><para>The requested file could not be found.</para>
 242
 243         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 244       </varlistentry>
 245       <varlistentry>
 246         <term><constant>SD_BUS_ERROR_FILE_EXISTS</constant></term>
 247         <listitem><para>The requested file already exists.</para>
 248
 249         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 250       </varlistentry>
 251       <varlistentry>
 252         <term><constant>SD_BUS_ERROR_UNKNOWN_METHOD</constant></term>
 253         <listitem><para>The requested method does not exist in the selected interface.</para>
 254
 255         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 256       </varlistentry>
 257       <varlistentry>
 258         <term><constant>SD_BUS_ERROR_UNKNOWN_OBJECT</constant></term>
 259         <listitem><para>The requested object does not exist in the selected service.</para>
 260
 261         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 262       </varlistentry>
 263       <varlistentry>
 264         <term><constant>SD_BUS_ERROR_UNKNOWN_INTERFACE</constant></term>
 265         <listitem><para>The requested interface does not exist on the selected object.</para>
 266
 267         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 268       </varlistentry>
 269       <varlistentry>
 270         <term><constant>SD_BUS_ERROR_UNKNOWN_PROPERTY</constant></term>
 271         <listitem><para>The requested property does not exist in the selected interface.</para>
 272
 273         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 274       </varlistentry>
 275       <varlistentry>
 276         <term><constant>SD_BUS_ERROR_PROPERTY_READ_ONLY</constant></term>
 277         <listitem><para>A write operation was requested on a read-only property.</para>
 278
 279         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 280       </varlistentry>
 281       <varlistentry>
 282         <term><constant>SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN</constant></term>
 283         <listitem><para>The requested PID is not known.</para>
 284
 285         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 286       </varlistentry>
 287       <varlistentry>
 288         <term><constant>SD_BUS_ERROR_INVALID_SIGNATURE</constant></term>
 289         <listitem><para>The specified message signature is not
 290         valid.</para>
 291
 292         <xi:include href="version-info.xml" xpointer="v223"/>
 293         </listitem>
 294       </varlistentry>
 295       <varlistentry>
 296         <term><constant>SD_BUS_ERROR_INCONSISTENT_MESSAGE</constant></term>
 297         <listitem><para>The passed message does not validate
 298         correctly.</para>
 299
 300         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 301       </varlistentry>
 302       <varlistentry>
 303         <term><constant>SD_BUS_ERROR_MATCH_RULE_NOT_FOUND</constant></term>
 304         <listitem><para>The specified match rule does not exist.</para>
 305
 306         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 307       </varlistentry>
 308       <varlistentry>
 309         <term><constant>SD_BUS_ERROR_MATCH_RULE_INVALID</constant></term>
 310         <listitem><para>The specified match rule is invalid.</para>
 311
 312         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 313       </varlistentry>
 314       <varlistentry>
 315         <term><constant>SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED</constant></term>
 316         <listitem><para>Access to the requested operation is not
 317         permitted. However, it might be available after interactive
 318         authentication. This is usually returned by method calls
 319         supporting a framework for additional interactive
 320         authorization, when interactive authorization was not enabled
 321         with the
 322         <citerefentry><refentrytitle>sd_bus_message_set_allow_interactive_authorization</refentrytitle><manvolnum>3</manvolnum></citerefentry>
 323         for the method call message.</para>
 324
 325         <xi:include href="version-info.xml" xpointer="v223"/></listitem>
 326       </varlistentry>
 327     </variablelist>
 328   </refsect1>
 329
 330   <xi:include href="libsystemd-pkgconfig.xml" />
 331
 332   <refsect1>
 333     <title>See Also</title>
 334
 335     <para><simplelist type="inline">
 336       <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
 337       <member><citerefentry><refentrytitle>libsystemd</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
 338       <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
 339       <member><citerefentry><refentrytitle>sd_bus_error</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
 340       <member><citerefentry><refentrytitle>sd_bus_message_set_allow_interactive_authorization</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
 341       <member><citerefentry project='man-pages'><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
 342       <member><citerefentry project='man-pages'><refentrytitle>strerror_r</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
 343     </simplelist></para>
 344   </refsect1>
 345
 346 </refentry>