-<?xml version='1.0'?> <!--*-nxml-*-->
+<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
-This file is part of systemd.
+ This file is part of systemd.
-Copyright 2014 Lennart Poettering
+ Copyright 2014 Lennart Poettering
-systemd is free software; you can redistribute it and/or modify it
-under the terms of the GNU Lesser General Public License as published by
-the Free Software Foundation; either version 2.1 of the License, or
-(at your option) any later version.
+ systemd is free software; you can redistribute it and/or modify it
+ under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation; either version 2.1 of the License, or
+ (at your option) any later version.
-systemd is distributed in the hope that it will be useful, but
-WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-Lesser General Public License for more details.
+ systemd is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Lesser General Public License for more details.
-You should have received a copy of the GNU Lesser General Public License
-along with systemd; If not, see <http://www.gnu.org/licenses/>.
+ You should have received a copy of the GNU Lesser General Public License
+ along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->
<refentry id="sd_event_new" conditional="ENABLE_KDBUS">
<parameter>event</parameter> parameter. After use, drop
the returned reference with
<function>sd_event_unref()</function>. When the last reference is
- dropped, the event loop is freed.</para>
+ dropped, the object is freed.</para>
<para><function>sd_event_default()</function> acquires a reference
to the default event loop object of the calling thread, possibly
recommended to use this call instead of
<function>sd_event_new()</function> in order to share event loop
objects between various components that are dispatched in the same
- thread. All threads either have exactly zero or one default event loop
- associated, but never more.</para>
+ thread. All threads have exactly either zero or one default event loop
+ objects associated, but never more.</para>
<para><function>sd_event_ref()</function> increases the reference
- counter of the specified event loop object by one.</para>
+ count of the specified event loop object by one.</para>
<para><function>sd_event_unref()</function> decreases the
- reference counter of the specified event loop object by one. If
- the counter hits zero, the event loop object is freed. Note that it
+ reference count of the specified event loop object by one. If
+ the count hits zero, the object is freed. Note that it
is freed regardless of whether it is the default event loop object for a
thread or not. This means that allocating an event loop with
<function>sd_event_default()</function>, then releasing it, and
then acquiring a new one with
<function>sd_event_default()</function> will result in two
- distinct objects. Note that, in order to free an event loop object,
+ distinct objects. Note that in order to free an event loop object,
all remaining event sources of the event loop also need to be
- freed as they each keep a reference to it.</para>
+ freed as each keeps a reference to it.</para>
</refsect1>
<refsect1>
code. <function>sd_event_ref()</function> always returns a pointer
to the event loop object passed
in. <function>sd_event_unref()</function> always returns
- NULL.</para>
+ <constant>NULL</constant>.</para>
</refsect1>
<refsect1>
<variablelist>
<varlistentry>
- <term><varname>-ENOMEM</varname></term>
+ <term><constant>-ENOMEM</constant></term>
- <listitem><para>Not enough memory to allocate object</para></listitem>
+ <listitem><para>Not enough memory to allocate the object.</para></listitem>
</varlistentry>
<varlistentry>
- <term><varname>-EMFILE</varname></term>
+ <term><constant>-EMFILE</constant></term>
<listitem><para>The maximum number of event loops has been allocated.</para></listitem>
<para><function>sd_event_new()</function> and the other functions
described here are available as a shared library, which can be
compiled and linked to with the
- <constant>libsystemd</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ <constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
file.</para>
</refsect1>
~ianmdlvl / elogind.git / blobdiff