[thirdparty/systemd.git] / man / sd-bus-errors.xml

<?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">

<!--
  SPDX-License-Identifier: LGPL-2.1+

  This file is part of systemd.

  Copyright 2015 Lennart Poettering
-->

<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 &lt;systemd/sd-bus.h&gt;</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
    knows a number of generic, standardized error names that are
    listed below.</para>

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