summaryrefslogtreecommitdiff
path: root/man/sd_event_wait.xml
diff options
context:
space:
mode:
authorSven Eden <yamakuzure@gmx.net>2017-09-22 09:04:02 +0200
committerSven Eden <yamakuzure@gmx.net>2017-09-25 12:58:39 +0200
commiteb0e417895c37dbdb64f18ae95c6b1a7a99f871e (patch)
tree70f4ebe06bd73b714b150b98eea8e4b4ac5bc59e /man/sd_event_wait.xml
parentdf890458e39a14b95f8a2c88e8e1c1815e1320d2 (diff)
Prep 229.9: Make all supportable API functions visible.
The process of cleaning up elogind, meaning to mask all bits that are unneeded by elogind, has been finished a while ago. It is therefore time to re-enable all previously masked API functions that elogind can support. This will make it easier for future developers to integrate elogind into their software where they already support systemd-login.
Diffstat (limited to 'man/sd_event_wait.xml')
-rw-r--r--man/sd_event_wait.xml36
1 files changed, 13 insertions, 23 deletions
diff --git a/man/sd_event_wait.xml b/man/sd_event_wait.xml
index d53090cac..5d675ecea 100644
--- a/man/sd_event_wait.xml
+++ b/man/sd_event_wait.xml
@@ -3,29 +3,29 @@
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
- This file is part of systemd.
+ This file is part of elogind.
Copyright 2015 Zbigniew Jędrzejewski-Szmek
- systemd is free software; you can redistribute it and/or modify it
+ elogind 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
+ elogind 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/>.
+ along with elogind; If not, see <http://www.gnu.org/licenses/>.
-->
<refentry id="sd_event_wait" xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>sd_event_wait</title>
- <productname>systemd</productname>
+ <productname>elogind</productname>
<authorgroup>
<author>
@@ -47,7 +47,6 @@
<refname>sd_event_prepare</refname>
<refname>sd_event_dispatch</refname>
<refname>sd_event_get_state</refname>
- <refname>sd_event_get_iteration</refname>
<refname>SD_EVENT_INITIAL</refname>
<refname>SD_EVENT_PREPARING</refname>
<refname>SD_EVENT_ARMED</refname>
@@ -61,7 +60,7 @@
<refsynopsisdiv>
<funcsynopsis>
- <funcsynopsisinfo>#include &lt;systemd/sd-event.h&gt;</funcsynopsisinfo>
+ <funcsynopsisinfo>#include &lt;elogind/sd-event.h&gt;</funcsynopsisinfo>
<funcsynopsisinfo><token>enum</token> {
<constant>SD_EVENT_INITIAL</constant>,
@@ -94,12 +93,6 @@
<paramdef>sd_event *<parameter>event</parameter></paramdef>
</funcprototype>
- <funcprototype>
- <funcdef>int <function>sd_event_get_iteration</function></funcdef>
- <paramdef>sd_event *<parameter>event</parameter></paramdef>
- <paramdef>uint64_t *<parameter>ret</parameter></paramdef>
- </funcprototype>
-
</funcsynopsis>
</refsynopsisdiv>
@@ -147,15 +140,12 @@
determine the state the event loop is currently in. It returns one
of the states described below.</para>
- <para><function>sd_event_get_iteration()</function> may be used to determine the current iteration of the event
- loop. It returns an unsigned 64bit integer containing a counter that increases monotonically with each iteration of
- the event loop, starting with 0. The counter is increased at the time of the
- <function>sd_event_prepare()</function> invocation.</para>
-
- <para>All five functions take, as the first argument, the event loop object <parameter>event</parameter> that has
- been created with <function>sd_event_new()</function>. The timeout for <function>sd_event_wait()</function> is
- specified in <parameter>usec</parameter> in microseconds. <constant>(uint64_t) -1</constant> may be used to
- specify an infinite timeout.</para>
+ <para>All four functions take, as the first argument, the event
+ loop object <parameter>event</parameter> that has been created
+ with <function>sd_event_new()</function>. The timeout for
+ <function>sd_event_wait()</function> is specified in
+ <parameter>usec</parameter> in milliseconds. <constant>(uint64_t)
+ -1</constant> may be used to specify an infinite timeout.</para>
</refsect1>
<refsect1>
@@ -339,7 +329,7 @@
<title>See Also</title>
<para>
- <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>elogind</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>,