2015-06-23 20:37:28 +03:00
<?xml version='1.0'?> <!-- * - Mode: nxml; nxml - child - indent: 2; indent - tabs - mode: nil - * -->
< !DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
2017-11-18 19:22:32 +03:00
SPDX-License-Identifier: LGPL-2.1+
2015-06-23 20:37:28 +03:00
This file is part of systemd.
Copyright 2015 Lennart Poettering
systemd is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http: / / w w w . g n u . o r g / l i c e n s e s /> .
-->
<refentry id= "sd-bus-errors" >
<refentryinfo >
<title > sd-bus-errors</title>
<productname > systemd</productname>
<authorgroup >
<author >
<contrib > Developer</contrib>
<firstname > Lennart</firstname>
<surname > Poettering</surname>
<email > lennart@poettering.net</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta >
<refentrytitle > sd-bus-errors</refentrytitle>
<manvolnum > 3</manvolnum>
</refmeta>
<refnamediv >
<refname > sd-bus-errors</refname>
<refname > SD_BUS_ERROR_FAILED</refname>
<refname > SD_BUS_ERROR_NO_MEMORY</refname>
<refname > SD_BUS_ERROR_SERVICE_UNKNOWN</refname>
<refname > SD_BUS_ERROR_NAME_HAS_NO_OWNER</refname>
<refname > SD_BUS_ERROR_NO_REPLY</refname>
<refname > SD_BUS_ERROR_IO_ERROR</refname>
<refname > SD_BUS_ERROR_BAD_ADDRESS</refname>
<refname > SD_BUS_ERROR_NOT_SUPPORTED</refname>
<refname > SD_BUS_ERROR_LIMITS_EXCEEDED</refname>
<refname > SD_BUS_ERROR_ACCESS_DENIED</refname>
<refname > SD_BUS_ERROR_AUTH_FAILED</refname>
<refname > SD_BUS_ERROR_NO_SERVER</refname>
<refname > SD_BUS_ERROR_TIMEOUT</refname>
<refname > SD_BUS_ERROR_NO_NETWORK</refname>
<refname > SD_BUS_ERROR_ADDRESS_IN_USE</refname>
<refname > SD_BUS_ERROR_DISCONNECTED</refname>
<refname > SD_BUS_ERROR_INVALID_ARGS</refname>
<refname > SD_BUS_ERROR_FILE_NOT_FOUND</refname>
<refname > SD_BUS_ERROR_FILE_EXISTS</refname>
<refname > SD_BUS_ERROR_UNKNOWN_METHOD</refname>
<refname > SD_BUS_ERROR_UNKNOWN_OBJECT</refname>
<refname > SD_BUS_ERROR_UNKNOWN_INTERFACE</refname>
<refname > SD_BUS_ERROR_UNKNOWN_PROPERTY</refname>
<refname > SD_BUS_ERROR_PROPERTY_READ_ONLY</refname>
<refname > SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN</refname>
<refname > SD_BUS_ERROR_INVALID_SIGNATURE</refname>
<refname > SD_BUS_ERROR_INCONSISTENT_MESSAGE</refname>
<refname > SD_BUS_ERROR_MATCH_RULE_NOT_FOUND</refname>
<refname > SD_BUS_ERROR_MATCH_RULE_INVALID</refname>
<refname > SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED</refname>
<refpurpose > Standard D-Bus error names</refpurpose>
</refnamediv>
<refsynopsisdiv >
<funcsynopsis >
<funcsynopsisinfo > #include < systemd/sd-bus.h> </funcsynopsisinfo>
<funcsynopsisinfo > #define SD_BUS_ERROR_FAILED "org.freedesktop.DBus.Error.Failed"
#define SD_BUS_ERROR_NO_MEMORY "org.freedesktop.DBus.Error.NoMemory"
#define SD_BUS_ERROR_SERVICE_UNKNOWN "org.freedesktop.DBus.Error.ServiceUnknown"
#define SD_BUS_ERROR_NAME_HAS_NO_OWNER "org.freedesktop.DBus.Error.NameHasNoOwner"
#define SD_BUS_ERROR_NO_REPLY "org.freedesktop.DBus.Error.NoReply"
#define SD_BUS_ERROR_IO_ERROR "org.freedesktop.DBus.Error.IOError"
#define SD_BUS_ERROR_BAD_ADDRESS "org.freedesktop.DBus.Error.BadAddress"
#define SD_BUS_ERROR_NOT_SUPPORTED "org.freedesktop.DBus.Error.NotSupported"
#define SD_BUS_ERROR_LIMITS_EXCEEDED "org.freedesktop.DBus.Error.LimitsExceeded"
#define SD_BUS_ERROR_ACCESS_DENIED "org.freedesktop.DBus.Error.AccessDenied"
#define SD_BUS_ERROR_AUTH_FAILED "org.freedesktop.DBus.Error.AuthFailed"
#define SD_BUS_ERROR_NO_SERVER "org.freedesktop.DBus.Error.NoServer"
#define SD_BUS_ERROR_TIMEOUT "org.freedesktop.DBus.Error.Timeout"
#define SD_BUS_ERROR_NO_NETWORK "org.freedesktop.DBus.Error.NoNetwork"
#define SD_BUS_ERROR_ADDRESS_IN_USE "org.freedesktop.DBus.Error.AddressInUse"
#define SD_BUS_ERROR_DISCONNECTED "org.freedesktop.DBus.Error.Disconnected"
#define SD_BUS_ERROR_INVALID_ARGS "org.freedesktop.DBus.Error.InvalidArgs"
#define SD_BUS_ERROR_FILE_NOT_FOUND "org.freedesktop.DBus.Error.FileNotFound"
#define SD_BUS_ERROR_FILE_EXISTS "org.freedesktop.DBus.Error.FileExists"
#define SD_BUS_ERROR_UNKNOWN_METHOD "org.freedesktop.DBus.Error.UnknownMethod"
#define SD_BUS_ERROR_UNKNOWN_OBJECT "org.freedesktop.DBus.Error.UnknownObject"
#define SD_BUS_ERROR_UNKNOWN_INTERFACE "org.freedesktop.DBus.Error.UnknownInterface"
#define SD_BUS_ERROR_UNKNOWN_PROPERTY "org.freedesktop.DBus.Error.UnknownProperty"
#define SD_BUS_ERROR_PROPERTY_READ_ONLY "org.freedesktop.DBus.Error.PropertyReadOnly"
#define SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN "org.freedesktop.DBus.Error.UnixProcessIdUnknown"
#define SD_BUS_ERROR_INVALID_SIGNATURE "org.freedesktop.DBus.Error.InvalidSignature"
#define SD_BUS_ERROR_INCONSISTENT_MESSAGE "org.freedesktop.DBus.Error.InconsistentMessage"
#define SD_BUS_ERROR_MATCH_RULE_NOT_FOUND "org.freedesktop.DBus.Error.MatchRuleNotFound"
#define SD_BUS_ERROR_MATCH_RULE_INVALID "org.freedesktop.DBus.Error.MatchRuleInvalid"
#define SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED \
"org.freedesktop.DBus.Error.InteractiveAuthorizationRequired"</funcsynopsisinfo>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 >
<title > Description</title>
<para > In addition to the error names user programs define, D-Bus
2014-08-03 09:11:12 +04:00
knows a number of generic, standardized error names that are
2015-06-23 20:37:28 +03:00
listed below.</para>
2014-08-03 09:11:12 +04:00
<para > In addition to this list, in sd-bus, the special error
2015-06-23 20:37:28 +03:00
namespace <literal > System.Error.</literal> is used to map
arbitrary Linux system errors (as defined by <citerefentry
project='man-pages'><refentrytitle > errno</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> )
to D-Bus errors and back. For example, the error
<constant > EUCLEAN</constant> is mapped to
<literal > System.Error.EUCLEAN</literal> and back.</para>
<variablelist >
<varlistentry >
<term > <varname > SD_BUS_ERROR_FAILED</varname> </term>
<listitem > <para > A generic error indication. See the error
message for further details. This error name should be
2015-07-26 00:15:05 +03:00
avoided, in favor of a more expressive error
2015-06-23 20:37:28 +03:00
name.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_NO_MEMORY</varname> </term>
<listitem > <para > A memory allocation failed, and the requested
operation could not be completed.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_SERVICE_UNKNOWN</varname> </term>
<listitem > <para > The contacted bus service is unknown and
cannot be activated.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_NAME_HAS_NO_OWNER</varname> </term>
<listitem > <para > The specified bus service name currently has
no owner.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_NO_REPLY</varname> </term>
<listitem > <para > A message did not receive a reply. This error
is usually generated after a timeout.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_IO_ERROR</varname> </term>
<listitem > <para > Generic input/output error, for example when
2014-08-03 09:11:12 +04:00
accessing a socket or other I/O context.</para> </listitem>
2015-06-23 20:37:28 +03:00
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_BAD_ADDRESS</varname> </term>
<listitem > <para > The specified D-Bus bus address string is
malformed.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_NOT_SUPPORTED</varname> </term>
<listitem > <para > The requested operation is not supported on
the local system.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_LIMITS_EXCEEDED</varname> </term>
<listitem > <para > Some limited resource has been
exhausted.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_ACCESS_DENIED</varname> </term>
2014-08-03 09:11:12 +04:00
<listitem > <para > Access to a resource has been denied due to security restrictions.</para> </listitem>
2015-06-23 20:37:28 +03:00
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_AUTH_FAILED</varname> </term>
<listitem > <para > Authentication did not complete successfully.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_NO_SERVER</varname> </term>
<listitem > <para > Unable to connect to the specified server.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_TIMEOUT</varname> </term>
<listitem > <para > An operation timed out. Note that method calls
which timeout generate a
<varname > SD_BUS_ERROR_NO_REPLY</varname> .</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_NO_NETWORK</varname> </term>
<listitem > <para > No network available to execute requested network operation on.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_ADDRESS_IN_USE</varname> </term>
<listitem > <para > The specified network address is already being listened on.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_DISCONNECTED</varname> </term>
<listitem > <para > The connection has been terminated.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_INVALID_ARGS</varname> </term>
<listitem > <para > One or more invalid arguments have been passed.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_FILE_NOT_FOUND</varname> </term>
<listitem > <para > The requested file could not be found.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_FILE_EXISTS</varname> </term>
2014-08-03 09:11:37 +04:00
<listitem > <para > The requested file already exists.</para> </listitem>
2015-06-23 20:37:28 +03:00
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_UNKNOWN_METHOD</varname> </term>
<listitem > <para > The requested method does not exist in the selected interface.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_UNKNOWN_OBJECT</varname> </term>
<listitem > <para > The requested object does not exist in the selected service.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_UNKNOWN_INTERFACE</varname> </term>
<listitem > <para > The requested interface does not exist on the selected object.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_UNKNOWN_PROPERTY</varname> </term>
<listitem > <para > The requested property does not exist in the selected interface.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_PROPERTY_READ_ONLY</varname> </term>
<listitem > <para > A write operation was requested on a read-only property.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN</varname> </term>
<listitem > <para > The requested PID is not known.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_INVALID_SIGNATURE</varname> </term>
<listitem > <para > The specified message signature is not
valid.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_INCONSISTENT_MESSAGE</varname> </term>
<listitem > <para > The passed message does not validate
correctly.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_MATCH_RULE_NOT_FOUND</varname> </term>
<listitem > <para > The specified match rule does not exist.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_MATCH_RULE_INVALID</varname> </term>
<listitem > <para > The specified match rule is invalid.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED</varname> </term>
<listitem > <para > Access to the requested operation is not
2014-08-03 09:11:12 +04:00
permitted. However, it might be available after interactive
2015-06-23 20:37:28 +03:00
authentication. This is usually returned by method calls
supporting a framework for additional interactive
authorization, when interactive authorization was not enabled
with the
<citerefentry > <refentrytitle > sd_bus_message_set_allow_interactive_authorization</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry>
for the method call message.</para> </listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 >
<title > Notes</title>
<para > The various error definitions described here are available
as a shared library, which can be compiled and linked to with the
<constant > libsystemd</constant> <citerefentry
project='die-net'><refentrytitle > pkg-config</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry>
file.</para>
</refsect1>
<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_error</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > sd_bus_message_set_allow_interactive_authorization</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> ,
<citerefentry project= 'man-pages' > <refentrytitle > errno</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> ,
<citerefentry project= 'die-net' > <refentrytitle > strerror</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry>
</para>
</refsect1>
</refentry>
