projects / thirdparty / systemd.git / blame
| Commit | Line | Data |
|---|---|---|
| 9d3e5d11 LP |
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"> | |
| 4 | ||
| 5 | <!-- | |
| 572eb058 | 6 | SPDX-License-Identifier: LGPL-2.1+ |
| 9d3e5d11 LP |
7 | --> |
| 8 | ||
| 9 | <refentry id="sd-bus-errors"> | |
| 10 | ||
| 11 | <refentryinfo> | |
| 12 | <title>sd-bus-errors</title> | |
| 13 | <productname>systemd</productname> | |
| 14 | ||
| 15 | <authorgroup> | |
| 16 | <author> | |
| 17 | <contrib>Developer</contrib> | |
| 18 | <firstname>Lennart</firstname> | |
| 19 | <surname>Poettering</surname> | |
| 20 | <email>lennart@poettering.net</email> | |
| 21 | </author> | |
| 22 | </authorgroup> | |
| 23 | </refentryinfo> | |
| 24 | ||
| 25 | <refmeta> | |
| 26 | <refentrytitle>sd-bus-errors</refentrytitle> | |
| 27 | <manvolnum>3</manvolnum> | |
| 28 | </refmeta> | |
| 29 | ||
| 30 | <refnamediv> | |
| 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> | |
| 62 | ||
| 63 | <refpurpose>Standard D-Bus error names</refpurpose> | |
| 64 | </refnamediv> | |
| 65 | ||
| 66 | <refsynopsisdiv> | |
| 67 | <funcsynopsis> | |
| 68 | <funcsynopsisinfo>#include <systemd/sd-bus.h></funcsynopsisinfo> | |
| 69 | ||
| 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> | |
| 101 | ||
| 102 | </funcsynopsis> | |
| 103 | </refsynopsisdiv> | |
| 104 | ||
| 105 | <refsect1> | |
| 106 | <title>Description</title> | |
| 107 | ||
| 108 | <para>In addition to the error names user programs define, D-Bus | |
| b938cb90 | 109 | knows a number of generic, standardized error names that are |
| 9d3e5d11 LP |
110 | listed below.</para> |
| 111 | ||
| b938cb90 | 112 | <para>In addition to this list, in sd-bus, the special error |
| 9d3e5d11 LP |
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> | |
| 119 | ||
| 120 | <variablelist> | |
| 121 | ||
| 122 | <varlistentry> | |
| 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 | |
| dd2b607b | 126 | avoided, in favor of a more expressive error |
| 9d3e5d11 LP |
127 | name.</para></listitem> |
| 128 | </varlistentry> | |
| 129 | ||
| 130 | <varlistentry> | |
| 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> | |
| 134 | </varlistentry> | |
| 135 | ||
| 136 | <varlistentry> | |
| 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> | |
| 140 | </varlistentry> | |
| 141 | ||
| 142 | <varlistentry> | |
| 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> | |
| 146 | </varlistentry> | |
| 147 | <varlistentry> | |
| 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> | |
| 151 | </varlistentry> | |
| 152 | <varlistentry> | |
| 153 | <term><varname>SD_BUS_ERROR_IO_ERROR</varname></term> | |
| 154 | <listitem><para>Generic input/output error, for example when | |
| b938cb90 | 155 | accessing a socket or other I/O context.</para></listitem> |
| 9d3e5d11 LP |
156 | </varlistentry> |
| 157 | <varlistentry> | |
| 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> | |
| 161 | </varlistentry> | |
| 162 | <varlistentry> | |
| 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> | |
| 166 | </varlistentry> | |
| 167 | <varlistentry> | |
| 168 | <term><varname>SD_BUS_ERROR_LIMITS_EXCEEDED</varname></term> | |
| 169 | <listitem><para>Some limited resource has been | |
| 170 | exhausted.</para></listitem> | |
| 171 | </varlistentry> | |
| 172 | <varlistentry> | |
| 173 | <term><varname>SD_BUS_ERROR_ACCESS_DENIED</varname></term> | |
| b938cb90 | 174 | <listitem><para>Access to a resource has been denied due to security restrictions.</para></listitem> |
| 9d3e5d11 LP |
175 | </varlistentry> |
| 176 | <varlistentry> | |
| 177 | <term><varname>SD_BUS_ERROR_AUTH_FAILED</varname></term> | |
| 178 | <listitem><para>Authentication did not complete successfully.</para></listitem> | |
| 179 | </varlistentry> | |
| 180 | <varlistentry> | |
| 181 | <term><varname>SD_BUS_ERROR_NO_SERVER</varname></term> | |
| 182 | <listitem><para>Unable to connect to the specified server.</para></listitem> | |
| 183 | </varlistentry> | |
| 184 | <varlistentry> | |
| 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> | |
| 189 | </varlistentry> | |
| 190 | <varlistentry> | |
| 191 | <term><varname>SD_BUS_ERROR_NO_NETWORK</varname></term> | |
| 192 | <listitem><para>No network available to execute requested network operation on.</para></listitem> | |
| 193 | </varlistentry> | |
| 194 | <varlistentry> | |
| 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> | |
| 197 | </varlistentry> | |
| 198 | <varlistentry> | |
| 199 | <term><varname>SD_BUS_ERROR_DISCONNECTED</varname></term> | |
| 200 | <listitem><para>The connection has been terminated.</para></listitem> | |
| 201 | </varlistentry> | |
| 202 | <varlistentry> | |
| 203 | <term><varname>SD_BUS_ERROR_INVALID_ARGS</varname></term> | |
| 204 | <listitem><para>One or more invalid arguments have been passed.</para></listitem> | |
| 205 | </varlistentry> | |
| 206 | <varlistentry> | |
| 207 | <term><varname>SD_BUS_ERROR_FILE_NOT_FOUND</varname></term> | |
| 208 | <listitem><para>The requested file could not be found.</para></listitem> | |
| 209 | </varlistentry> | |
| 210 | <varlistentry> | |
| 211 | <term><varname>SD_BUS_ERROR_FILE_EXISTS</varname></term> | |
| a8eaaee7 | 212 | <listitem><para>The requested file already exists.</para></listitem> |
| 9d3e5d11 LP |
213 | </varlistentry> |
| 214 | <varlistentry> | |
| 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> | |
| 217 | </varlistentry> | |
| 218 | <varlistentry> | |
| 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> | |
| 221 | </varlistentry> | |
| 222 | <varlistentry> | |
| 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> | |
| 225 | </varlistentry> | |
| 226 | <varlistentry> | |
| 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> | |
| 229 | </varlistentry> | |
| 230 | <varlistentry> | |
| 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> | |
| 233 | </varlistentry> | |
| 234 | <varlistentry> | |
| 235 | <term><varname>SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN</varname></term> | |
| 236 | <listitem><para>The requested PID is not known.</para></listitem> | |
| 237 | </varlistentry> | |
| 238 | <varlistentry> | |
| 239 | <term><varname>SD_BUS_ERROR_INVALID_SIGNATURE</varname></term> | |
| 240 | <listitem><para>The specified message signature is not | |
| 241 | valid.</para> | |
| 242 | </listitem> | |
| 243 | </varlistentry> | |
| 244 | <varlistentry> | |
| 245 | <term><varname>SD_BUS_ERROR_INCONSISTENT_MESSAGE</varname></term> | |
| 246 | <listitem><para>The passed message does not validate | |
| 247 | correctly.</para></listitem> | |
| 248 | </varlistentry> | |
| 249 | <varlistentry> | |
| 250 | <term><varname>SD_BUS_ERROR_MATCH_RULE_NOT_FOUND</varname></term> | |
| 251 | <listitem><para>The specified match rule does not exist.</para></listitem> | |
| 252 | </varlistentry> | |
| 253 | <varlistentry> | |
| 254 | <term><varname>SD_BUS_ERROR_MATCH_RULE_INVALID</varname></term> | |
| 255 | <listitem><para>The specified match rule is invalid.</para></listitem> | |
| 256 | </varlistentry> | |
| 257 | <varlistentry> | |
| 258 | <term><varname>SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED</varname></term> | |
| 259 | <listitem><para>Access to the requested operation is not | |
| b938cb90 | 260 | permitted. However, it might be available after interactive |
| 9d3e5d11 LP |
261 | authentication. This is usually returned by method calls |
| 262 | supporting a framework for additional interactive | |
| 263 | authorization, when interactive authorization was not enabled | |
| 264 | with the | |
| 265 | <citerefentry><refentrytitle>sd_bus_message_set_allow_interactive_authorization</refentrytitle><manvolnum>3</manvolnum></citerefentry> | |
| 266 | for the method call message.</para></listitem> | |
| 267 | </varlistentry> | |
| 268 | </variablelist> | |
| 269 | </refsect1> | |
| 270 | ||
| 271 | <refsect1> | |
| 272 | <title>Notes</title> | |
| 273 | ||
| 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> | |
| 278 | file.</para> | |
| 279 | </refsect1> | |
| 280 | ||
| 281 | <refsect1> | |
| 282 | <title>See Also</title> | |
| 283 | ||
| 284 | <para> | |
| 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> | |
| 291 | </para> | |
| 292 | </refsect1> | |
| 293 | ||
| 294 | </refentry> |