2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
7 <refentry id=
"sd_bus_slot_set_destroy_callback"
8 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
11 <title>sd_bus_slot_set_destroy_callback
</title>
12 <productname>systemd
</productname>
16 <refentrytitle>sd_bus_slot_set_destroy_callback
</refentrytitle>
17 <manvolnum>3</manvolnum>
21 <refname>sd_bus_slot_set_destroy_callback
</refname>
22 <refname>sd_bus_slot_get_destroy_callback
</refname>
23 <refname>sd_bus_track_set_destroy_callback
</refname>
24 <refname>sd_bus_track_get_destroy_callback
</refname>
25 <refname>sd_bus_destroy_t
</refname>
27 <refpurpose>Define the callback function for resource cleanup.
</refpurpose>
32 <funcsynopsisinfo>#include
<systemd/sd-bus.h
></funcsynopsisinfo>
35 <funcdef>typedef int (*
<function>sd_bus_destroy_t
</function>)
</funcdef>
36 <paramdef>void *
<parameter>userdata
</parameter></paramdef>
40 <funcdef>int
<function>sd_bus_slot_set_destroy_callback
</function></funcdef>
41 <paramdef>sd_bus_slot *
<parameter>slot
</parameter></paramdef>
42 <paramdef>sd_bus_destroy_t
<parameter>callback
</parameter></paramdef>
46 <funcdef>int
<function>sd_bus_slot_get_destroy_callback
</function></funcdef>
47 <paramdef>sd_bus_slot *
<parameter>slot
</parameter></paramdef>
48 <paramdef>sd_bus_destroy_t *
<parameter>callback
</parameter></paramdef>
52 <funcdef>int
<function>sd_bus_track_set_destroy_callback
</function></funcdef>
53 <paramdef>sd_bus_track *
<parameter>track
</parameter></paramdef>
54 <paramdef>sd_bus_destroy_t
<parameter>callback
</parameter></paramdef>
58 <funcdef>int
<function>sd_bus_track_get_destroy_callback
</function></funcdef>
59 <paramdef>sd_bus_track *
<parameter>track
</parameter></paramdef>
60 <paramdef>sd_bus_destroy_t *
<parameter>callback
</parameter></paramdef>
66 <title>Description
</title>
68 <para><function>sd_bus_slot_set_destroy_callback()
</function> sets
<parameter>callback
</parameter> as the callback
69 function to be called right before the bus slot object
<parameter>slot
</parameter> is deallocated. The
70 <parameter>userdata
</parameter> pointer from the slot object will be passed as the
<parameter>userdata
</parameter>
71 parameter. This pointer can be set by an argument to the constructor functions, see
72 <citerefentry><refentrytitle>sd_bus_add_match
</refentrytitle><manvolnum>3</manvolnum></citerefentry>, or directly,
73 see
<citerefentry><refentrytitle>sd_bus_slot_set_userdata
</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
74 This callback function is called even if
<parameter>userdata
</parameter> is
<constant>NULL
</constant>. Note that
75 this callback is invoked at a time where the bus slot object itself is already invalidated, and executing
76 operations or taking new references to the bus slot object is not permissible.
</para>
78 <para><function>sd_bus_slot_get_destroy_callback()
</function> returns the current callback
79 for
<parameter>slot
</parameter> in the
<parameter>callback
</parameter> parameter.
</para>
81 <para><function>sd_bus_track_set_destroy_callback()
</function> and
82 <function>sd_bus_track_get_destroy_callback()
</function> provide equivalent functionality for the
83 <parameter>userdata
</parameter> pointer associated with bus peer tracking objects. For details about bus peer
85 <citerefentry><refentrytitle>sd_bus_track_new
</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
</para>
89 <title>Return Value
</title>
91 <para>On success,
<function>sd_bus_slot_set_destroy_callback()
</function> and
92 <function>sd_bus_track_set_destroy_callback()
</function> return
0 or a positive integer. On failure, they return a
93 negative errno-style error code.
</para>
95 <para><function>sd_bus_slot_get_destroy_callback()
</function> and
96 <function>sd_bus_track_get_destroy_callback()
</function> return positive if the destroy callback function is set,
0
97 if not. On failure, they return a negative errno-style error code.
</para>
101 <title>Errors
</title>
103 <para>Returned errors may indicate the following problems:
</para>
107 <term><constant>-EINVAL
</constant></term>
109 <listitem><para>The
<parameter>slot
</parameter> or
<parameter>track
</parameter> parameter is
110 <constant>NULL
</constant>.
</para></listitem>
115 <xi:include href=
"libsystemd-pkgconfig.xml" />
118 <title>See Also
</title>
121 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
122 <citerefentry><refentrytitle>sd-bus
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
123 <citerefentry><refentrytitle>sd_bus_slot_set_floating
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
124 <citerefentry><refentrytitle>sd_bus_add_match
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
125 <citerefentry><refentrytitle>sd_bus_track_new
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
126 <citerefentry><refentrytitle>sd_bus_slot_set_userdata
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
127 <citerefentry><refentrytitle>sd_bus_track_set_userdata
</refentrytitle><manvolnum>3</manvolnum></citerefentry>