2020-04-20 20:55:22 +03:00
<?xml version='1.0'?>
< !DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
2023-12-25 17:48:33 +03:00
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
2020-11-09 07:23:58 +03:00
<!-- SPDX - License - Identifier: LGPL - 2.1 - or - later -->
2020-04-20 20:55:22 +03:00
<refentry id= "sd_bus_set_exit_on_disconnect"
xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo >
<title > sd_bus_set_exit_on_disconnect</title>
<productname > systemd</productname>
</refentryinfo>
<refmeta >
<refentrytitle > sd_bus_set_exit_on_disconnect</refentrytitle>
<manvolnum > 3</manvolnum>
</refmeta>
<refnamediv >
<refname > sd_bus_set_exit_on_disconnect</refname>
<refname > sd_bus_get_exit_on_disconnect</refname>
<refpurpose > Control the exit behavior when the bus object disconnects</refpurpose>
</refnamediv>
<refsynopsisdiv >
<funcsynopsis >
<funcsynopsisinfo > #include < systemd/sd-bus.h> </funcsynopsisinfo>
<funcprototype >
<funcdef > int <function > sd_bus_set_exit_on_disconnect</function> </funcdef>
<paramdef > sd_bus *<parameter > bus</parameter> </paramdef>
<paramdef > int <parameter > b</parameter> </paramdef>
</funcprototype>
<funcprototype >
<funcdef > int <function > sd_bus_get_exit_on_disconnect</function> </funcdef>
<paramdef > sd_bus *<parameter > bus</parameter> </paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 >
<title > Description</title>
<para > <function > sd_bus_set_exit_on_disconnect()</function> may be used to configure the exit
behavior when the given bus object disconnects. If <parameter > b</parameter> is zero, no special
logic is executed when the bus object disconnects. If <parameter > b</parameter> is non-zero, the
behavior on disconnect depends on whether the bus object is attached to an event loop or not. If
the bus object is attached to an event loop (see
<citerefentry > <refentrytitle > sd_bus_attach_event</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> ),
the event loop is closed when the bus object disconnects (as if calling
<citerefentry > <refentrytitle > sd_event_exit</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> ).
Otherwise,
<citerefentry project= 'man-pages' > <refentrytitle > exit</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry>
is called. The exit code passed to <function > sd_event_exit()</function> and
<function > exit()</function> is <constant > EXIT_FAILURE</constant> . If the bus object has already
disconnected when enabling the exit behavior, the exit behavior is executed immediately. By
default, the exit behavior is disabled.</para>
<para > <function > sd_bus_get_exit_on_disconnect()</function> returns whether the exit on
disconnect behavior is enabled for the given bus object.</para>
</refsect1>
<refsect1 >
<title > Return Value</title>
2020-04-20 20:57:25 +03:00
<para > On success, <function > sd_bus_set_exit_on_disconnect()</function> returns a non-negative
2020-04-20 20:55:22 +03:00
integer. On failure, it returns a negative errno-style error code.</para>
2020-04-20 20:57:25 +03:00
<para > <function > sd_bus_get_exit_on_disconnect()</function> returns a positive integer if the
exit on disconnect behavior is enabled. Otherwise, it returns zero.</para>
2020-04-20 20:55:22 +03:00
<refsect2 >
<title > Errors</title>
<para > Returned errors may indicate the following problems:</para>
<variablelist >
2020-04-20 20:57:25 +03:00
<varlistentry >
<term > <constant > -EINVAL</constant> </term>
2023-08-22 19:52:36 +03:00
<listitem > <para > A required parameter was <constant > NULL</constant> .</para>
<xi:include href= "version-info.xml" xpointer= "v246" /> </listitem>
2020-04-20 20:57:25 +03:00
</varlistentry>
<varlistentry >
<term > <constant > -ENOPKG</constant> </term>
2023-08-22 19:52:36 +03:00
<listitem > <para > The bus object could not be resolved.</para>
<xi:include href= "version-info.xml" xpointer= "v246" /> </listitem>
2020-04-20 20:57:25 +03:00
</varlistentry>
2020-04-20 20:55:22 +03:00
<varlistentry >
<term > <constant > -ECHILD</constant> </term>
2023-08-22 19:52:36 +03:00
<listitem > <para > The bus connection was created in a different process, library or module instance.</para>
<xi:include href= "version-info.xml" xpointer= "v246" /> </listitem>
2020-04-20 20:55:22 +03:00
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href= "libsystemd-pkgconfig.xml" />
2023-09-04 15:46:35 +03:00
<refsect1 >
<title > History</title>
2023-09-18 19:44:26 +03:00
<para > <function > sd_bus_set_exit_on_disconnect()</function> and
<function > sd_bus_get_exit_on_disconnect()</function> were added in version 246.</para>
2023-09-04 15:46:35 +03:00
</refsect1>
2020-04-20 20:55:22 +03:00
<refsect1 >
<title > See Also</title>
2023-12-22 21:09:32 +03:00
<para > <simplelist type= "inline" >
<member > <citerefentry > <refentrytitle > systemd</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </member>
<member > <citerefentry > <refentrytitle > sd-bus</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> </member>
<member > <citerefentry > <refentrytitle > sd_bus_attach_event</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> </member>
<member > <citerefentry > <refentrytitle > sd-event</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> </member>
<member > <citerefentry > <refentrytitle > sd_event_exit</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> </member>
</simplelist> </para>
2020-04-20 20:55:22 +03:00
</refsect1>
</refentry>