sd_event_source_get_event.xml revision dc83f27a7cf03757dec11a69ec18504ad4ea8f89
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim This file is part of systemd.
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim Copyright 2015 Lennart Poettering
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim systemd is free software; you can redistribute it and/or modify it
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim under the terms of the GNU Lesser General Public License as published by
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim the Free Software Foundation; either version 2.1 of the License, or
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim (at your option) any later version.
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim systemd is distributed in the hope that it will be useful, but
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim WITHOUT ANY WARRANTY; without even the implied warranty of
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim Lesser General Public License for more details.
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim You should have received a copy of the GNU Lesser General Public License
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim along with systemd; If not, see <http://www.gnu.org/licenses/>.
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim<refentry id="sd_event_source_get_event" xmlns:xi="http://www.w3.org/2001/XInclude">
742318b93e89c311f66b55f426c4d9cf2c14628bjim <refentryinfo>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim <authorgroup>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim </authorgroup>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim </refentryinfo>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim <refentrytitle>sd_event_source_get_event</refentrytitle>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim </refmeta>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim <refnamediv>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim <refpurpose>Retrieve the event loop of an event source</refpurpose>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim </refnamediv>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim <refsynopsisdiv>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim <funcsynopsis>
742318b93e89c311f66b55f426c4d9cf2c14628bjim <funcsynopsisinfo>#include <systemd/sd-event.h></funcsynopsisinfo>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim <funcprototype>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim <funcdef>sd_event* <function>sd_event_source_get_event</function></funcdef>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim <paramdef>sd_event_source *<parameter>source</parameter></paramdef>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim </funcprototype>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim </funcsynopsis>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim </refsynopsisdiv>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim <refsect1>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim <para><function>sd_event_source_get_event()</function> may be used
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim to retrieve the event loop object the event source object specified
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim as <parameter>source</parameter> is associated with. The event
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim loop object is specified when creating an event source object with
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim calls such as
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim </refsect1>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim <refsect1>
11e076839c8d5a82d55e710194d0daac51390dbdsf <para>On success, <function>sd_event_source_get_event()</function>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim returns the associated event loop object. On failure, it returns
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim NULL.</para>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim </refsect1>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim <refsect1>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
11e076839c8d5a82d55e710194d0daac51390dbdsf <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim <citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim </refsect1>
fe73c50ff5c623f4a321a172f30a9df26cb5bb92jim</refentry>