summaryrefslogtreecommitdiff
path: root/man/sd_event_wait.xml
diff options
context:
space:
mode:
authorMark Hindley <mark@hindley.org.uk>2018-10-30 16:45:09 +0000
committerMark Hindley <mark@hindley.org.uk>2018-10-30 16:45:09 +0000
commit6d97c489b9675603a45eb1ce7940d0a4e416fb71 (patch)
tree3e8540dbdfa4f769fc31ca8c731e744b6c46dadd /man/sd_event_wait.xml
parent8ab330a1c21e46712a684cb720ee576e550f1799 (diff)
Revert all modifications to upstream manpages.
Diffstat (limited to 'man/sd_event_wait.xml')
-rw-r--r--man/sd_event_wait.xml28
1 files changed, 19 insertions, 9 deletions
diff --git a/man/sd_event_wait.xml b/man/sd_event_wait.xml
index c8721777a..6fb04661f 100644
--- a/man/sd_event_wait.xml
+++ b/man/sd_event_wait.xml
@@ -10,7 +10,7 @@
<refentryinfo>
<title>sd_event_wait</title>
- <productname>elogind</productname>
+ <productname>systemd</productname>
</refentryinfo>
<refmeta>
@@ -23,6 +23,7 @@
<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>
@@ -36,7 +37,7 @@
<refsynopsisdiv>
<funcsynopsis>
- <funcsynopsisinfo>#include &lt;elogind/sd-event.h&gt;</funcsynopsisinfo>
+ <funcsynopsisinfo>#include &lt;systemd/sd-event.h&gt;</funcsynopsisinfo>
<funcsynopsisinfo><token>enum</token> {
<constant>SD_EVENT_INITIAL</constant>,
@@ -69,6 +70,12 @@
<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>
@@ -116,12 +123,15 @@
determine the state the event loop is currently in. It returns one
of the states described below.</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>
+ <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>
</refsect1>
<refsect1>
@@ -305,7 +315,7 @@
<title>See Also</title>
<para>
- <citerefentry><refentrytitle>elogind</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</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>,