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 <refentrytitle>sd-bus-errors
</refentrytitle>
18 <manvolnum>3</manvolnum>
22 <refname>sd-bus-errors
</refname>
23 <refname>SD_BUS_ERROR_FAILED
</refname>
24 <refname>SD_BUS_ERROR_NO_MEMORY
</refname>
25 <refname>SD_BUS_ERROR_SERVICE_UNKNOWN
</refname>
26 <refname>SD_BUS_ERROR_NAME_HAS_NO_OWNER
</refname>
27 <refname>SD_BUS_ERROR_NO_REPLY
</refname>
28 <refname>SD_BUS_ERROR_IO_ERROR
</refname>
29 <refname>SD_BUS_ERROR_BAD_ADDRESS
</refname>
30 <refname>SD_BUS_ERROR_NOT_SUPPORTED
</refname>
31 <refname>SD_BUS_ERROR_LIMITS_EXCEEDED
</refname>
32 <refname>SD_BUS_ERROR_ACCESS_DENIED
</refname>
33 <refname>SD_BUS_ERROR_AUTH_FAILED
</refname>
34 <refname>SD_BUS_ERROR_NO_SERVER
</refname>
35 <refname>SD_BUS_ERROR_TIMEOUT
</refname>
36 <refname>SD_BUS_ERROR_NO_NETWORK
</refname>
37 <refname>SD_BUS_ERROR_ADDRESS_IN_USE
</refname>
38 <refname>SD_BUS_ERROR_DISCONNECTED
</refname>
39 <refname>SD_BUS_ERROR_INVALID_ARGS
</refname>
40 <refname>SD_BUS_ERROR_FILE_NOT_FOUND
</refname>
41 <refname>SD_BUS_ERROR_FILE_EXISTS
</refname>
42 <refname>SD_BUS_ERROR_UNKNOWN_METHOD
</refname>
43 <refname>SD_BUS_ERROR_UNKNOWN_OBJECT
</refname>
44 <refname>SD_BUS_ERROR_UNKNOWN_INTERFACE
</refname>
45 <refname>SD_BUS_ERROR_UNKNOWN_PROPERTY
</refname>
46 <refname>SD_BUS_ERROR_PROPERTY_READ_ONLY
</refname>
47 <refname>SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN
</refname>
48 <refname>SD_BUS_ERROR_INVALID_SIGNATURE
</refname>
49 <refname>SD_BUS_ERROR_INCONSISTENT_MESSAGE
</refname>
50 <refname>SD_BUS_ERROR_MATCH_RULE_NOT_FOUND
</refname>
51 <refname>SD_BUS_ERROR_MATCH_RULE_INVALID
</refname>
52 <refname>SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED
</refname>
54 <refpurpose>Standard D-Bus error names
</refpurpose>
59 <funcsynopsisinfo>#include
<systemd/sd-bus.h
></funcsynopsisinfo>
61 <funcsynopsisinfo>#define SD_BUS_ERROR_FAILED
"org.freedesktop.DBus.Error.Failed"
62 #define SD_BUS_ERROR_NO_MEMORY
"org.freedesktop.DBus.Error.NoMemory"
63 #define SD_BUS_ERROR_SERVICE_UNKNOWN
"org.freedesktop.DBus.Error.ServiceUnknown"
64 #define SD_BUS_ERROR_NAME_HAS_NO_OWNER
"org.freedesktop.DBus.Error.NameHasNoOwner"
65 #define SD_BUS_ERROR_NO_REPLY
"org.freedesktop.DBus.Error.NoReply"
66 #define SD_BUS_ERROR_IO_ERROR
"org.freedesktop.DBus.Error.IOError"
67 #define SD_BUS_ERROR_BAD_ADDRESS
"org.freedesktop.DBus.Error.BadAddress"
68 #define SD_BUS_ERROR_NOT_SUPPORTED
"org.freedesktop.DBus.Error.NotSupported"
69 #define SD_BUS_ERROR_LIMITS_EXCEEDED
"org.freedesktop.DBus.Error.LimitsExceeded"
70 #define SD_BUS_ERROR_ACCESS_DENIED
"org.freedesktop.DBus.Error.AccessDenied"
71 #define SD_BUS_ERROR_AUTH_FAILED
"org.freedesktop.DBus.Error.AuthFailed"
72 #define SD_BUS_ERROR_NO_SERVER
"org.freedesktop.DBus.Error.NoServer"
73 #define SD_BUS_ERROR_TIMEOUT
"org.freedesktop.DBus.Error.Timeout"
74 #define SD_BUS_ERROR_NO_NETWORK
"org.freedesktop.DBus.Error.NoNetwork"
75 #define SD_BUS_ERROR_ADDRESS_IN_USE
"org.freedesktop.DBus.Error.AddressInUse"
76 #define SD_BUS_ERROR_DISCONNECTED
"org.freedesktop.DBus.Error.Disconnected"
77 #define SD_BUS_ERROR_INVALID_ARGS
"org.freedesktop.DBus.Error.InvalidArgs"
78 #define SD_BUS_ERROR_FILE_NOT_FOUND
"org.freedesktop.DBus.Error.FileNotFound"
79 #define SD_BUS_ERROR_FILE_EXISTS
"org.freedesktop.DBus.Error.FileExists"
80 #define SD_BUS_ERROR_UNKNOWN_METHOD
"org.freedesktop.DBus.Error.UnknownMethod"
81 #define SD_BUS_ERROR_UNKNOWN_OBJECT
"org.freedesktop.DBus.Error.UnknownObject"
82 #define SD_BUS_ERROR_UNKNOWN_INTERFACE
"org.freedesktop.DBus.Error.UnknownInterface"
83 #define SD_BUS_ERROR_UNKNOWN_PROPERTY
"org.freedesktop.DBus.Error.UnknownProperty"
84 #define SD_BUS_ERROR_PROPERTY_READ_ONLY
"org.freedesktop.DBus.Error.PropertyReadOnly"
85 #define SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN
"org.freedesktop.DBus.Error.UnixProcessIdUnknown"
86 #define SD_BUS_ERROR_INVALID_SIGNATURE
"org.freedesktop.DBus.Error.InvalidSignature"
87 #define SD_BUS_ERROR_INCONSISTENT_MESSAGE
"org.freedesktop.DBus.Error.InconsistentMessage"
88 #define SD_BUS_ERROR_MATCH_RULE_NOT_FOUND
"org.freedesktop.DBus.Error.MatchRuleNotFound"
89 #define SD_BUS_ERROR_MATCH_RULE_INVALID
"org.freedesktop.DBus.Error.MatchRuleInvalid"
90 #define SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED \
91 "org.freedesktop.DBus.Error.InteractiveAuthorizationRequired"</funcsynopsisinfo>
97 <title>Description
</title>
99 <para>In addition to the error names user programs define, D-Bus
100 knows a number of generic, standardized error names that are
103 <para>In addition to this list, in sd-bus, the special error
104 namespace
<literal>System.Error.
</literal> is used to map
105 arbitrary Linux system errors (as defined by
<citerefentry
106 project='man-pages'
><refentrytitle>errno
</refentrytitle><manvolnum>3</manvolnum></citerefentry>)
107 to D-Bus errors and back. For example, the error
108 <constant>EUCLEAN
</constant> is mapped to
109 <literal>System.Error.EUCLEAN
</literal> and back.
</para>
114 <term><varname>SD_BUS_ERROR_FAILED
</varname></term>
115 <listitem><para>A generic error indication. See the error
116 message for further details. This error name should be
117 avoided, in favor of a more expressive error
118 name.
</para></listitem>
122 <term><varname>SD_BUS_ERROR_NO_MEMORY
</varname></term>
123 <listitem><para>A memory allocation failed, and the requested
124 operation could not be completed.
</para></listitem>
128 <term><varname>SD_BUS_ERROR_SERVICE_UNKNOWN
</varname></term>
129 <listitem><para>The contacted bus service is unknown and
130 cannot be activated.
</para></listitem>
134 <term><varname>SD_BUS_ERROR_NAME_HAS_NO_OWNER
</varname></term>
135 <listitem><para>The specified bus service name currently has
136 no owner.
</para></listitem>
139 <term><varname>SD_BUS_ERROR_NO_REPLY
</varname></term>
140 <listitem><para>A message did not receive a reply. This error
141 is usually generated after a timeout.
</para></listitem>
144 <term><varname>SD_BUS_ERROR_IO_ERROR
</varname></term>
145 <listitem><para>Generic input/output error, for example when
146 accessing a socket or other I/O context.
</para></listitem>
149 <term><varname>SD_BUS_ERROR_BAD_ADDRESS
</varname></term>
150 <listitem><para>The specified D-Bus bus address string is
151 malformed.
</para></listitem>
154 <term><varname>SD_BUS_ERROR_NOT_SUPPORTED
</varname></term>
155 <listitem><para>The requested operation is not supported on
156 the local system.
</para></listitem>
159 <term><varname>SD_BUS_ERROR_LIMITS_EXCEEDED
</varname></term>
160 <listitem><para>Some limited resource has been
161 exhausted.
</para></listitem>
164 <term><varname>SD_BUS_ERROR_ACCESS_DENIED
</varname></term>
165 <listitem><para>Access to a resource has been denied due to security restrictions.
</para></listitem>
168 <term><varname>SD_BUS_ERROR_AUTH_FAILED
</varname></term>
169 <listitem><para>Authentication did not complete successfully.
</para></listitem>
172 <term><varname>SD_BUS_ERROR_NO_SERVER
</varname></term>
173 <listitem><para>Unable to connect to the specified server.
</para></listitem>
176 <term><varname>SD_BUS_ERROR_TIMEOUT
</varname></term>
177 <listitem><para>An operation timed out. Note that method calls
178 which timeout generate a
179 <varname>SD_BUS_ERROR_NO_REPLY
</varname>.
</para></listitem>
182 <term><varname>SD_BUS_ERROR_NO_NETWORK
</varname></term>
183 <listitem><para>No network available to execute requested network operation on.
</para></listitem>
186 <term><varname>SD_BUS_ERROR_ADDRESS_IN_USE
</varname></term>
187 <listitem><para>The specified network address is already being listened on.
</para></listitem>
190 <term><varname>SD_BUS_ERROR_DISCONNECTED
</varname></term>
191 <listitem><para>The connection has been terminated.
</para></listitem>
194 <term><varname>SD_BUS_ERROR_INVALID_ARGS
</varname></term>
195 <listitem><para>One or more invalid arguments have been passed.
</para></listitem>
198 <term><varname>SD_BUS_ERROR_FILE_NOT_FOUND
</varname></term>
199 <listitem><para>The requested file could not be found.
</para></listitem>
202 <term><varname>SD_BUS_ERROR_FILE_EXISTS
</varname></term>
203 <listitem><para>The requested file already exists.
</para></listitem>
206 <term><varname>SD_BUS_ERROR_UNKNOWN_METHOD
</varname></term>
207 <listitem><para>The requested method does not exist in the selected interface.
</para></listitem>
210 <term><varname>SD_BUS_ERROR_UNKNOWN_OBJECT
</varname></term>
211 <listitem><para>The requested object does not exist in the selected service.
</para></listitem>
214 <term><varname>SD_BUS_ERROR_UNKNOWN_INTERFACE
</varname></term>
215 <listitem><para>The requested interface does not exist on the selected object.
</para></listitem>
218 <term><varname>SD_BUS_ERROR_UNKNOWN_PROPERTY
</varname></term>
219 <listitem><para>The requested property does not exist in the selected interface.
</para></listitem>
222 <term><varname>SD_BUS_ERROR_PROPERTY_READ_ONLY
</varname></term>
223 <listitem><para>A write operation was requested on a read-only property.
</para></listitem>
226 <term><varname>SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN
</varname></term>
227 <listitem><para>The requested PID is not known.
</para></listitem>
230 <term><varname>SD_BUS_ERROR_INVALID_SIGNATURE
</varname></term>
231 <listitem><para>The specified message signature is not
236 <term><varname>SD_BUS_ERROR_INCONSISTENT_MESSAGE
</varname></term>
237 <listitem><para>The passed message does not validate
238 correctly.
</para></listitem>
241 <term><varname>SD_BUS_ERROR_MATCH_RULE_NOT_FOUND
</varname></term>
242 <listitem><para>The specified match rule does not exist.
</para></listitem>
245 <term><varname>SD_BUS_ERROR_MATCH_RULE_INVALID
</varname></term>
246 <listitem><para>The specified match rule is invalid.
</para></listitem>
249 <term><varname>SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED
</varname></term>
250 <listitem><para>Access to the requested operation is not
251 permitted. However, it might be available after interactive
252 authentication. This is usually returned by method calls
253 supporting a framework for additional interactive
254 authorization, when interactive authorization was not enabled
256 <citerefentry><refentrytitle>sd_bus_message_set_allow_interactive_authorization
</refentrytitle><manvolnum>3</manvolnum></citerefentry>
257 for the method call message.
</para></listitem>
265 <para>The various error definitions described here are available
266 as a shared library, which can be compiled and linked to with the
267 <constant>libsystemd
</constant> <citerefentry
268 project='die-net'
><refentrytitle>pkg-config
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
273 <title>See Also
</title>
276 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
277 <citerefentry><refentrytitle>sd-bus
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
278 <citerefentry><refentrytitle>sd_bus_error
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
279 <citerefentry><refentrytitle>sd_bus_message_set_allow_interactive_authorization
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
280 <citerefentry project='man-pages'
><refentrytitle>errno
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
281 <citerefentry project='die-net'
><refentrytitle>strerror
</refentrytitle><manvolnum>3</manvolnum></citerefentry>