man-pages/man3/sd_event_source_set_destroy_callback.3.html
2021-03-31 01:06:50 +01:00

154 lines
4.2 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of SD_EVENT_SOURCE_SET_DESTROY_CALLBACK</TITLE>
</HEAD><BODY>
<H1>SD_EVENT_SOURCE_SET_DESTROY_CALLBACK</H1>
Section: sd_event_source_set_destroy_callback (3)<BR>Updated: <BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
sd_event_source_set_destroy_callback, sd_event_source_get_destroy_callback, sd_event_destroy_t - Define the callback function for resource cleanup.
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<P>
<B>
</B><PRE>
#include &lt;<A HREF="file:///usr/include/systemd/sd-event.h">systemd/sd-event.h</A>&gt;
</PRE>
<DL COMPACT>
<DT id="1">
<B>typedef int (*sd_event_destroy_t)(void&nbsp;*</B><I>userdata</I><B>);</B>
<DT id="2">
<B>int sd_event_source_set_destroy_callback(sd_event_source&nbsp;*</B><I>source</I><B>, sd_event_destroy_t&nbsp;</B><I>callback</I><B>);</B>
<DT id="3">
<B>int sd_event_source_get_destroy_callback(sd_event_source&nbsp;*</B><I>source</I><B>, sd_event_destroy_t&nbsp;*</B><I>callback</I><B>);</B>
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
<B>sd_event_source_set_destroy_callback()</B>
<DD>sets
<I>callback</I>
as the callback function to be called right before the event source object
<I>source</I>
is deallocated. The
<I>userdata</I>
pointer from the event source object will be passed as the
<I>userdata</I>
parameter. This pointer can be set by an argument to the constructor functions, see
<B><A HREF="/cgi-bin/man/man2html?3+sd_event_add_io">sd_event_add_io</A></B>(3), or directly, see
<B><A HREF="/cgi-bin/man/man2html?3+sd_event_source_set_userdata">sd_event_source_set_userdata</A></B>(3). This callback function is called even if
<I>userdata</I>
is
<B>NULL</B>. Note that this callback is invoked at a time where the event source object itself is already invalidated, and executing operations or taking new references to the event source object is not permissible.
<P>
<B>sd_event_source_get_destroy_callback()</B>
returns the current callback for
<I>source</I>
in the
<I>callback</I>
parameter.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
<P>
On success,
<B>sd_event_source_set_destroy_callback()</B>
returns 0 or a positive integer. On failure, it returns a negative errno-style error code.
<P>
<B>sd_event_source_get_destroy_callback()</B>
returns positive if the destroy callback function is set, 0 if not. On failure, returns a negative errno-style error code.
<A NAME="lbAF">&nbsp;</A>
<H3>Errors</H3>
<P>
Returned errors may indicate the following problems:
<P>
<B>-EINVAL</B>
<DL COMPACT><DT id="4"><DD>
The
<I>source</I>
parameter is
<B>NULL</B>.
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>NOTES</H2>
<P>
These APIs are implemented as a shared library, which can be compiled and linked to with the
<B>libsystemd</B>&nbsp;<B><A HREF="/cgi-bin/man/man2html?1+pkg-config">pkg-config</A></B>(1)
file.
<A NAME="lbAH">&nbsp;</A>
<H2>SEE ALSO</H2>
<P>
<B><A HREF="/cgi-bin/man/man2html?1+systemd">systemd</A></B>(1),
<B><A HREF="/cgi-bin/man/man2html?3+sd-event">sd-event</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+sd_event_add_io">sd_event_add_io</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+sd_event_add_time">sd_event_add_time</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+sd_event_add_signal">sd_event_add_signal</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+sd_event_add_child">sd_event_add_child</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+sd_event_add_inotify">sd_event_add_inotify</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+sd_event_add_defer">sd_event_add_defer</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+sd_event_source_set_userdata">sd_event_source_set_userdata</A></B>(3)
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="5"><A HREF="#lbAB">NAME</A><DD>
<DT id="6"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="7"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="8"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DL>
<DT id="9"><A HREF="#lbAF">Errors</A><DD>
</DL>
<DT id="10"><A HREF="#lbAG">NOTES</A><DD>
<DT id="11"><A HREF="#lbAH">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:55 GMT, March 31, 2021
</BODY>
</HTML>