1 <?xml version='
1.0'
?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6 SPDX-License-Identifier: LGPL-2.1+
9 <refentry id=
"sd-bus-errors">
12 <title>sd-bus-errors
</title>
13 <productname>systemd
</productname>
17 <contrib>Developer
</contrib>
18 <firstname>Lennart
</firstname>
19 <surname>Poettering
</surname>
20 <email>lennart@poettering.net
</email>
26 <refentrytitle>sd-bus-errors
</refentrytitle>
27 <manvolnum>3</manvolnum>
31 <refname>sd-bus-errors
</refname>
32 <refname>SD_BUS_ERROR_FAILED
</refname>
33 <refname>SD_BUS_ERROR_NO_MEMORY
</refname>
34 <refname>SD_BUS_ERROR_SERVICE_UNKNOWN
</refname>
35 <refname>SD_BUS_ERROR_NAME_HAS_NO_OWNER
</refname>
36 <refname>SD_BUS_ERROR_NO_REPLY
</refname>
37 <refname>SD_BUS_ERROR_IO_ERROR
</refname>
38 <refname>SD_BUS_ERROR_BAD_ADDRESS
</refname>
39 <refname>SD_BUS_ERROR_NOT_SUPPORTED
</refname>
40 <refname>SD_BUS_ERROR_LIMITS_EXCEEDED
</refname>
41 <refname>SD_BUS_ERROR_ACCESS_DENIED
</refname>
42 <refname>SD_BUS_ERROR_AUTH_FAILED
</refname>
43 <refname>SD_BUS_ERROR_NO_SERVER
</refname>
44 <refname>SD_BUS_ERROR_TIMEOUT
</refname>
45 <refname>SD_BUS_ERROR_NO_NETWORK
</refname>
46 <refname>SD_BUS_ERROR_ADDRESS_IN_USE
</refname>
47 <refname>SD_BUS_ERROR_DISCONNECTED
</refname>
48 <refname>SD_BUS_ERROR_INVALID_ARGS
</refname>
49 <refname>SD_BUS_ERROR_FILE_NOT_FOUND
</refname>
50 <refname>SD_BUS_ERROR_FILE_EXISTS
</refname>
51 <refname>SD_BUS_ERROR_UNKNOWN_METHOD
</refname>
52 <refname>SD_BUS_ERROR_UNKNOWN_OBJECT
</refname>
53 <refname>SD_BUS_ERROR_UNKNOWN_INTERFACE
</refname>
54 <refname>SD_BUS_ERROR_UNKNOWN_PROPERTY
</refname>
55 <refname>SD_BUS_ERROR_PROPERTY_READ_ONLY
</refname>
56 <refname>SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN
</refname>
57 <refname>SD_BUS_ERROR_INVALID_SIGNATURE
</refname>
58 <refname>SD_BUS_ERROR_INCONSISTENT_MESSAGE
</refname>
59 <refname>SD_BUS_ERROR_MATCH_RULE_NOT_FOUND
</refname>
60 <refname>SD_BUS_ERROR_MATCH_RULE_INVALID
</refname>
61 <refname>SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED
</refname>
63 <refpurpose>Standard D-Bus error names
</refpurpose>
68 <funcsynopsisinfo>#include
<systemd/sd-bus.h
></funcsynopsisinfo>
70 <funcsynopsisinfo>#define SD_BUS_ERROR_FAILED
"org.freedesktop.DBus.Error.Failed"
71 #define SD_BUS_ERROR_NO_MEMORY
"org.freedesktop.DBus.Error.NoMemory"
72 #define SD_BUS_ERROR_SERVICE_UNKNOWN
"org.freedesktop.DBus.Error.ServiceUnknown"
73 #define SD_BUS_ERROR_NAME_HAS_NO_OWNER
"org.freedesktop.DBus.Error.NameHasNoOwner"
74 #define SD_BUS_ERROR_NO_REPLY
"org.freedesktop.DBus.Error.NoReply"
75 #define SD_BUS_ERROR_IO_ERROR
"org.freedesktop.DBus.Error.IOError"
76 #define SD_BUS_ERROR_BAD_ADDRESS
"org.freedesktop.DBus.Error.BadAddress"
77 #define SD_BUS_ERROR_NOT_SUPPORTED
"org.freedesktop.DBus.Error.NotSupported"
78 #define SD_BUS_ERROR_LIMITS_EXCEEDED
"org.freedesktop.DBus.Error.LimitsExceeded"
79 #define SD_BUS_ERROR_ACCESS_DENIED
"org.freedesktop.DBus.Error.AccessDenied"
80 #define SD_BUS_ERROR_AUTH_FAILED
"org.freedesktop.DBus.Error.AuthFailed"
81 #define SD_BUS_ERROR_NO_SERVER
"org.freedesktop.DBus.Error.NoServer"
82 #define SD_BUS_ERROR_TIMEOUT
"org.freedesktop.DBus.Error.Timeout"
83 #define SD_BUS_ERROR_NO_NETWORK
"org.freedesktop.DBus.Error.NoNetwork"
84 #define SD_BUS_ERROR_ADDRESS_IN_USE
"org.freedesktop.DBus.Error.AddressInUse"
85 #define SD_BUS_ERROR_DISCONNECTED
"org.freedesktop.DBus.Error.Disconnected"
86 #define SD_BUS_ERROR_INVALID_ARGS
"org.freedesktop.DBus.Error.InvalidArgs"
87 #define SD_BUS_ERROR_FILE_NOT_FOUND
"org.freedesktop.DBus.Error.FileNotFound"
88 #define SD_BUS_ERROR_FILE_EXISTS
"org.freedesktop.DBus.Error.FileExists"
89 #define SD_BUS_ERROR_UNKNOWN_METHOD
"org.freedesktop.DBus.Error.UnknownMethod"
90 #define SD_BUS_ERROR_UNKNOWN_OBJECT
"org.freedesktop.DBus.Error.UnknownObject"
91 #define SD_BUS_ERROR_UNKNOWN_INTERFACE
"org.freedesktop.DBus.Error.UnknownInterface"
92 #define SD_BUS_ERROR_UNKNOWN_PROPERTY
"org.freedesktop.DBus.Error.UnknownProperty"
93 #define SD_BUS_ERROR_PROPERTY_READ_ONLY
"org.freedesktop.DBus.Error.PropertyReadOnly"
94 #define SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN
"org.freedesktop.DBus.Error.UnixProcessIdUnknown"
95 #define SD_BUS_ERROR_INVALID_SIGNATURE
"org.freedesktop.DBus.Error.InvalidSignature"
96 #define SD_BUS_ERROR_INCONSISTENT_MESSAGE
"org.freedesktop.DBus.Error.InconsistentMessage"
97 #define SD_BUS_ERROR_MATCH_RULE_NOT_FOUND
"org.freedesktop.DBus.Error.MatchRuleNotFound"
98 #define SD_BUS_ERROR_MATCH_RULE_INVALID
"org.freedesktop.DBus.Error.MatchRuleInvalid"
99 #define SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED \
100 "org.freedesktop.DBus.Error.InteractiveAuthorizationRequired"</funcsynopsisinfo>
106 <title>Description
</title>
108 <para>In addition to the error names user programs define, D-Bus
109 knows a number of generic, standardized error names that are
112 <para>In addition to this list, in sd-bus, the special error
113 namespace
<literal>System.Error.
</literal> is used to map
114 arbitrary Linux system errors (as defined by
<citerefentry
115 project='man-pages'
><refentrytitle>errno
</refentrytitle><manvolnum>3</manvolnum></citerefentry>)
116 to D-Bus errors and back. For example, the error
117 <constant>EUCLEAN
</constant> is mapped to
118 <literal>System.Error.EUCLEAN
</literal> and back.
</para>
123 <term><varname>SD_BUS_ERROR_FAILED
</varname></term>
124 <listitem><para>A generic error indication. See the error
125 message for further details. This error name should be
126 avoided, in favor of a more expressive error
127 name.
</para></listitem>
131 <term><varname>SD_BUS_ERROR_NO_MEMORY
</varname></term>
132 <listitem><para>A memory allocation failed, and the requested
133 operation could not be completed.
</para></listitem>
137 <term><varname>SD_BUS_ERROR_SERVICE_UNKNOWN
</varname></term>
138 <listitem><para>The contacted bus service is unknown and
139 cannot be activated.
</para></listitem>
143 <term><varname>SD_BUS_ERROR_NAME_HAS_NO_OWNER
</varname></term>
144 <listitem><para>The specified bus service name currently has
145 no owner.
</para></listitem>
148 <term><varname>SD_BUS_ERROR_NO_REPLY
</varname></term>
149 <listitem><para>A message did not receive a reply. This error
150 is usually generated after a timeout.
</para></listitem>
153 <term><varname>SD_BUS_ERROR_IO_ERROR
</varname></term>
154 <listitem><para>Generic input/output error, for example when
155 accessing a socket or other I/O context.
</para></listitem>
158 <term><varname>SD_BUS_ERROR_BAD_ADDRESS
</varname></term>
159 <listitem><para>The specified D-Bus bus address string is
160 malformed.
</para></listitem>
163 <term><varname>SD_BUS_ERROR_NOT_SUPPORTED
</varname></term>
164 <listitem><para>The requested operation is not supported on
165 the local system.
</para></listitem>
168 <term><varname>SD_BUS_ERROR_LIMITS_EXCEEDED
</varname></term>
169 <listitem><para>Some limited resource has been
170 exhausted.
</para></listitem>
173 <term><varname>SD_BUS_ERROR_ACCESS_DENIED
</varname></term>
174 <listitem><para>Access to a resource has been denied due to security restrictions.
</para></listitem>
177 <term><varname>SD_BUS_ERROR_AUTH_FAILED
</varname></term>
178 <listitem><para>Authentication did not complete successfully.
</para></listitem>
181 <term><varname>SD_BUS_ERROR_NO_SERVER
</varname></term>
182 <listitem><para>Unable to connect to the specified server.
</para></listitem>
185 <term><varname>SD_BUS_ERROR_TIMEOUT
</varname></term>
186 <listitem><para>An operation timed out. Note that method calls
187 which timeout generate a
188 <varname>SD_BUS_ERROR_NO_REPLY
</varname>.
</para></listitem>
191 <term><varname>SD_BUS_ERROR_NO_NETWORK
</varname></term>
192 <listitem><para>No network available to execute requested network operation on.
</para></listitem>
195 <term><varname>SD_BUS_ERROR_ADDRESS_IN_USE
</varname></term>
196 <listitem><para>The specified network address is already being listened on.
</para></listitem>
199 <term><varname>SD_BUS_ERROR_DISCONNECTED
</varname></term>
200 <listitem><para>The connection has been terminated.
</para></listitem>
203 <term><varname>SD_BUS_ERROR_INVALID_ARGS
</varname></term>
204 <listitem><para>One or more invalid arguments have been passed.
</para></listitem>
207 <term><varname>SD_BUS_ERROR_FILE_NOT_FOUND
</varname></term>
208 <listitem><para>The requested file could not be found.
</para></listitem>
211 <term><varname>SD_BUS_ERROR_FILE_EXISTS
</varname></term>
212 <listitem><para>The requested file already exists.
</para></listitem>
215 <term><varname>SD_BUS_ERROR_UNKNOWN_METHOD
</varname></term>
216 <listitem><para>The requested method does not exist in the selected interface.
</para></listitem>
219 <term><varname>SD_BUS_ERROR_UNKNOWN_OBJECT
</varname></term>
220 <listitem><para>The requested object does not exist in the selected service.
</para></listitem>
223 <term><varname>SD_BUS_ERROR_UNKNOWN_INTERFACE
</varname></term>
224 <listitem><para>The requested interface does not exist on the selected object.
</para></listitem>
227 <term><varname>SD_BUS_ERROR_UNKNOWN_PROPERTY
</varname></term>
228 <listitem><para>The requested property does not exist in the selected interface.
</para></listitem>
231 <term><varname>SD_BUS_ERROR_PROPERTY_READ_ONLY
</varname></term>
232 <listitem><para>A write operation was requested on a read-only property.
</para></listitem>
235 <term><varname>SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN
</varname></term>
236 <listitem><para>The requested PID is not known.
</para></listitem>
239 <term><varname>SD_BUS_ERROR_INVALID_SIGNATURE
</varname></term>
240 <listitem><para>The specified message signature is not
245 <term><varname>SD_BUS_ERROR_INCONSISTENT_MESSAGE
</varname></term>
246 <listitem><para>The passed message does not validate
247 correctly.
</para></listitem>
250 <term><varname>SD_BUS_ERROR_MATCH_RULE_NOT_FOUND
</varname></term>
251 <listitem><para>The specified match rule does not exist.
</para></listitem>
254 <term><varname>SD_BUS_ERROR_MATCH_RULE_INVALID
</varname></term>
255 <listitem><para>The specified match rule is invalid.
</para></listitem>
258 <term><varname>SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED
</varname></term>
259 <listitem><para>Access to the requested operation is not
260 permitted. However, it might be available after interactive
261 authentication. This is usually returned by method calls
262 supporting a framework for additional interactive
263 authorization, when interactive authorization was not enabled
265 <citerefentry><refentrytitle>sd_bus_message_set_allow_interactive_authorization
</refentrytitle><manvolnum>3</manvolnum></citerefentry>
266 for the method call message.
</para></listitem>
274 <para>The various error definitions described here are available
275 as a shared library, which can be compiled and linked to with the
276 <constant>libsystemd
</constant> <citerefentry
277 project='die-net'
><refentrytitle>pkg-config
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
282 <title>See Also
</title>
285 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
286 <citerefentry><refentrytitle>sd-bus
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
287 <citerefentry><refentrytitle>sd_bus_error
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
288 <citerefentry><refentrytitle>sd_bus_message_set_allow_interactive_authorization
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
289 <citerefentry project='man-pages'
><refentrytitle>errno
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
290 <citerefentry project='die-net'
><refentrytitle>strerror
</refentrytitle><manvolnum>3</manvolnum></citerefentry>