]>
Commit | Line | Data |
---|---|---|
514094f9 | 1 | <?xml version='1.0'?> |
3a54a157 | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
eea10b26 | 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> |
db9ecf05 | 4 | <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> |
dc83f27a LP |
5 | |
6 | <refentry id="sd_event_source_get_event" xmlns:xi="http://www.w3.org/2001/XInclude"> | |
7 | ||
8 | <refentryinfo> | |
9 | <title>sd_event_source_get_event</title> | |
10 | <productname>systemd</productname> | |
dc83f27a LP |
11 | </refentryinfo> |
12 | ||
13 | <refmeta> | |
14 | <refentrytitle>sd_event_source_get_event</refentrytitle> | |
15 | <manvolnum>3</manvolnum> | |
16 | </refmeta> | |
17 | ||
18 | <refnamediv> | |
19 | <refname>sd_event_source_get_event</refname> | |
20 | ||
21 | <refpurpose>Retrieve the event loop of an event source</refpurpose> | |
22 | </refnamediv> | |
23 | ||
24 | <refsynopsisdiv> | |
25 | <funcsynopsis> | |
26 | <funcsynopsisinfo>#include <systemd/sd-event.h></funcsynopsisinfo> | |
27 | ||
28 | <funcprototype> | |
29 | <funcdef>sd_event* <function>sd_event_source_get_event</function></funcdef> | |
30 | <paramdef>sd_event_source *<parameter>source</parameter></paramdef> | |
31 | </funcprototype> | |
32 | ||
33 | </funcsynopsis> | |
34 | </refsynopsisdiv> | |
35 | ||
36 | <refsect1> | |
37 | <title>Description</title> | |
38 | ||
39 | <para><function>sd_event_source_get_event()</function> may be used | |
40 | to retrieve the event loop object the event source object specified | |
41 | as <parameter>source</parameter> is associated with. The event | |
42 | loop object is specified when creating an event source object with | |
43 | calls such as | |
44 | <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry> | |
45 | or | |
46 | <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para> | |
47 | </refsect1> | |
48 | ||
49 | <refsect1> | |
50 | <title>Return Value</title> | |
51 | ||
52 | <para>On success, <function>sd_event_source_get_event()</function> | |
53 | returns the associated event loop object. On failure, it returns | |
6b44ad0b | 54 | <constant>NULL</constant>.</para> |
dc83f27a LP |
55 | </refsect1> |
56 | ||
57 | <xi:include href="libsystemd-pkgconfig.xml" /> | |
58 | ||
69106f47 AK |
59 | <refsect1> |
60 | <title>History</title> | |
61 | <para><function>sd_event_source_get_event()</function> was added in version 229.</para> | |
62 | </refsect1> | |
63 | ||
dc83f27a LP |
64 | <refsect1> |
65 | <title>See Also</title> | |
66 | ||
13a69c12 DT |
67 | <para><simplelist type="inline"> |
68 | <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
69 | <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
70 | <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
71 | <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
72 | <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
73 | <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
74 | <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
75 | <member><citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
76 | </simplelist></para> | |
dc83f27a LP |
77 | </refsect1> |
78 | ||
79 | </refentry> |