php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

ev: fix XML by converting para to simpara tags via script (#5145)

Browse Source
This commit is contained in:
Gina Peter Banyard
2026-01-18 22:20:21 +00:00
committed by GitHub
parent 6a08181be1
commit b4fbf4434a
104 changed files with 1100 additions and 1163 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
reference/ev/book.xml
View File

@@ -1,39 +1,38 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<book xml:id="book.ev" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.ev">
<?phpdoc extension-membership="pecl" ?>
<title>Ev</title>
<titleabbrev>Ev</titleabbrev>
<preface xml:id="intro.ev">
&reftitle.intro;
<para>
<simpara>
This extension provides interface to
<link
xlink:href="&url.libev;">libev</link>
<link xlink:href="&url.libev;">libev</link>
library - a high performance full-featured event loop written in C.
</para>
</simpara>
&note.no-windows.extension;
<para>
<simpara>
<emphasis>Libev</emphasis>
is an event loop: one registers interest in certain events (such as a file
descriptor being readable or a timeout occurring), and it will manage these
event sources and provide the program with events.
</para>
<para>
</simpara>
<simpara>
To do this, it must take more or less complete control over the process (or
thread) by executing the event loop handler, and will then communicate
events via a callback mechanism.
</para>
<para>
</simpara>
<simpara>
You register interest in certain events by registering so-called event
watchers, and then hand it over to libev by starting the watcher.
</para>
<para>
</simpara>
<simpara>
For details refer to the
<link xlink:href="http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod">documentation of libev</link>.
</para>
</simpara>
</preface>
&reference.ev.setup;

10
reference/ev/configure.xml
View File

@@ -1,17 +1,17 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="ev.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ev.installation">
&reftitle.install;
<para>
<simpara>
&pecl.info;
<link xlink:href="&url.pecl.package;ev">&url.pecl.package;ev</link>
</para>
<para>
</simpara>
<simpara>
For information about manual installation, please read the file
<filename>INSTALL.md</filename>
included in the package source.
</para>
</simpara>
</section>
<!-- Keep this comment at the end of the file
Local variables:

172
reference/ev/ev.xml
View File

@@ -1,16 +1,16 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.ev" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.ev" role="class">
<title>The Ev class</title>
<titleabbrev>Ev</titleabbrev>
<partintro>
<!-- {{{ Ev intro -->
<section xml:id="ev.intro">
&reftitle.intro;
<para>
<simpara>
Ev is a static class providing access to the default loop and to some common
operations.
</para>
</simpara>
</section>
<!-- }}} -->
<section xml:id="ev.synopsis">
@@ -237,7 +237,7 @@
</fieldsynopsis>
<!--}}}-->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.ev')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.ev')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
</classsynopsis>
<!-- }}} -->
</section>
@@ -254,9 +254,9 @@
<constant>Ev::FLAG_AUTO</constant>
</term>
<listitem>
<para>
<simpara>
The default flags value
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.flag-noenv">
@@ -264,7 +264,7 @@
<constant>Ev::FLAG_NOENV</constant>
</term>
<listitem>
<para>
<simpara>
If this flag used(or the program runs setuid or setgid),
<literal>libev</literal>
won't look at the environment variable
@@ -273,7 +273,7 @@
<varname>LIBEV_FLAGS</varname>
will override the flags completely if it is found. Useful for
performance tests and searching for bugs.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.flag-forkcheck">
@@ -281,7 +281,7 @@
<constant>Ev::FLAG_FORKCHECK</constant>
</term>
<listitem>
<para>
<simpara>
Makes libev check for a fork in each iteration, instead of calling
<methodname>EvLoop::fork</methodname>
manually. This works by calling
@@ -291,7 +291,7 @@
noticeable. This flag setting cannot be overridden or specified in the
<varname>LIBEV_FLAGS</varname>
environment variable.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.flag-noinotify">
@@ -299,21 +299,20 @@
<constant>Ev::FLAG_NOINOTIFY</constant>
</term>
<listitem>
<para>
<simpara>
When this flag is specified,
<literal>libev</literal>
won't attempt to use the
<literal>inotify</literal>
API for its
<link
xlink:href="&url.ev.stat;">ev_stat</link>
<link xlink:href="&url.ev.stat;">ev_stat</link>
watchers. The flag can be useful to conserve inotify file descriptors,
as otherwise each loop using
<literal>ev_stat</literal>
watchers consumes one
<literal>inotify</literal>
handle.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.flag-signalfd">
@@ -321,14 +320,13 @@
<constant>Ev::FLAG_SIGNALFD</constant>
</term>
<listitem>
<para>
<simpara>
When this flag is specified,
<literal>libev</literal>
will attempt to use the
<literal>signalfd</literal>
API for its
<link
xlink:href="&url.ev.signal;">ev_signal</link>
<link xlink:href="&url.ev.signal;">ev_signal</link>
(and
<link xlink:href="&url.ev.child;">ev_child</link>)
watchers. This API delivers signals synchronously, which makes it
@@ -337,7 +335,7 @@
are properly blocked in threads.
<literal>Signalfd</literal>
will not be used by default.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.flag-nosigmask">
@@ -345,16 +343,16 @@
<constant>Ev::FLAG_NOSIGMASK</constant>
</term>
<listitem>
<para>
<simpara>
When this flag is specified,
<literal>libev</literal>
will avoid to modify the signal mask. Specifically, this means having
to make sure signals are unblocked before receiving them.
</para>
<para>
</simpara>
<simpara>
This behaviour is useful for custom signal handling, or handling
signals only in specific threads.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -372,14 +370,14 @@
<constant>Ev::RUN_NOWAIT</constant>
</term>
<listitem>
<para>
<simpara>
Means that event loop will look for new events, will handle those
events and any already outstanding ones, but will not wait and block
the process in case there are no events and will return after one
iteration of the loop. This is sometimes useful to poll and handle new
events while doing lengthy calculations, to keep the program
responsive.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.run-once">
@@ -387,14 +385,14 @@
<constant>Ev::RUN_ONCE</constant>
</term>
<listitem>
<para>
<simpara>
Means that event loop will look for new events (waiting if necessary)
and will handle those and any already outstanding ones. It will block
the process until at least one new event arrives (which could be an
event internal to libev itself, so there is no guarantee that a
user-registered callback will be called), and will return after one
iteration of the loop.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -412,9 +410,9 @@
<constant>Ev::BREAK_CANCEL</constant>
</term>
<listitem>
<para>
<simpara>
Cancel the break operation.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.break-one">
@@ -422,13 +420,13 @@
<constant>Ev::BREAK_ONE</constant>
</term>
<listitem>
<para>
<simpara>
Makes the innermost
<methodname>Ev::run</methodname>
(or
<methodname>EvLoop::run</methodname>)
call return.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.break-all">
@@ -436,13 +434,13 @@
<constant>Ev::BREAK_ALL</constant>
</term>
<listitem>
<para>
<simpara>
Makes all nested
<methodname>Ev::run</methodname>
(or
<methodname>EvLoop::run</methodname>)
calls return.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -457,9 +455,9 @@
<constant>Ev::MINPRI</constant>
</term>
<listitem>
<para>
<simpara>
Minimum allowed watcher priority.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.maxpri">
@@ -467,9 +465,9 @@
<constant>Ev::MAXPRI</constant>
</term>
<listitem>
<para>
<simpara>
Maximum allowed watcher priority.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -484,11 +482,11 @@
<constant>Ev::READ</constant>
</term>
<listitem>
<para>
<simpara>
The file descriptor in the
<classname>EvIo</classname>
watcher has become readable.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.write">
@@ -496,11 +494,11 @@
<constant>Ev::WRITE</constant>
</term>
<listitem>
<para>
<simpara>
The file descriptor in the
<classname>EvIo</classname>
watcher has become writable.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.timer">
@@ -508,10 +506,10 @@
<constant>Ev::TIMER</constant>
</term>
<listitem>
<para>
<simpara>
<classname>EvTimer</classname>
watcher has been timed out.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.periodic">
@@ -519,10 +517,10 @@
<constant>Ev::PERIODIC</constant>
</term>
<listitem>
<para>
<simpara>
<classname>EvPeriodic</classname>
watcher has been timed out.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.signal">
@@ -530,11 +528,11 @@
<constant>Ev::SIGNAL</constant>
</term>
<listitem>
<para>
<simpara>
A signal specified in
<methodname>EvSignal::__construct</methodname>
has been received.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.child">
@@ -542,13 +540,13 @@
<constant>Ev::CHILD</constant>
</term>
<listitem>
<para>
<simpara>
The
<parameter>pid</parameter>
specified in
<methodname>EvChild::__construct</methodname>
has received a status change.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.stat">
@@ -556,11 +554,11 @@
<constant>Ev::STAT</constant>
</term>
<listitem>
<para>
<simpara>
The path specified in
<classname>EvStat</classname>
watcher changed its attributes.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.idle">
@@ -568,10 +566,10 @@
<constant>Ev::IDLE</constant>
</term>
<listitem>
<para>
<simpara>
<classname>EvIdle</classname>
watcher works when there is nothing to do with other watchers.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.prepare">
@@ -579,7 +577,7 @@
<constant>Ev::PREPARE</constant>
</term>
<listitem>
<para>
<simpara>
All
<classname>EvPrepare</classname>
watchers are invoked just before
@@ -588,7 +586,7 @@
<classname>EvPrepare</classname>
watchers are the last watchers invoked before the event loop sleeps or
polls for new events.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.check">
@@ -596,7 +594,7 @@
<constant>Ev::CHECK</constant>
</term>
<listitem>
<para>
<simpara>
All
<classname>EvCheck</classname>
watchers are queued just after
@@ -606,7 +604,7 @@
<classname>EvCheck</classname>
watchers will be invoked before any other watchers of the same or
lower priority within an event loop iteration.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.embed">
@@ -614,11 +612,11 @@
<constant>Ev::EMBED</constant>
</term>
<listitem>
<para>
<simpara>
The embedded event loop specified in the
<classname>EvEmbed</classname>
watcher needs attention.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.custom">
@@ -626,7 +624,7 @@
<constant>Ev::CUSTOM</constant>
</term>
<listitem>
<para>
<simpara>
Not ever sent(or otherwise used) by
<literal>libev</literal>
itself, but can be freely used by
@@ -634,7 +632,7 @@
users to signal watchers (e.g. via
<methodname>EvWatcher::feed</methodname>
).
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.error">
@@ -642,7 +640,7 @@
<constant>Ev::ERROR</constant>
</term>
<listitem>
<para>
<simpara>
An unspecified error has occurred, the watcher has been stopped. This
might happen because the watcher could not be properly started because
<literal>libev</literal>
@@ -650,10 +648,9 @@
other problem.
<literal>Libev</literal>
considers these application bugs. See also
<link
xlink:href="http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#ANATOMY_OF_A_WATCHER_CONTENT">ANATOMY
<link xlink:href="http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#ANATOMY_OF_A_WATCHER_CONTENT">ANATOMY
OF A WATCHER</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -668,9 +665,9 @@
<constant>Ev::BACKEND_SELECT</constant>
</term>
<listitem>
<para>
<simpara>
<literal>select(2) backend</literal>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.backend-poll">
@@ -678,9 +675,9 @@
<constant>Ev::BACKEND_POLL</constant>
</term>
<listitem>
<para>
<simpara>
<literal>poll(2) backend</literal>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.backend-epoll">
@@ -688,11 +685,11 @@
<constant>Ev::BACKEND_EPOLL</constant>
</term>
<listitem>
<para>
<simpara>
Linux-specific
<literal>epoll(7)</literal>
backend for both pre- and post-2.6.9 kernels
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.backend-kqueue">
@@ -700,7 +697,7 @@
<constant>Ev::BACKEND_KQUEUE</constant>
</term>
<listitem>
<para>
<simpara>
<literal>kqueue</literal>
backend used on most BSD systems.
<classname>EvEmbed</classname>
@@ -708,7 +705,7 @@
another. For instance, one can try to create an event loop with
<literal>kqueue</literal>
backend and use it for sockets only.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.backend-devpoll">
@@ -716,9 +713,9 @@
<constant>Ev::BACKEND_DEVPOLL</constant>
</term>
<listitem>
<para>
<simpara>
Solaris 8 backend. This is not implemented yet.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.backend-port">
@@ -726,9 +723,9 @@
<constant>Ev::BACKEND_PORT</constant>
</term>
<listitem>
<para>
<simpara>
Solaris 10 event port mechanism with a good scaling.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.backend-all">
@@ -736,7 +733,7 @@
<constant>Ev::BACKEND_ALL</constant>
</term>
<listitem>
<para>
<simpara>
Try all backends(even currupted ones). It's not recommended to use it
explicitly. Bitwise operators should be applied here(e.g.
<constant>Ev::BACKEND_ALL</constant>
@@ -745,7 +742,7 @@
Use
<methodname>Ev::recommendedBackends</methodname>,
or don't specify any backends at all.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ev.constants.backend-mask">
@@ -753,32 +750,31 @@
<constant>Ev::BACKEND_MASK</constant>
</term>
<listitem>
<para>
<simpara>
Not a backend, but a mask to select all backend bits from
<parameter>flags</parameter>
value to mask out any backends(e.g. when modifying the
<varname>LIBEV_FLAGS</varname>
environment variable).
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<!--}}}-->
<note xmlns="http://docbook.org/ns/docbook">
<para>
<simpara>
For the default loop during module initialization phase
<literal>Ev</literal>
registers
<link
xlink:href="&url.ev.loop;">ev_loop_fork</link>
<link xlink:href="&url.ev.loop;">ev_loop_fork</link>
call by means of
<literal>pthread_atfork</literal>
(if available).
</para>
</simpara>
</note>
<note xmlns="http://docbook.org/ns/docbook">
<para>
<simpara>
There are methods providing access to the
<emphasis>default event
loop</emphasis>
@@ -795,12 +791,12 @@
of the
<classname>EvLoop</classname>
class.
</para>
<para>
</simpara>
<simpara>
The instance of the default event loop itself can be fetched by means of
<methodname>EvLoop::defaultLoop</methodname>
method.
</para>
</simpara>
</note>
</section>
<!-- }}} -->

12
reference/ev/ev/backend.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ev.backend" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ev.backend">
<refnamediv>
<refname>Ev::backend</refname>
<refpurpose>Returns an integer describing the backend used by libev</refpurpose>
@@ -13,14 +13,14 @@
<modifier>static</modifier>
<type>int</type>
<methodname>Ev::backend</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns an integer describing the backend used by
<emphasis>libev</emphasis>.
See
<link linkend="ev.constants.watcher-backends">Backend flags</link>
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -28,10 +28,10 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an integer(bit mask) describing the backend used by
<emphasis>libev</emphasis>.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

12
reference/ev/ev/depth.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ev.depth" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ev.depth">
<refnamediv>
<refname>Ev::depth</refname>
<refpurpose>Returns recursion depth</refpurpose>
@@ -13,9 +13,9 @@
<modifier>static</modifier>
<type>int</type>
<methodname>Ev::depth</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
The number of times
<methodname>Ev::run</methodname>
was entered minus the number of times
@@ -30,7 +30,7 @@
<methodname>Ev::run</methodname>
was invoked recursively (or from another thread), in which case it is
higher.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -38,10 +38,10 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>ev_depth</function>
returns recursion depth of the default loop.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

15
reference/ev/ev/embeddablebackends.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ev.embeddablebackends" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ev.embeddablebackends">
<refnamediv>
<refname>Ev::embeddableBackends</refname>
<refpurpose>Returns the set of backends that are embeddable in other event loops</refpurpose>
@@ -13,11 +13,11 @@
<modifier>static</modifier>
<type>int</type>
<methodname>Ev::embeddableBackends</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns the set of backends that are embeddable in other event loops.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -25,14 +25,13 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a bit mask which can containing
<link
linkend="ev.constants.watcher-backends">backend flags</link>
<link linkend="ev.constants.watcher-backends">backend flags</link>
combined using bitwise
<emphasis>OR</emphasis>
operator.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

18
reference/ev/ev/feedsignal.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ev.feedsignal" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ev.feedsignal">
<refnamediv>
<refname>Ev::feedSignal</refname>
<refpurpose>Feed a signal event info Ev</refpurpose>
@@ -18,16 +18,16 @@
<parameter>signum</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Simulates a signal receive. It is safe to call this function at any time,
from any context, including signal handlers or random threads. Its main use
is to customise signal handling in the process.
</para>
<para>
</simpara>
<simpara>
Unlike
<methodname>Ev::feedSignalEvent</methodname>,
this works regardless of which loop has registered the signal.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -37,22 +37,22 @@
<parameter>signum</parameter>
</term>
<listitem>
<para>
<simpara>
Signal number. See
<literal>signal(7)</literal>
man page for detals. You can use constants exported by
<literal>pcntl</literal>
extension.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

14
reference/ev/ev/feedsignalevent.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ev.feedsignalevent" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ev.feedsignalevent">
<refnamediv>
<refname>Ev::feedSignalEvent</refname>
<refpurpose>Feed signal event into the default loop</refpurpose>
@@ -18,12 +18,12 @@
<parameter>signum</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Feed signal event into the default loop. Ev will react to this call as if
the signal specified by
<parameter>signal</parameter>
had occurred.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -33,22 +33,22 @@
<parameter>signum</parameter>
</term>
<listitem>
<para>
<simpara>
Signal number. See
<literal>signal(7)</literal>
man page for detals. See also constants exported by
<literal>pcntl</literal>
extension.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

12
reference/ev/ev/iteration.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ev.iteration" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ev.iteration">
<refnamediv>
<refname>Ev::iteration</refname>
<refpurpose>Return the number of times the default event loop has polled for new
@@ -14,12 +14,12 @@
<modifier>static</modifier>
<type>int</type>
<methodname>Ev::iteration</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Return the number of times the event loop has polled for new events.
Sometimes useful as a generation counter.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -27,9 +27,9 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns number of polls of the default event loop.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

12
reference/ev/ev/now.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ev.now" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ev.now">
<refnamediv>
<refname>Ev::now</refname>
<refpurpose>Returns the time when the last iteration of the default event
@@ -14,9 +14,9 @@
<modifier>static</modifier>
<type>float</type>
<methodname>Ev::now</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns the time when the last iteration of the default event loop has
started. This is the time that timers(
<classname>EvTimer</classname>
@@ -24,7 +24,7 @@
<classname>EvPeriodic</classname>)
are based on, and referring to it is usually faster then calling
<methodname>Ev::time</methodname>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -32,10 +32,10 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns number of seconds(fractional) representing the time when the last
iteration of the default event loop has started.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

16
reference/ev/ev/nowupdate.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ev.nowupdate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ev.nowupdate">
<refnamediv>
<refname>Ev::nowUpdate</refname>
<refpurpose>Establishes the current time by querying the kernel, updating the time
@@ -14,22 +14,22 @@
<modifier>static</modifier>
<type>void</type>
<methodname>Ev::nowUpdate</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Establishes the current time by querying the kernel, updating the time
returned by
<methodname>Ev::now</methodname>
in the progress. This is a costly operation and is usually done
automatically within
<methodname>Ev::run</methodname>.
</para>
<para>
</simpara>
<simpara>
This method is rarely useful, but when some event callback runs for a very
long time without entering the event loop, updating
<emphasis>libev</emphasis>
's consideration of the current time is a good idea.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -37,9 +37,9 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

15
reference/ev/ev/recommendedbackends.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ev.recommendedbackends" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ev.recommendedbackends">
<refnamediv>
<refname>Ev::recommendedBackends</refname>
<refpurpose>Returns a bit mask of recommended backends for current
@@ -14,9 +14,9 @@
<modifier>static</modifier>
<type>int</type>
<methodname>Ev::recommendedBackends</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns the set of all backends compiled into this binary of
<literal>libev</literal>
and also recommended for this platform, meaning it will work for most file
@@ -30,7 +30,7 @@
This is the set of backends that
<literal>libev</literal>
will probe no backends specified explicitly.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -38,14 +38,13 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a bit mask which can containing
<link
linkend="ev.constants.watcher-backends">backend flags</link>
<link linkend="ev.constants.watcher-backends">backend flags</link>
combined using bitwise
<emphasis>OR</emphasis>
operator.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

24
reference/ev/ev/resume.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ev.resume" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ev.resume">
<refnamediv>
<refname>Ev::resume</refname>
<refpurpose>Resume previously suspended default event loop</refpurpose>
@@ -13,15 +13,15 @@
<modifier>static</modifier>
<type>void</type>
<methodname>Ev::resume</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
<methodname>Ev::suspend</methodname>
and
<methodname>Ev::resume</methodname>
methods suspend and resume a loop correspondingly.
</para>
<para>
</simpara>
<simpara>
All timer watchers will be delayed by the time spend between
<emphasis>suspend</emphasis>
and
@@ -30,8 +30,8 @@
<emphasis>periodic</emphasis>
watchers will be rescheduled(that is, they will lose any events that would
have occurred while suspended).
</para>
<para>
</simpara>
<simpara>
After calling
<methodname>Ev::suspend</methodname>
it is not allowed to call any function on the given loop other than
@@ -40,8 +40,8 @@
<methodname>Ev::resume</methodname>
without a previous call to
<methodname>Ev::suspend</methodname>.
</para>
<para>
</simpara>
<simpara>
Calling
<emphasis>suspend</emphasis>
/
@@ -49,7 +49,7 @@
has the side effect of updating the event loop time(see
<methodname>Ev::nowUpdate</methodname>
).
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -57,9 +57,9 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

14
reference/ev/ev/run.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ev.run" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ev.run">
<refnamediv>
<refname>Ev::run</refname>
<refpurpose>Begin checking for events and calling callbacks for the default
@@ -19,7 +19,7 @@
<parameter>flags</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Begin checking for events and calling callbacks
<emphasis>for the default loop</emphasis>.
Returns when a callback calls
@@ -31,7 +31,7 @@
value can generally be interpreted as
<emphasis>if &true;, there is more work left to
do</emphasis>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -81,20 +81,20 @@
</tgroup>
</table>
</para>
<para>
<simpara>
See
<link linkend="ev.constants.run-flags">the run flag
constants</link>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

14
reference/ev/ev/sleep.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ev.sleep" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ev.sleep">
<refnamediv>
<refname>Ev::sleep</refname>
<refpurpose>Block the process for the given number of seconds</refpurpose>
@@ -18,9 +18,9 @@
<parameter>seconds</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Block the process for the given number of seconds.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -30,18 +30,18 @@
<parameter>seconds</parameter>
</term>
<listitem>
<para>
<simpara>
Fractional number of seconds
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

17
reference/ev/ev/stop.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ev.stop" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ev.stop">
<refnamediv>
<refname>Ev::stop</refname>
<refpurpose>Stops the default event loop</refpurpose>
@@ -18,9 +18,9 @@
<parameter>how</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Stops the default event loop
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -30,21 +30,20 @@
<parameter>how</parameter>
</term>
<listitem>
<para>
<simpara>
One of
<emphasis>Ev::BREAK_*</emphasis>
<link
linkend="ev.constants.break-flags">constants</link>.
</para>
<link linkend="ev.constants.break-flags">constants</link>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

15
reference/ev/ev/supportedbackends.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ev.supportedbackends" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ev.supportedbackends">
<refnamediv>
<refname>Ev::supportedBackends</refname>
<refpurpose>Returns the set of backends supported by current libev
@@ -14,11 +14,11 @@
<modifier>static</modifier>
<type>int</type>
<methodname>Ev::supportedBackends</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns the set of backends supported by current libev configuration.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -26,14 +26,13 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a bit mask which can containing
<link
linkend="ev.constants.watcher-backends">backend flags</link>
<link linkend="ev.constants.watcher-backends">backend flags</link>
combined using bitwise
<emphasis>OR</emphasis>
operator.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

20
reference/ev/ev/suspend.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ev.suspend" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ev.suspend">
<refnamediv>
<refname>Ev::suspend</refname>
<refpurpose>Suspend the default event loop</refpurpose>
@@ -13,15 +13,15 @@
<modifier>static</modifier>
<type>void</type>
<methodname>Ev::suspend</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
<methodname>Ev::suspend</methodname>
and
<methodname>Ev::resume</methodname>
methods suspend and resume the default loop correspondingly.
</para>
<para>
</simpara>
<simpara>
All timer watchers will be delayed by the time spend between
<emphasis>suspend</emphasis>
and
@@ -30,8 +30,8 @@
<emphasis>periodic</emphasis>
watchers will be rescheduled(that is, they will lose any events that would
have occurred while suspended).
</para>
<para>
</simpara>
<simpara>
After calling
<methodname>Ev::suspend</methodname>
it is not allowed to call any function on the given loop other than
@@ -40,7 +40,7 @@
<methodname>Ev::resume</methodname>
without a previous call to
<methodname>Ev::suspend</methodname>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -48,9 +48,9 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

12
reference/ev/ev/time.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ev.time" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ev.time">
<refnamediv>
<refname>Ev::time</refname>
<refpurpose>Returns the current time in fractional seconds since the epoch</refpurpose>
@@ -13,13 +13,13 @@
<modifier>static</modifier>
<type>float</type>
<methodname>Ev::time</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns the current time in fractional seconds since the epoch. Consider
using
<methodname>Ev::now</methodname>
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -27,9 +27,9 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the current time in fractional seconds since the epoch.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

12
reference/ev/ev/verify.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ev.verify" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ev.verify">
<refnamediv>
<refname>Ev::verify</refname>
<refpurpose>Performs internal consistency checks(for debugging)</refpurpose>
@@ -13,13 +13,13 @@
<modifier>static</modifier>
<type>void</type>
<methodname>Ev::verify</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Performs internal consistency checks(for debugging
<emphasis>libev</emphasis>)
and abort the program if any data structures were found to be corrupted.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -27,9 +27,9 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

26
reference/ev/evcheck.xml
View File

@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.evcheck" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.evcheck" role="class">
<title>The EvCheck class</title>
<titleabbrev>EvCheck</titleabbrev>
<partintro>
<!-- {{{ EvCheck intro -->
<section xml:id="evcheck.intro">
&reftitle.intro;
<para>
<simpara>
<classname>EvPrepare</classname>
and
<classname>EvCheck</classname>
@@ -16,8 +16,8 @@
watchers get invoked before the process blocks,
<classname>EvCheck</classname>
afterwards.
</para>
<para>
</simpara>
<simpara>
It is not allowed to call
<methodname>EvLoop::run</methodname>
or similar methods or functions that enter the current event loop from
@@ -33,16 +33,16 @@
<classname>EvCheck</classname>,
so having a watcher of each kind they will always be called in pairs
bracketing the blocking call.
</para>
<para>
</simpara>
<simpara>
The main purpose is to integrate other event mechanisms into
<emphasis>libev</emphasis>
and their use is somewhat advanced. They could be used, for example, to
track variable changes, implement custom watchers, integrate net-snmp or a
coroutine library and lots more. They are also occasionally useful to
cache some data and want to flush it before blocking.
</para>
<para>
</simpara>
<simpara>
It is recommended to give
<classname>EvCheck</classname>
watchers highest(
@@ -51,8 +51,8 @@
after the poll (this doesn’t matter for
<classname>EvPrepare</classname>
watchers).
</para>
<para>
</simpara>
<simpara>
Also,
<classname>EvCheck</classname>
watchers should not activate/feed events. While
@@ -60,7 +60,7 @@
fully supports this, they might get executed before other
<classname>EvCheck</classname>
watchers did their job.
</para>
</simpara>
</section>
<!-- }}} -->
<section xml:id="evcheck.synopsis">
@@ -84,12 +84,12 @@
<!-- }}} -->
<!--<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>-->
<classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('evwatcher.synopsis')/descendant::db:fieldsynopsis)" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('evwatcher.synopsis')/descendant::db:fieldsynopsis)"/>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evcheck')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evcheck')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evwatcher')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evwatcher')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
</classsynopsis>
<!-- }}} -->
</section>

18
reference/ev/evcheck/construct.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evcheck.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evcheck.construct">
<refnamediv>
<refname>EvCheck::__construct</refname>
<refpurpose>Constructs the EvCheck watcher object</refpurpose>
@@ -23,11 +23,11 @@
<parameter>priority</parameter>
</methodparam>
</constructorsynopsis>
<para>
<simpara>
Constructs the
<classname>EvCheck</classname>
watcher object.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -37,10 +37,10 @@
<parameter>callback</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -48,9 +48,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data associated with the watcher.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -58,9 +58,9 @@
<parameter>priority</parameter>
</term>
<listitem>
<para>
<simpara>
<link linkend="ev.constants.watcher-pri">Watcher priority</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>

22
reference/ev/evcheck/createstopped.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evcheck.createstopped" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evcheck.createstopped">
<refnamediv>
<refname>EvCheck::createStopped</refname>
<refpurpose>Create instance of a stopped EvCheck watcher</refpurpose>
@@ -26,9 +26,9 @@
<parameter>priority</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Create instance of a stopped EvCheck watcher
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -38,10 +38,10 @@
<parameter>callback</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -49,9 +49,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data associated with the watcher.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -59,18 +59,18 @@
<parameter>priority</parameter>
</term>
<listitem>
<para>
<simpara>
<link linkend="ev.constants.watcher-pri">Watcher priority</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns EvCheck object on success.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

26
reference/ev/evchild.xml
View File

@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.evchild" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.evchild" role="class">
<title>The EvChild class</title>
<titleabbrev>EvChild</titleabbrev>
<partintro>
<!-- {{{ EvChild intro -->
<section xml:id="evchild.intro">
&reftitle.intro;
<para>
<simpara>
<classname>EvChild</classname>
watchers trigger when the process receives a
<constant>SIGCHLD</constant>
@@ -19,14 +19,14 @@
from a watcher), i.e. forking and then immediately registering a watcher
for the child is fine, but forking and registering a watcher a few event
loop iterations later or in the next callback invocation is not.
</para>
<para>
</simpara>
<simpara>
It is allowed to register
<classname>EvChild</classname>
watchers in the
<emphasis>default loop</emphasis>
only.
</para>
</simpara>
</section>
<!-- }}} -->
<section xml:id="evchild.synopsis">
@@ -62,12 +62,12 @@
<varname linkend="evchild.props.rstatus">rstatus</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('evwatcher.synopsis')/descendant::db:fieldsynopsis)" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('evwatcher.synopsis')/descendant::db:fieldsynopsis)"/>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evchild')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evchild')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evwatcher')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evwatcher')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
</classsynopsis>
<!-- }}} -->
</section>
@@ -80,12 +80,12 @@
<varname>pid</varname>
</term>
<listitem>
<para>
<simpara>
<emphasis>Readonly</emphasis>.
The process ID this watcher watches out for, or
<literal>0</literal>,
meaning any process ID.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="evchild.props.rpid">
@@ -93,10 +93,10 @@
<varname>rpid</varname>
</term>
<listitem>
<para>
<simpara>
<emphasis>Readonly</emphasis>
.The process ID that detected a status change.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="evchild.props.rstatus">
@@ -104,11 +104,11 @@
<varname>rstatus</varname>
</term>
<listitem>
<para>
<simpara>
<emphasis>Readonly</emphasis>.
The process exit status caused by
<varname>rpid</varname>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>

52
reference/ev/evchild/construct.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evchild.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evchild.construct">
<refnamediv>
<refname>EvChild::__construct</refname>
<refpurpose>Constructs the EvChild watcher object</refpurpose>
@@ -22,25 +22,23 @@
<type>callable</type>
<parameter>callback</parameter>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>int</type>
<parameter>priority</parameter>
<initializer>0</initializer>
</methodparam>
</constructorsynopsis>
<para>
<simpara>
Constructs the
<classname>EvChild</classname>
watcher object.
</para>
<para>
</simpara>
<simpara>
Call the callback when a status change for process ID
<parameter>pid</parameter>
(or any
@@ -58,8 +56,8 @@
<emphasis>Ev</emphasis>
will fetch the outstanding exit/wait status for all changed/zombie children
and call the callback.
</para>
<para>
</simpara>
<simpara>
It is valid to install a child watcher after an
<classname>EvChild</classname>
has exited but before the event loop has started its next iteration. For
@@ -69,8 +67,8 @@
<classname>EvChild</classname>
watcher is installed in the parent for the new
<emphasis>PID</emphasis>.
</para>
<para>
</simpara>
<simpara>
You can access both exit/tracing status and
<parameter>pid</parameter>
by using the
@@ -78,19 +76,19 @@
and
<varname>rpid</varname>
properties of the watcher object.
</para>
<para>
</simpara>
<simpara>
The number of
<emphasis>PID</emphasis>
watchers per
<emphasis>PID</emphasis>
is unlimited. All of them will be called.
</para>
<para>
</simpara>
<simpara>
The
<methodname>EvChild::createStopped</methodname>
method doesn&apos;t start(activate) the newly created watcher.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -100,12 +98,12 @@
<parameter>pid</parameter>
</term>
<listitem>
<para>
<simpara>
Wait for status changes of process PID(or any process if PID is
specified as
<literal>0</literal>
).
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -113,11 +111,11 @@
<parameter>trace</parameter>
</term>
<listitem>
<para>
<simpara>
If &false;, only activate the watcher when the process terminates.
Otherwise(&true;) additionally activate the watcher when the process is
stopped or continued.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -125,10 +123,10 @@
<parameter>callback</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -136,9 +134,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data associated with the watcher.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -146,9 +144,9 @@
<parameter>priority</parameter>
</term>
<listitem>
<para>
<simpara>
<link linkend="ev.constants.watcher-pri">Watcher priority</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>

28
reference/ev/evchild/createstopped.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evchild.createstopped" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evchild.createstopped">
<refnamediv>
<refname>EvChild::createStopped</refname>
<refpurpose>Create instance of a stopped EvCheck watcher</refpurpose>
@@ -34,11 +34,11 @@
<parameter>priority</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
The same as
<methodname>EvChild::__construct</methodname>,
but doesn't start the watcher automatically.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -48,10 +48,10 @@
<parameter>pid</parameter>
</term>
<listitem>
<para>
<simpara>
The same as for
<methodname>EvChild::__construct</methodname>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -59,10 +59,10 @@
<parameter>trace</parameter>
</term>
<listitem>
<para>
<simpara>
The same as for
<methodname>EvChild::__construct</methodname>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -70,10 +70,10 @@
<parameter>callback</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -81,9 +81,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data associated with the watcher.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -91,16 +91,16 @@
<parameter>priority</parameter>
</term>
<listitem>
<para>
<simpara>
<link linkend="ev.constants.watcher-pri">Watcher priority</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para></para>
<simpara/>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

16
reference/ev/evchild/set.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evchild.set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evchild.set">
<refnamediv>
<refname>EvChild::set</refname>
<refpurpose>Configures the watcher</refpurpose>
@@ -20,7 +20,7 @@
<parameter>trace</parameter>
</methodparam>
</methodsynopsis>
<para></para>
<simpara/>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -30,10 +30,10 @@
<parameter>pid</parameter>
</term>
<listitem>
<para>
<simpara>
The same as for
<methodname>EvChild::__construct</methodname>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -41,19 +41,19 @@
<parameter>trace</parameter>
</term>
<listitem>
<para>
<simpara>
The same as for
<methodname>EvChild::__construct</methodname>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

18
reference/ev/evembed.xml
View File

@@ -1,15 +1,15 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.evembed" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.evembed" role="class">
<title>The EvEmbed class</title>
<titleabbrev>EvEmbed</titleabbrev>
<partintro>
<!-- {{{ EvEmbed intro -->
<section xml:id="evembed.intro">
&reftitle.intro;
<para>
<simpara>
Used to embed one event loop into another.
</para>
</simpara>
</section>
<!-- }}} -->
<section xml:id="evembed.synopsis">
@@ -40,7 +40,7 @@
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evembed')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evembed')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evwatcher')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evwatcher')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
</classsynopsis>
<!-- }}} -->
</section>
@@ -53,7 +53,7 @@
<varname>is_active</varname>
</term>
<listitem>
<para></para>
<simpara/>
</listitem>
</varlistentry>
<varlistentry xml:id="evembed.props.data">
@@ -61,7 +61,7 @@
<varname>data</varname>
</term>
<listitem>
<para></para>
<simpara/>
</listitem>
</varlistentry>
<varlistentry xml:id="evembed.props.is-pending">
@@ -69,7 +69,7 @@
<varname>is_pending</varname>
</term>
<listitem>
<para></para>
<simpara/>
</listitem>
</varlistentry>
<varlistentry xml:id="evembed.props.priority">
@@ -77,7 +77,7 @@
<varname>priority</varname>
</term>
<listitem>
<para></para>
<simpara/>
</listitem>
</varlistentry>
<varlistentry xml:id="evembed.props.embed">
@@ -85,7 +85,7 @@
<varname>embed</varname>
</term>
<listitem>
<para></para>
<simpara/>
</listitem>
</varlistentry>
</variablelist>

33
reference/ev/evembed/construct.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evembed.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evembed.construct">
<refnamediv>
<refname>EvEmbed::__construct</refname>
<refpurpose>Constructs the EvEmbed object</refpurpose>
@@ -27,26 +27,25 @@
<parameter>priority</parameter>
</methodparam>
</constructorsynopsis>
<para>
<simpara>
This is a rather advanced watcher type that lets to embed one event loop
into another(currently only IO events are supported in the embedded loop,
other types of watchers might be handled in a delayed or incorrect fashion
and must not be used).
</para>
<para>
</simpara>
<simpara>
See
<link
xlink:href="http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_">the
<link xlink:href="http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_">the
libev documentation</link>
for details.
</para>
<para>
</simpara>
<simpara>
This watcher is most useful on
<emphasis>BSD</emphasis>
systems without working
<literal>kqueue</literal>
to still be able to handle a large number of sockets. See example below.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -56,13 +55,13 @@
<parameter>other</parameter>
</term>
<listitem>
<para>
<simpara>
Instance of
<classname>EvLoop</classname>.
The loop to embed, this loop must be embeddable(see
<methodname>Ev::embeddableBackends</methodname>
).
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -70,10 +69,10 @@
<parameter>callback</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -81,9 +80,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data associated with the watcher.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -91,9 +90,9 @@
<parameter>priority</parameter>
</term>
<listitem>
<para>
<simpara>
<link linkend="ev.constants.watcher-pri">Watcher priority</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>

26
reference/ev/evembed/createstopped.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evembed.createstopped" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evembed.createstopped">
<refnamediv>
<refname>EvEmbed::createStopped</refname>
<refpurpose>Create stopped EvEmbed watcher object</refpurpose>
@@ -30,11 +30,11 @@
<parameter>priority</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
The same as
<methodname>EvEmbed::__construct</methodname>,
but doesn't start the watcher automatically.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -44,10 +44,10 @@
<parameter>other</parameter>
</term>
<listitem>
<para>
<simpara>
The same as for
<methodname>EvEmbed::__construct</methodname>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -55,10 +55,10 @@
<parameter>callback</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -66,9 +66,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data associated with the watcher.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -76,18 +76,18 @@
<parameter>priority</parameter>
</term>
<listitem>
<para>
<simpara>
<link linkend="ev.constants.watcher-pri">Watcher priority</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns stopped EvEmbed object on success.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

14
reference/ev/evembed/set.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evembed.set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evembed.set">
<refnamediv>
<refname>EvEmbed::set</refname>
<refpurpose>Configures the watcher</refpurpose>
@@ -16,11 +16,11 @@
<parameter>other</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Configures the watcher to use
<parameter>other</parameter>
event loop object.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -30,19 +30,19 @@
<parameter>other</parameter>
</term>
<listitem>
<para>
<simpara>
The same as for
<methodname>EvEmbed::__construct</methodname>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

8
reference/ev/evembed/sweep.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evembed.sweep" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evembed.sweep">
<refnamediv>
<refname>EvEmbed::sweep</refname>
<refpurpose>Make a single, non-blocking sweep over the embedded loop</refpurpose>
@@ -11,7 +11,7 @@
<modifier>public</modifier>
<type>void</type>
<methodname>EvEmbed::sweep</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Make a single, non-blocking sweep over the embedded loop. Works similarly
@@ -31,9 +31,9 @@ $other->start(Ev::RUN_NOWAIT);
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

10
reference/ev/evfork.xml
View File

@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.evfork" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.evfork" role="class">
<title>The EvFork class</title>
<titleabbrev>EvFork</titleabbrev>
<partintro>
<!-- {{{ EvFork intro -->
<section xml:id="evfork.intro">
&reftitle.intro;
<para>
<simpara>
Fork watchers are called when a
<literal>fork()</literal>
was detected (usually because whoever signalled
@@ -20,7 +20,7 @@
that if whoever calling
<methodname>EvLoop::fork</methodname>
calls it in the wrong process, the fork handlers will be invoked, too.
</para>
</simpara>
</section>
<!-- }}} -->
<section xml:id="evfork.synopsis">
@@ -44,12 +44,12 @@
<!-- }}} -->
<!--<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>-->
<classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('evwatcher.synopsis')/descendant::db:fieldsynopsis)" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('evwatcher.synopsis')/descendant::db:fieldsynopsis)"/>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evfork')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evfork')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evwatcher')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evwatcher')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
</classsynopsis>
<!-- }}} -->
</section>

24
reference/ev/evfork/construct.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evfork.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evfork.construct">
<refnamediv>
<refname>EvFork::__construct</refname>
<refpurpose>Constructs the EvFork watcher object</refpurpose>
@@ -14,22 +14,20 @@
<type>callable</type>
<parameter>callback</parameter>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>int</type>
<parameter>priority</parameter>
<initializer>0</initializer>
</methodparam>
</constructorsynopsis>
<para>
<simpara>
Constructs the EvFork watcher object and starts the watcher automatically.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -39,10 +37,10 @@
<parameter>callback</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -50,9 +48,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data associated with the watcher.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -60,9 +58,9 @@
<parameter>priority</parameter>
</term>
<listitem>
<para>
<simpara>
<link linkend="ev.constants.watcher-pri">Watcher priority</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>

22
reference/ev/evfork/createstopped.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evfork.createstopped" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evfork.createstopped">
<refnamediv>
<refname>EvFork::createStopped</refname>
<refpurpose>Creates a stopped instance of EvFork watcher class</refpurpose>
@@ -26,11 +26,11 @@
<parameter>priority</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
The same as
<methodname>EvFork::__construct</methodname>,
but doesn't start the watcher automatically.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -40,10 +40,10 @@
<parameter>callback</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -51,9 +51,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data associated with the watcher.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -61,18 +61,18 @@
<parameter>priority</parameter>
</term>
<listitem>
<para>
<simpara>
<link linkend="ev.constants.watcher-pri">Watcher priority</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns EvFork(stopped) object on success.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

22
reference/ev/evidle.xml
View File

@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.evidle" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.evidle" role="class">
<title>The EvIdle class</title>
<titleabbrev>EvIdle</titleabbrev>
<partintro>
<!-- {{{ EvIdle intro -->
<section xml:id="evidle.intro">
&reftitle.intro;
<para>
<simpara>
<classname>EvIdle</classname>
watchers trigger events when no other events of the same or higher
priority are pending (
@@ -18,8 +18,8 @@
watchers do not count as receiving
<emphasis>events</emphasis>
).
</para>
<para>
</simpara>
<simpara>
Thus, as long as the process is busy handling sockets or timeouts(or even
signals) of the same or higher priority it will not be triggered. But when
the process is in idle(or only lower-priority watchers are pending), the
@@ -27,8 +27,8 @@
watchers are being called once per event loop iteration - until stopped,
that is, or the process receives more events and becomes busy again with
higher priority stuff.
</para>
<para>
</simpara>
<simpara>
Apart from keeping the process non-blocking(which is a useful on its own
sometimes),
<classname>EvIdle</classname>
@@ -36,14 +36,14 @@
<emphasis>"pseudo-background processing"</emphasis>,
or delay processing stuff to after the event loop has handled all
outstanding events.
</para>
<para>
</simpara>
<simpara>
The most noticeable effect is that as long as any
<emphasis>idle</emphasis>
watchers are active, the process will
<emphasis>not</emphasis>
block when waiting for new events.
</para>
</simpara>
</section>
<!-- }}} -->
<section xml:id="evidle.synopsis">
@@ -67,12 +67,12 @@
<!-- }}} -->
<!--<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>-->
<classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('evwatcher.synopsis')/descendant::db:fieldsynopsis)" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('evwatcher.synopsis')/descendant::db:fieldsynopsis)"/>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evidle')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evidle')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evwatcher')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evwatcher')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
</classsynopsis>
<!-- }}} -->
</section>

18
reference/ev/evidle/construct.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evidle.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evidle.construct">
<refnamediv>
<refname>EvIdle::__construct</refname>
<refpurpose>Constructs the EvIdle watcher object</refpurpose>
@@ -23,9 +23,9 @@
<parameter>priority</parameter>
</methodparam>
</constructorsynopsis>
<para>
<simpara>
Constructs the EvIdle watcher object and starts the watcher automatically.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -35,10 +35,10 @@
<parameter>callback</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -46,9 +46,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data associated with the watcher.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -56,9 +56,9 @@
<parameter>priority</parameter>
</term>
<listitem>
<para>
<simpara>
<link linkend="ev.constants.watcher-pri">Watcher priority</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>

22
reference/ev/evidle/createstopped.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evidle.createstopped" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evidle.createstopped">
<refnamediv>
<refname>EvIdle::createStopped</refname>
<refpurpose>Creates instance of a stopped EvIdle watcher object</refpurpose>
@@ -26,11 +26,11 @@
<parameter>priority</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
The same as
<methodname>EvIdle::__construct</methodname>,
but doesn't start the watcher automatically.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -40,10 +40,10 @@
<parameter>callback</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -51,9 +51,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data associated with the watcher.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -61,18 +61,18 @@
<parameter>priority</parameter>
</term>
<listitem>
<para>
<simpara>
<link linkend="ev.constants.watcher-pri">Watcher priority</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns EvIdle object on success.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

30
reference/ev/evio.xml
View File

@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.evio" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.evio" role="class">
<title>The EvIo class</title>
<titleabbrev>EvIo</titleabbrev>
<partintro>
<!-- {{{ EvIo intro -->
<section xml:id="evio.intro">
&reftitle.intro;
<para>
<simpara>
<classname>EvIo</classname>
watchers check whether a file descriptor(or socket, or a stream castable
to numeric file descriptor) is readable or writable in each iteration of
@@ -17,14 +17,14 @@
<emphasis>level-triggering</emphasis>
because events are kept receiving as long as the condition persists. To
stop receiving events just stop the watcher.
</para>
<para>
</simpara>
<simpara>
The number of read and/or write event watchers per
<parameter>fd</parameter>
is unlimited. Setting all file descriptors to non-blocking mode is also
usually a good idea(but not required).
</para>
<para>
</simpara>
<simpara>
Another thing to watch out for is that it is quite easy to receive false
readiness notifications, i.e. the callback might be called with
<constant>Ev::READ</constant>
@@ -37,18 +37,18 @@
<constant>EAGAIN</constant>
(or similar) is far preferable to a program hanging until some data
arrives.
</para>
<para>
</simpara>
<simpara>
If for some reason it is impossible to run the
<parameter>fd</parameter>
in non-blocking mode, then separately re-test whether a file descriptor is
really ready. Some people additionally use
<constant>SIGALRM</constant>
and an interval timer, just to be sure thry won't block infinitely.
</para>
<para>
</simpara>
<simpara>
Always consider using non-blocking mode.
</para>
</simpara>
</section>
<!-- }}} -->
<section xml:id="evio.synopsis">
@@ -80,12 +80,12 @@
<varname linkend="evio.props.events">events</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('evwatcher.synopsis')/descendant::db:fieldsynopsis)" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('evwatcher.synopsis')/descendant::db:fieldsynopsis)"/>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evio')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evio')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evwatcher')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evwatcher')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
</classsynopsis>
<!-- }}} -->
</section>
@@ -98,7 +98,7 @@
<varname>fd</varname>
</term>
<listitem>
<para></para>
<simpara/>
</listitem>
</varlistentry>
<varlistentry xml:id="evio.props.events">
@@ -106,7 +106,7 @@
<varname>events</varname>
</term>
<listitem>
<para></para>
<simpara/>
</listitem>
</varlistentry>
</variablelist>

26
reference/ev/evio/construct.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evio.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evio.construct">
<refnamediv>
<refname>EvIo::__construct</refname>
<refpurpose>Constructs EvIo watcher object</refpurpose>
@@ -31,9 +31,9 @@
<parameter>priority</parameter>
</methodparam>
</constructorsynopsis>
<para>
<simpara>
Constructs EvIo watcher object and starts the watcher automatically.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -43,11 +43,11 @@
<parameter>fd</parameter>
</term>
<listitem>
<para>
<simpara>
Can be a stream opened with
<function>fopen</function>
or similar functions, numeric file descriptor, or socket.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -55,13 +55,13 @@
<parameter>events</parameter>
</term>
<listitem>
<para>
<simpara>
<constant>Ev::READ</constant>
and/or
<constant>Ev::WRITE</constant>.
See
<link linkend="ev.constants.watcher-revents">the bit masks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -69,10 +69,10 @@
<parameter>callback</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -80,9 +80,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data associated with the watcher.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -90,9 +90,9 @@
<parameter>priority</parameter>
</term>
<listitem>
<para>
<simpara>
<link linkend="ev.constants.watcher-pri">Watcher priority</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>

36
reference/ev/evio/createstopped.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evio.createstopped" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evio.createstopped">
<refnamediv>
<refname>EvIo::createStopped</refname>
<refpurpose>Create stopped EvIo watcher object</refpurpose>
@@ -25,24 +25,22 @@
<type>callable</type>
<parameter>callback</parameter>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>int</type>
<parameter>priority</parameter>
<initializer>0</initializer>
</methodparam>
</methodsynopsis>
<para>
<simpara>
The same as
<methodname>EvIo::__construct</methodname>,
but doesn't start the watcher automatically.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -52,10 +50,10 @@
<parameter>fd</parameter>
</term>
<listitem>
<para>
<simpara>
The same as for
<methodname>EvIo::__construct</methodname>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -63,10 +61,10 @@
<parameter>events</parameter>
</term>
<listitem>
<para>
<simpara>
The same as for
<methodname>EvIo::__construct</methodname>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -74,10 +72,10 @@
<parameter>callback</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -85,9 +83,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data associated with the watcher.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -95,18 +93,18 @@
<parameter>priority</parameter>
</term>
<listitem>
<para>
<simpara>
<link linkend="ev.constants.watcher-pri">Watcher priority</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns EvIo object on success.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

18
reference/ev/evio/set.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evio.set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evio.set">
<refnamediv>
<refname>EvIo::set</refname>
<refpurpose>Configures the watcher</refpurpose>
@@ -20,9 +20,9 @@
<parameter>events</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Configures the EvIo watcher
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -32,10 +32,10 @@
<parameter>fd</parameter>
</term>
<listitem>
<para>
<simpara>
The same as for
<methodname>EvIo::__construct</methodname>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -43,19 +43,19 @@
<parameter>events</parameter>
</term>
<listitem>
<para>
<simpara>
The same as for
<methodname>EvIo::__construct</methodname>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

56
reference/ev/evloop.xml
View File

@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.evloop" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.evloop" role="class">
<title>The EvLoop class</title>
<titleabbrev>EvLoop</titleabbrev>
<partintro>
<!-- {{{ EvLoop intro -->
<section xml:id="evloop.intro">
&reftitle.intro;
<para>
<simpara>
Represents an event loop that is always distinct from the
<emphasis>default
loop</emphasis>.
@@ -16,13 +16,13 @@
it cannot handle
<classname>EvChild</classname>
watchers.
</para>
<para>
</simpara>
<simpara>
Having threads we have to create a loop per thread, and use the
<emphasis>default loop</emphasis>
in the parent thread.
</para>
<para>
</simpara>
<simpara>
The
<emphasis>default event loop</emphasis>
is initialized automatically by
@@ -32,7 +32,7 @@
class, or via
<methodname>EvLoop::defaultLoop</methodname>
method.
</para>
</simpara>
</section>
<!-- }}} -->
<section xml:id="evloop.synopsis">
@@ -99,9 +99,9 @@
<varname>data</varname>
</term>
<listitem>
<para>
<simpara>
Custom data attached to loop
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="evloop.props.backend">
@@ -109,12 +109,12 @@
<varname>backend</varname>
</term>
<listitem>
<para>
<simpara>
<emphasis>Readonly</emphasis>.
The
<link linkend="ev.constants.watcher-backends">backend flags</link>
indicating the event backend in use.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="evloop.props.is-default-loop">
@@ -122,10 +122,10 @@
<varname>is_default_loop</varname>
</term>
<listitem>
<para>
<simpara>
<emphasis>Readonly</emphasis>.
&true; if it is the default event loop.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="evloop.props.iteration">
@@ -133,10 +133,10 @@
<varname>iteration</varname>
</term>
<listitem>
<para>
<simpara>
The current iteration count of the loop. See
<methodname>Ev::iteration</methodname>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="evloop.props.pending">
@@ -144,11 +144,11 @@
<varname>pending</varname>
</term>
<listitem>
<para>
<simpara>
The number of pending watchers.
<literal>0</literal>
indicates that there are no watchers pending.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="evloop.props.io-interval">
@@ -156,7 +156,7 @@
<varname>io_interval</varname>
</term>
<listitem>
<para>
<simpara>
Higher
<varname>io_interval</varname>
allows
@@ -184,13 +184,12 @@
usually doesn't make much sense to set it to a lower value than
<literal>0.01</literal>,
as this approaches the timing granularity of most systems.
</para>
<para>
</simpara>
<simpara>
See also
<link
xlink:href="http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_EVENT_LOOPS">FUNCTIONS
<link xlink:href="http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_EVENT_LOOPS">FUNCTIONS
CONTROLLING EVENT LOOPS</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="evloop.props.timeout-interval">
@@ -198,7 +197,7 @@
<varname>timeout_interval</varname>
</term>
<listitem>
<para>
<simpara>
Higher
<varname>timeout_interval</varname>
allows
@@ -210,10 +209,9 @@
not introduce any overhead in
<emphasis>libev</emphasis>.
See also
<link
xlink:href="http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_EVENT_LOOPS">FUNCTIONS
<link xlink:href="http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_EVENT_LOOPS">FUNCTIONS
CONTROLLING EVENT LOOPS</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="evloop.props.depth">
@@ -221,10 +219,10 @@
<varname>depth</varname>
</term>
<listitem>
<para>
<simpara>
The recursion depth. See
<methodname>Ev::depth</methodname>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>

12
reference/ev/evloop/backend.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.backend" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.backend">
<refnamediv>
<refname>EvLoop::backend</refname>
<refpurpose>Returns an integer describing the backend used by libev</refpurpose>
@@ -11,13 +11,13 @@
<modifier>public</modifier>
<type>int</type>
<methodname>EvLoop::backend</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
The same as
<methodname>Ev::backend</methodname>,
but for the loop instance.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -25,10 +25,10 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an integer describing the backend used by libev. See
<methodname>Ev::backend</methodname>.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

14
reference/ev/evloop/check.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.check" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.check">
<refnamediv>
<refname>EvLoop::check</refname>
<refpurpose>Creates EvCheck object associated with the current event loop
@@ -26,22 +26,22 @@
<parameter>priority</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Creates EvCheck object associated with the current event loop instance.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<simpara>
All parameters have the same meaning as for
<methodname>EvCheck::__construct</methodname>
</para>
</simpara>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns EvCheck object on success.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

14
reference/ev/evloop/child.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.child" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.child">
<refnamediv>
<refname>EvLoop::child</refname>
<refpurpose>Creates EvChild object associated with the current event loop</refpurpose>
@@ -33,22 +33,22 @@
<parameter>priority</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Creates EvChild object associated with the current event loop.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<simpara>
All parameters have the same meaning as for
<methodname>EvChild::__construct</methodname>
</para>
</simpara>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns EvChild object on success.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

31
reference/ev/evloop/construct.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.construct">
<refnamediv>
<refname>EvLoop::__construct</refname>
<refpurpose>Constructs the event loop object</refpurpose>
@@ -14,28 +14,25 @@
<type>int</type>
<parameter>flags</parameter>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>NULL</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>float</type>
<parameter>io_interval</parameter>
<initializer>0.0</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>float</type>
<parameter>timeout_interval</parameter>
<initializer>0.0</initializer>
</methodparam>
</constructorsynopsis>
<para>
<simpara>
Constructs the event loop object.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -45,10 +42,10 @@
<parameter>flags</parameter>
</term>
<listitem>
<para>
<simpara>
One of the
<link linkend="ev.constants.loop-flags">event loop flags</link>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -56,9 +53,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data associated with the loop.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -66,10 +63,10 @@
<parameter>io_interval</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="evloop.props.io-interval">io_interval</link>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -77,10 +74,10 @@
<parameter>timeout_interval</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="evloop.props.timeout-interval">timeout_interval</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>

38
reference/ev/evloop/defaultloop.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.defaultloop" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.defaultloop">
<refnamediv>
<refname>EvLoop::defaultLoop</refname>
<refpurpose>Returns or creates the default event loop</refpurpose>
@@ -12,38 +12,34 @@
<modifier>static</modifier>
<type>EvLoop</type>
<methodname>EvLoop::defaultLoop</methodname>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>int</type>
<parameter>flags</parameter>
<initializer>Ev::FLAG_AUTO</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>NULL</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>float</type>
<parameter>io_interval</parameter>
<initializer>0.</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>float</type>
<parameter>timeout_interval</parameter>
<initializer>0.</initializer>
</methodparam>
</methodsynopsis>
<para>
<simpara>
If the default event loop is not created,
<methodname>EvLoop::defaultLoop</methodname>
creates it with the specified parameters. Otherwise, it just returns the
object representing previously created instance ignoring all the
parameters.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -53,10 +49,10 @@
<parameter>flags</parameter>
</term>
<listitem>
<para>
<simpara>
One of the
<link linkend="ev.constants.loop-flags">event loop flags</link>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -64,9 +60,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data to associate with the loop.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -74,10 +70,10 @@
<parameter>io_collect_interval</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="evloop.props.io-interval">io_interval</link>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -85,19 +81,19 @@
<parameter>timeout_collect_interval</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="evloop.props.timeout-interval">timeout_interval</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns EvLoop object on success.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

14
reference/ev/evloop/embed.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.embed" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.embed">
<refnamediv>
<refname>EvLoop::embed</refname>
<refpurpose>Creates an instance of EvEmbed watcher associated
@@ -30,26 +30,26 @@
<parameter>priority</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Creates an instance of
<classname>EvEmbed</classname>
watcher associated with the current
<classname>EvLoop</classname>
object.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<simpara>
All parameters have the same meaning as for
<methodname>EvEmbed::__construct</methodname>.
</para>
</simpara>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns EvEmbed object on success.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

20
reference/ev/evloop/fork.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.fork" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.fork">
<refnamediv>
<refname>EvLoop::fork</refname>
<refpurpose>Creates EvFork watcher object associated with the current event
@@ -17,36 +17,34 @@
<type>callable</type>
<parameter>callback</parameter>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>int</type>
<parameter>priority</parameter>
<initializer>0</initializer>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Creates EvFork watcher object associated with the current event loop
instance
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<simpara>
All parameters have the same meaning as for
<methodname>EvFork::__construct</methodname>
</para>
</simpara>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns EvFork object on success.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

20
reference/ev/evloop/idle.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.idle" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.idle">
<refnamediv>
<refname>EvLoop::idle</refname>
<refpurpose>Creates EvIdle watcher object associated with the current event
@@ -17,36 +17,34 @@
<type>callable</type>
<parameter>callback</parameter>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>int</type>
<parameter>priority</parameter>
<initializer>0</initializer>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Creates EvIdle watcher object associated with the current event loop
instance
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<simpara>
All the parameters have the same meaning as for
<methodname>EvIdle::__construct</methodname>
</para>
</simpara>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns EvIdle object on success.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

12
reference/ev/evloop/invokepending.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.invokepending" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.invokepending">
<refnamediv>
<refname>EvLoop::invokePending</refname>
<refpurpose>Invoke all pending watchers while resetting their pending state</refpurpose>
@@ -11,11 +11,11 @@
<modifier>public</modifier>
<type>void</type>
<methodname>EvLoop::invokePending</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Invoke all pending watchers while resetting their pending state.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -23,9 +23,9 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

20
reference/ev/evloop/io.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.io" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.io">
<refnamediv>
<refname>EvLoop::io</refname>
<refpurpose>Create EvIo watcher object associated with the current event
@@ -25,35 +25,33 @@
<type>callable</type>
<parameter>callback</parameter>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>int</type>
<parameter>priority</parameter>
<initializer>0</initializer>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Create EvIo watcher object associated with the current event loop instance.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<simpara>
All parameters have the same meaning as for
<methodname>EvIo::__construct</methodname>
</para>
</simpara>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns EvIo object on success.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

15
reference/ev/evloop/loopfork.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.loopfork" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.loopfork">
<refnamediv>
<refname>EvLoop::loopFork</refname>
<refpurpose>Must be called after a fork</refpurpose>
@@ -11,9 +11,9 @@
<modifier>public</modifier>
<type>void</type>
<methodname>EvLoop::loopFork</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Must be called after a
<emphasis>fork</emphasis>
in the child, before entering or continuing the event loop. An alternative
@@ -21,11 +21,10 @@
<constant>Ev::FLAG_FORKCHECK</constant>
which calls this function automatically, at some performance loss (refer to
the
<link
xlink:href="http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_EVENT_LOOPS">libev
<link xlink:href="http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_EVENT_LOOPS">libev
documentation</link>
).
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -33,9 +32,9 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

12
reference/ev/evloop/now.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.now" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.now">
<refnamediv>
<refname>EvLoop::now</refname>
<refpurpose>Returns the current "event loop time"</refpurpose>
@@ -11,15 +11,15 @@
<modifier>public</modifier>
<type>float</type>
<methodname>EvLoop::now</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns the current "event loop time", which is the time the event loop
received events and started processing them. This timestamp does not change
as long as callbacks are being processed, and this is also the base time
used for relative timers. You can treat it as the timestamp of the event
occurring(or more correctly, libev finding out about it).
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -27,9 +27,9 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns time of the event loop in (fractional) seconds.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

12
reference/ev/evloop/nowupdate.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.nowupdate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.nowupdate">
<refnamediv>
<refname>EvLoop::nowUpdate</refname>
<refpurpose>Establishes the current time by querying the kernel, updating the time
@@ -12,16 +12,16 @@
<modifier>public</modifier>
<type>void</type>
<methodname>EvLoop::nowUpdate</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Establishes the current time by querying the kernel, updating the time
returned by
<methodname>EvLoop::now</methodname>
in the progress. This is a costly operation and is usually done
automatically within
<methodname>EvLoop::run</methodname>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -29,9 +29,9 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

20
reference/ev/evloop/periodic.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.periodic" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.periodic">
<refnamediv>
<refname>EvLoop::periodic</refname>
<refpurpose>Creates EvPeriodic watcher object associated with the current
@@ -25,36 +25,34 @@
<type>callable</type>
<parameter>callback</parameter>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>int</type>
<parameter>priority</parameter>
<initializer>0</initializer>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Creates EvPeriodic watcher object associated with the current event loop
instance
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<simpara>
All parameters have the same maening as for
<methodname>EvPeriodic::__construct</methodname>
</para>
</simpara>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns EvPeriodic object on success.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

20
reference/ev/evloop/prepare.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.prepare" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.prepare">
<refnamediv>
<refname>EvLoop::prepare</refname>
<refpurpose>Creates EvPrepare watcher object associated with the current
@@ -17,36 +17,34 @@
<type>callable</type>
<parameter>callback</parameter>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>int</type>
<parameter>priority</parameter>
<initializer>0</initializer>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Creates EvPrepare watcher object associated with the current event loop
instance
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<simpara>
All parameters have the same maening as for
<methodname>EvPrepare</methodname>
</para>
</simpara>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns EvPrepare object on success
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

12
reference/ev/evloop/resume.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.resume" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.resume">
<refnamediv>
<refname>EvLoop::resume</refname>
<refpurpose>Resume previously suspended default event loop</refpurpose>
@@ -11,14 +11,14 @@
<modifier>public</modifier>
<type>void</type>
<methodname>EvLoop::resume</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
<methodname>EvLoop::suspend</methodname>
and
<methodname>EvLoop::resume</methodname>
methods suspend and resume a loop correspondingly.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -26,9 +26,9 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

17
reference/ev/evloop/run.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.run" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.run">
<refnamediv>
<refname>EvLoop::run</refname>
<refpurpose>Begin checking for events and calling callbacks for the loop</refpurpose>
@@ -11,14 +11,13 @@
<modifier>public</modifier>
<type>void</type>
<methodname>EvLoop::run</methodname>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>int</type>
<parameter>flags</parameter>
<initializer>0</initializer>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Begin checking for events and calling callbacks for the current event loop.
Returns when a callback calls
<methodname>Ev::stop</methodname>
@@ -29,7 +28,7 @@
value can generally be interpreted as
<emphasis>if &true;, there is more work left
to do</emphasis>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -79,20 +78,20 @@
</tgroup>
</table>
</para>
<para>
<simpara>
See
<link linkend="ev.constants.run-flags">the run flag
constants</link>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

20
reference/ev/evloop/signal.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.signal" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.signal">
<refnamediv>
<refname>EvLoop::signal</refname>
<refpurpose>Creates EvSignal watcher object associated with the current
@@ -21,36 +21,34 @@
<type>callable</type>
<parameter>callback</parameter>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>int</type>
<parameter>priority</parameter>
<initializer>0</initializer>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Creates EvSignal watcher object associated with the current event loop
instance
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<simpara>
All parameters have the same meaning as for
<methodname>EvSignal::__construct</methodname>
</para>
</simpara>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns EvSignal object on success
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

20
reference/ev/evloop/stat.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.stat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.stat">
<refnamediv>
<refname>EvLoop::stat</refname>
<refpurpose>Creates EvStat watcher object associated with the current event
@@ -25,36 +25,34 @@
<type>callable</type>
<parameter>callback</parameter>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>int</type>
<parameter>priority</parameter>
<initializer>0</initializer>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Creates EvStat watcher object associated with the current event loop
instance
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<simpara>
All parameters have the same meaning as for
<methodname>EvSignal::__construct</methodname>
</para>
</simpara>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns EvStat object on success
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

17
reference/ev/evloop/stop.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.stop" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.stop">
<refnamediv>
<refname>EvLoop::stop</refname>
<refpurpose>Stops the event loop</refpurpose>
@@ -16,9 +16,9 @@
<parameter>how</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Stops the event loop
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -28,21 +28,20 @@
<parameter>how</parameter>
</term>
<listitem>
<para>
<simpara>
One of
<emphasis>Ev::BREAK_*</emphasis>
<link
linkend="ev.constants.break-flags">constants</link>.
</para>
<link linkend="ev.constants.break-flags">constants</link>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

12
reference/ev/evloop/suspend.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.suspend" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.suspend">
<refnamediv>
<refname>EvLoop::suspend</refname>
<refpurpose>Suspend the loop</refpurpose>
@@ -11,14 +11,14 @@
<modifier>public</modifier>
<type>void</type>
<methodname>EvLoop::suspend</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
<methodname>EvLoop::suspend</methodname>
and
<methodname>EvLoop::resume</methodname>
methods suspend and resume a loop correspondingly.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -26,9 +26,9 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

20
reference/ev/evloop/timer.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.timer" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.timer">
<refnamediv>
<refname>EvLoop::timer</refname>
<refpurpose>Creates EvTimer watcher object associated with the current event
@@ -25,36 +25,34 @@
<type>callable</type>
<parameter>callback</parameter>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>int</type>
<parameter>priority</parameter>
<initializer>0</initializer>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Creates EvTimer watcher object associated with the current event loop
instance
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<simpara>
All parameters have the same meaning as for
<methodname>EvTimer::__construct</methodname>
</para>
</simpara>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns EvTimer object on success
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

12
reference/ev/evloop/verify.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.verify" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.verify">
<refnamediv>
<refname>EvLoop::verify</refname>
<refpurpose>Performs internal consistency checks(for debugging)</refpurpose>
@@ -11,13 +11,13 @@
<modifier>public</modifier>
<type>void</type>
<methodname>EvLoop::verify</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Performs internal consistency checks(for debugging
<emphasis>libev</emphasis>)
and abort the program if any data structures were found to be corrupted.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -25,9 +25,9 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

30
reference/ev/evperiodic.xml
View File

@@ -1,16 +1,16 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.evperiodic" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.evperiodic" role="class">
<title>The EvPeriodic class</title>
<titleabbrev>EvPeriodic</titleabbrev>
<partintro>
<!-- {{{ EvPeriodic intro -->
<section xml:id="evperiodic.intro">
&reftitle.intro;
<para>
<simpara>
Periodic watchers are also timers of a kind, but they are very versatile.
</para>
<para>
</simpara>
<simpara>
Unlike
<classname>EvTimer</classname>,
<classname>EvPeriodic</classname>
@@ -18,8 +18,8 @@
that passes) but on wall clock time(absolute time, calendar or clock). The
difference is that wall clock time can run faster or slower than real
time, and time jumps are not uncommon(e.g. when adjusting it).
</para>
<para>
</simpara>
<simpara>
<classname>EvPeriodic</classname>
watcher can be configured to trigger after some specific point in time.
For example, if an
@@ -37,8 +37,8 @@
which would still trigger roughly
<literal>10</literal>
seconds after starting it as it uses a relative timeout).
</para>
<para>
</simpara>
<simpara>
As with timers, the callback is guaranteed to be invoked only when the
point in time where it is supposed to trigger has passed. If multiple
timers become ready during the same loop iteration then the ones with
@@ -46,7 +46,7 @@
(but this is no longer true when a callback calls
<methodname>EvLoop::run</methodname>
recursively).
</para>
</simpara>
</section>
<!-- }}} -->
<section xml:id="evperiodic.synopsis">
@@ -78,12 +78,12 @@
<varname linkend="evperiodic.props.interval">interval</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('evwatcher.synopsis')/descendant::db:fieldsynopsis)" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('evwatcher.synopsis')/descendant::db:fieldsynopsis)"/>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evperiodic')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evperiodic')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evwatcher')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evwatcher')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
</classsynopsis>
<!-- }}} -->
</section>
@@ -96,14 +96,14 @@
<varname>offset</varname>
</term>
<listitem>
<para>
<simpara>
When repeating, this contains the offset value, otherwise this is the
absolute point in time(the offset value passed to
<methodname>EvPeriodic::set</methodname>,
although
<emphasis>libev</emphasis>
might modify this value for better numerical stability).
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="evperiodic.props.interval">
@@ -111,12 +111,12 @@
<varname>interval</varname>
</term>
<listitem>
<para>
<simpara>
The current interval value. Can be modified any time, but changes only
take effect when the periodic timer fires or
<methodname>EvPeriodic::again</methodname>
is being called.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>

12
reference/ev/evperiodic/again.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evperiodic.again" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evperiodic.again">
<refnamediv>
<refname>EvPeriodic::again</refname>
<refpurpose>Simply stops and restarts the periodic watcher again</refpurpose>
@@ -11,12 +11,12 @@
<modifier>public</modifier>
<type>void</type>
<methodname>EvPeriodic::again</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Simply stops and restarts the periodic watcher again. This is only useful
when attributes are changed.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -24,9 +24,9 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

12
reference/ev/evperiodic/at.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evperiodic.at" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evperiodic.at">
<refnamediv>
<refname>EvPeriodic::at</refname>
<refpurpose>Returns the absolute time that this
@@ -12,16 +12,16 @@
<modifier>public</modifier>
<type>float</type>
<methodname>EvPeriodic::at</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
When the watcher is active, returns the absolute time that this watcher is
supposed to trigger next. This is not the same as the offset argument to
<methodname>EvPeriodic::set</methodname>
or
<methodname>EvPeriodic::__construct</methodname>,
but indeed works even in interval mode.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -29,10 +29,10 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the absolute time this watcher is supposed to trigger next in
seconds.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

36
reference/ev/evperiodic/construct.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evperiodic.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evperiodic.construct">
<refnamediv>
<refname>EvPeriodic::__construct</refname>
<refpurpose>Constructs EvPeriodic watcher object</refpurpose>
@@ -26,24 +26,22 @@
<type>callable</type>
<parameter>callback</parameter>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>int</type>
<parameter>priority</parameter>
<initializer>0</initializer>
</methodparam>
</constructorsynopsis>
<para>
<simpara>
Constructs EvPeriodic watcher object and starts it automatically.
<methodname>EvPeriodic::createStopped</methodname>
method creates stopped periodic watcher.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -53,10 +51,10 @@
<parameter>offset</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.periodic-modes">Periodic watcher operation modes</link>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -64,10 +62,10 @@
<parameter>interval</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.periodic-modes">Periodic watcher operation modes</link>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -75,11 +73,11 @@
<parameter>reschedule_cb</parameter>
</term>
<listitem>
<para>
<simpara>
Reschedule callback. You can pass &null;. See
<link linkend="ev.periodic-modes">Periodic watcher operation
modes</link>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -87,10 +85,10 @@
<parameter>callback</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -98,9 +96,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data associated with the watcher.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -108,9 +106,9 @@
<parameter>priority</parameter>
</term>
<listitem>
<para>
<simpara>
<link linkend="ev.constants.watcher-pri">Watcher priority</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>

40
reference/ev/evperiodic/createstopped.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evperiodic.createstopped" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evperiodic.createstopped">
<refnamediv>
<refname>EvPeriodic::createStopped</refname>
<refpurpose>Create a stopped EvPeriodic watcher</refpurpose>
@@ -29,24 +29,22 @@
<type>callable</type>
<parameter>callback</parameter>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>int</type>
<parameter>priority</parameter>
<initializer>0</initializer>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Create EvPeriodic object. Unlike
<methodname>EvPeriodic::__construct</methodname>
this method doesn&apos;t start the watcher automatically.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -56,10 +54,10 @@
<parameter>offset</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.periodic-modes">Periodic watcher operation modes</link>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -67,10 +65,10 @@
<parameter>interval</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.periodic-modes">Periodic watcher operation modes</link>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -78,11 +76,11 @@
<parameter>reschedule_cb</parameter>
</term>
<listitem>
<para>
<simpara>
Reschedule callback. You can pass &null;. See
<link linkend="ev.periodic-modes">Periodic watcher operation
modes</link>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -90,10 +88,10 @@
<parameter>callback</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -101,9 +99,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data associated with the watcher.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -111,18 +109,18 @@
<parameter>priority</parameter>
</term>
<listitem>
<para>
<simpara>
<link linkend="ev.constants.watcher-pri">Watcher priority</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns EvPeriodic watcher object on success.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

18
reference/ev/evperiodic/set.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evperiodic.set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evperiodic.set">
<refnamediv>
<refname>EvPeriodic::set</refname>
<refpurpose>Configures the watcher</refpurpose>
@@ -20,9 +20,9 @@
<parameter>interval</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
(Re-)Configures EvPeriodic watcher
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -32,12 +32,12 @@
<parameter>offset</parameter>
</term>
<listitem>
<para>
<simpara>
The same meaning as for
<methodname>EvPeriodic::__construct</methodname>.
See
<link linkend="ev.periodic-modes">Periodic watcher operation modes</link>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -45,21 +45,21 @@
<parameter>interval</parameter>
</term>
<listitem>
<para>
<simpara>
The same meaning as for
<methodname>EvPeriodic::__construct</methodname>.
See
<link linkend="ev.periodic-modes">Periodic watcher operation modes</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

18
reference/ev/evprepare/construct.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evprepare.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evprepare.construct">
<refnamediv>
<refname>EvPrepare::__construct</refname>
<refpurpose>Constructs EvPrepare watcher object</refpurpose>
@@ -23,11 +23,11 @@
<parameter>priority</parameter>
</methodparam>
</constructorsynopsis>
<para>
<simpara>
Constructs EvPrepare watcher object. And starts the watcher automatically.
If need a stopped watcher consider using
<methodname>EvPrepare::createStopped</methodname>
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -37,10 +37,10 @@
<parameter>callback</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -48,9 +48,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data associated with the watcher.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -58,9 +58,9 @@
<parameter>priority</parameter>
</term>
<listitem>
<para>
<simpara>
<link linkend="ev.constants.watcher-pri">Watcher priority</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>

28
reference/ev/evprepare/createstopped.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evprepare.createstopped" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evprepare.createstopped">
<refnamediv>
<refname>EvPrepare::createStopped</refname>
<refpurpose>Creates a stopped instance of EvPrepare watcher</refpurpose>
@@ -17,24 +17,22 @@
<type>callable</type>
<parameter>callback</parameter>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>int</type>
<parameter>priority</parameter>
<initializer>0</initializer>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Creates a stopped instance of EvPrepare watcher. Unlike
<methodname>EvPrepare::__construct</methodname>,
this method doesn&apos; start the watcher automatically.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -44,10 +42,10 @@
<parameter>callback</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -55,9 +53,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data associated with the watcher.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -65,18 +63,18 @@
<parameter>priority</parameter>
</term>
<listitem>
<para>
<simpara>
<link linkend="ev.constants.watcher-pri">Watcher priority</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return EvPrepare object on success.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

22
reference/ev/evsignal.xml
View File

@@ -1,21 +1,21 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.evsignal" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.evsignal" role="class">
<title>The EvSignal class</title>
<titleabbrev>EvSignal</titleabbrev>
<partintro>
<!-- {{{ EvSignal intro -->
<section xml:id="evsignal.intro">
&reftitle.intro;
<para>
<simpara>
<classname>EvSignal</classname>
watchers will trigger an event when the process receives a specific signal
one or more times. Even though signals are very asynchronous,
<emphasis>libev</emphasis>
will try its best to deliver signals synchronously, i.e. as part of the
normal event processing, like any other event.
</para>
<para>
</simpara>
<simpara>
There is no limit for the number of watchers for the same signal, but only
within the same loop, i.e. one can watch for
<constant>SIGINT</constant>
@@ -26,8 +26,8 @@
in both the default loop and another loop at the same time. At the moment,
<constant>SIGCHLD</constant>
is permanently tied to the default loop.
</para>
<para>
</simpara>
<simpara>
If possible and supported,
<emphasis>libev</emphasis>
will install its handlers with
@@ -39,7 +39,7 @@
watcher and unblocked in a
<classname>EvPrepare</classname>
watcher.
</para>
</simpara>
</section>
<!-- }}} -->
<section xml:id="evsignal.synopsis">
@@ -67,12 +67,12 @@
<varname linkend="evsignal.props.signum">signum</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('evwatcher.synopsis')/descendant::db:fieldsynopsis)" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('evwatcher.synopsis')/descendant::db:fieldsynopsis)"/>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evsignal')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evsignal')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evwatcher')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evwatcher')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
</classsynopsis>
<!-- }}} -->
</section>
@@ -85,13 +85,13 @@
<varname>signum</varname>
</term>
<listitem>
<para>
<simpara>
Signal number. See the constants exported by
<emphasis>pcntl</emphasis>
extension. See also
<literal>signal(7)</literal>
man page.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>

28
reference/ev/evsignal/construct.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evsignal.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evsignal.construct">
<refnamediv>
<refname>EvSignal::__construct</refname>
<refpurpose>Constructs EvSignal watcher object</refpurpose>
@@ -18,25 +18,23 @@
<type>callable</type>
<parameter>callback</parameter>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>int</type>
<parameter>priority</parameter>
<initializer>0</initializer>
</methodparam>
</constructorsynopsis>
<para>
<simpara>
Constructs EvSignal watcher object and starts it automatically. For a
stopped periodic watcher consider using
<methodname>EvSignal::createStopped</methodname>
method.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -46,13 +44,13 @@
<parameter>signum</parameter>
</term>
<listitem>
<para>
<simpara>
Signal number. See constants exported by
<emphasis>pcntl</emphasis>
extension. See also
<literal>signal(7)</literal>
man page.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -60,10 +58,10 @@
<parameter>callback</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -71,9 +69,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data associated with the watcher.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -81,9 +79,9 @@
<parameter>priority</parameter>
</term>
<listitem>
<para>
<simpara>
<link linkend="ev.constants.watcher-pri">Watcher priority</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>

32
reference/ev/evsignal/createstopped.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evsignal.createstopped" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evsignal.createstopped">
<refnamediv>
<refname>EvSignal::createStopped</refname>
<refpurpose>Create stopped EvSignal watcher object</refpurpose>
@@ -21,24 +21,22 @@
<type>callable</type>
<parameter>callback</parameter>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>int</type>
<parameter>priority</parameter>
<initializer>0</initializer>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Create stopped EvSignal watcher object. Unlike
<methodname>EvSignal::__construct</methodname>,
this method does&apos;t start the watcher automatically.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -48,13 +46,13 @@
<parameter>signum</parameter>
</term>
<listitem>
<para>
<simpara>
Signal number. See constants exported by
<emphasis>pcntl</emphasis>
extension. See also
<literal>signal(7)</literal>
man page.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -62,10 +60,10 @@
<parameter>callback</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -73,9 +71,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data associated with the watcher.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -83,18 +81,18 @@
<parameter>priority</parameter>
</term>
<listitem>
<para>
<simpara>
<link linkend="ev.constants.watcher-pri">Watcher priority</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns EvSignal object on success.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

14
reference/ev/evsignal/set.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evsignal.set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evsignal.set">
<refnamediv>
<refname>EvSignal::set</refname>
<refpurpose>Configures the watcher</refpurpose>
@@ -16,9 +16,9 @@
<parameter>signum</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Configures the watcher.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -28,19 +28,19 @@
<parameter>signum</parameter>
</term>
<listitem>
<para>
<simpara>
Signal number. The same as for
<methodname>EvSignal::__construct</methodname>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

34
reference/ev/evstat.xml
View File

@@ -1,21 +1,21 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.evstat" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.evstat" role="class">
<title>The EvStat class</title>
<titleabbrev>EvStat</titleabbrev>
<partintro>
<!-- {{{ EvStat intro -->
<section xml:id="evstat.intro">
&reftitle.intro;
<para>
<simpara>
<classname>EvStat</classname>
monitors a file system path for attribute changes. It calls
<emphasis>stat()</emphasis>
on that path in regular intervals (or when the OS signals it changed) and
sees if it changed compared to the last time, invoking the callback if it
did.
</para>
<para>
</simpara>
<simpara>
The path does not need to exist: changing from "path exists" to "path does
not exist" is a status change like any other. The condition "path does not
exist" is signified by the
@@ -23,16 +23,16 @@
item being 0(returned by
<methodname>EvStat::attr</methodname>
method).
</para>
<para>
</simpara>
<simpara>
The path must not end in a slash or contain special components such as
<literal>'.'</literal>
or
<literal>..</literal>.
The path should be absolute: if it is relative and the working directory
changes, then the behaviour is undefined.
</para>
<para>
</simpara>
<simpara>
Since there is no portable change notification interface available, the
portable implementation simply calls
<emphasis>stat()</emphasis>
@@ -47,13 +47,13 @@
will also impose a minimum interval which is currently around
<literal>0.1</literal>,
but that’s usually overkill.
</para>
<para>
</simpara>
<simpara>
This watcher type is not meant for massive numbers of
<classname>EvStat</classname>
watchers, as even with OS-supported change notifications, this can be
resource-intensive.
</para>
</simpara>
</section>
<!-- }}} -->
<section xml:id="evstat.synopsis">
@@ -85,12 +85,12 @@
<varname linkend="evstat.props.interval">interval</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('evwatcher.synopsis')/descendant::db:fieldsynopsis)" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('evwatcher.synopsis')/descendant::db:fieldsynopsis)"/>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evstat')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evstat')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evwatcher')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evwatcher')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
</classsynopsis>
<!-- }}} -->
</section>
@@ -103,7 +103,7 @@
<varname>interval</varname>
</term>
<listitem>
<para>
<simpara>
<emphasis>Readonly</emphasis>.
Hint on how quickly a change is expected to be detected and should
normally be specified as
@@ -111,7 +111,7 @@
to let
<emphasis>libev</emphasis>
choose a suitable value.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="evstat.props.path">
@@ -119,10 +119,10 @@
<varname>path</varname>
</term>
<listitem>
<para>
<simpara>
<emphasis>Readonly</emphasis>.
The path to wait for status changes on.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>

12
reference/ev/evstat/attr.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evstat.attr" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evstat.attr">
<refnamediv>
<refname>EvStat::attr</refname>
<refpurpose>Returns the values most recently detected by Ev</refpurpose>
@@ -11,11 +11,11 @@
<modifier>public</modifier>
<type>array</type>
<methodname>EvStat::attr</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns array of the values most recently detected by Ev
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -121,11 +121,11 @@
</tgroup>
</table>
</para>
<para>
<simpara>
See
<literal>stat(2)</literal>
man page for details.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

32
reference/ev/evstat/construct.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evstat.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evstat.construct">
<refnamediv>
<refname>EvStat::__construct</refname>
<refpurpose>Constructs EvStat watcher object</refpurpose>
@@ -22,22 +22,20 @@
<type>callable</type>
<parameter>callback</parameter>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>int</type>
<parameter>priority</parameter>
<initializer>0</initializer>
</methodparam>
</constructorsynopsis>
<para>
<simpara>
Constructs EvStat watcher object and starts the watcher automatically.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -47,9 +45,9 @@
<parameter>path</parameter>
</term>
<listitem>
<para>
<simpara>
The path to wait for status changes on.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -57,14 +55,14 @@
<parameter>interval</parameter>
</term>
<listitem>
<para>
<simpara>
Hint on how quickly a change is expected to be detected and should
normally be specified as
<literal>0.0</literal>
to let
<emphasis>libev</emphasis>
choose a suitable value.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -72,10 +70,10 @@
<parameter>callback</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -83,9 +81,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data associated with the watcher.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -93,9 +91,9 @@
<parameter>priority</parameter>
</term>
<listitem>
<para>
<simpara>
<link linkend="ev.constants.watcher-pri">Watcher priority</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>

36
reference/ev/evstat/createstopped.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evstat.createstopped" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evstat.createstopped">
<refnamediv>
<refname>EvStat::createStopped</refname>
<refpurpose>Create a stopped EvStat watcher object</refpurpose>
@@ -25,25 +25,23 @@
<type>callable</type>
<parameter>callback</parameter>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>int</type>
<parameter>priority</parameter>
<initializer>0</initializer>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Creates EvStat watcher object, but doesn&apos;t start it
automatically(unlike
<methodname>EvStat::__construct</methodname>
).
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -53,9 +51,9 @@
<parameter>path</parameter>
</term>
<listitem>
<para>
<simpara>
The path to wait for status changes on.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -63,14 +61,14 @@
<parameter>interval</parameter>
</term>
<listitem>
<para>
<simpara>
Hint on how quickly a change is expected to be detected and should
normally be specified as
<literal>0.0</literal>
to let
<emphasis>libev</emphasis>
choose a suitable value.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -78,10 +76,10 @@
<parameter>callback</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -89,9 +87,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data associated with the watcher.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -99,18 +97,18 @@
<parameter>priority</parameter>
</term>
<listitem>
<para>
<simpara>
<link linkend="ev.constants.watcher-pri">Watcher priority</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a stopped EvStat watcher object on success.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

12
reference/ev/evstat/prev.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evstat.prev" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evstat.prev">
<refnamediv>
<refname>EvStat::prev</refname>
<refpurpose>Returns the previous set of values returned by EvStat::attr</refpurpose>
@@ -11,13 +11,13 @@
<modifier>public</modifier>
<type>void</type>
<methodname>EvStat::prev</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Just like
<methodname>EvStat::attr</methodname>,
but returns the previous set of values.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -25,11 +25,11 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an array with the same structure as the array returned by
<methodname>EvStat::attr</methodname>.
The array contains previously detected values.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

18
reference/ev/evstat/set.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evstat.set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evstat.set">
<refnamediv>
<refname>EvStat::set</refname>
<refpurpose>Configures the watcher</refpurpose>
@@ -20,9 +20,9 @@
<parameter>interval</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Configures the watcher.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -32,9 +32,9 @@
<parameter>path</parameter>
</term>
<listitem>
<para>
<simpara>
The path to wait for status changes on.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -42,23 +42,23 @@
<parameter>interval</parameter>
</term>
<listitem>
<para>
<simpara>
Hint on how quickly a change is expected to be detected and should
normally be specified as
<literal>0.0</literal>
to let
<emphasis>libev</emphasis>
choose a suitable value.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

12
reference/ev/evstat/stat.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evstat.stat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evstat.stat">
<refnamediv>
<refname>EvStat::stat</refname>
<refpurpose>Initiates the stat call</refpurpose>
@@ -11,15 +11,15 @@
<modifier>public</modifier>
<type>bool</type>
<methodname>EvStat::stat</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Initiates the stat call(updates internal cache). It stats(using
<literal>lstat</literal>)
the
<varname>path</varname>
specified in the watcher and sets to the values found.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -27,11 +27,11 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns &true; if
<varname>path</varname>
exists. Otherwise &false;.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

34
reference/ev/evtimer.xml
View File

@@ -1,25 +1,25 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.evtimer" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.evtimer" role="class">
<title>The EvTimer class</title>
<titleabbrev>EvTimer</titleabbrev>
<partintro>
<!-- {{{ EvTimer intro -->
<section xml:id="evtimer.intro">
&reftitle.intro;
<para>
<simpara>
<classname>EvTimer</classname>
watchers are simple relative timers that generate an event after a given
time, and optionally repeating in regular intervals after that.
</para>
<para>
</simpara>
<simpara>
The timers are based on real time, that is, if one registers an event that
times out after an hour and resets the system clock to
<emphasis>January last year</emphasis>,
it will still time out after(roughly) one hour. "Roughly" because
detecting time jumps is hard, and some inaccuracies are unavoidable.
</para>
<para>
</simpara>
<simpara>
The callback is guaranteed to be invoked only after its timeout has passed
(not at, so on systems with very low-resolution clocks this might
introduce a small delay). If multiple timers become ready during the same
@@ -28,8 +28,8 @@
no longer true when a callback calls
<methodname>EvLoop::run</methodname>
recursively).
</para>
<para>
</simpara>
<simpara>
The timer itself will do a best-effort at avoiding drift, that is, if a
timer is configured to trigger every
<literal>10</literal>
@@ -40,7 +40,7 @@
<literal>10</literal>
seconds to do) the timer will not fire more than once per event loop
iteration.
</para>
</simpara>
</section>
<!-- }}} -->
<section xml:id="evtimer.synopsis">
@@ -72,12 +72,12 @@
<varname linkend="evtimer.props.remaining">remaining</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('evwatcher.synopsis')/descendant::db:fieldsynopsis)" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('evwatcher.synopsis')/descendant::db:fieldsynopsis)"/>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evtimer')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evtimer')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evwatcher')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evwatcher')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
</classsynopsis>
<!-- }}} -->
</section>
@@ -90,13 +90,13 @@
<varname>repeat</varname>
</term>
<listitem>
<para>
<simpara>
If repeat is
<literal>0.0</literal>,
then it will automatically be stopped once the timeout is reached. If
it is positive, then the timer will automatically be configured to
trigger again every repeat seconds later, until stopped manually.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="evtimer.props.remaining">
@@ -104,12 +104,12 @@
<varname>remaining</varname>
</term>
<listitem>
<para>
<simpara>
Returns the remaining time until a timer fires. If the timer is active,
then this time is relative to the current event loop time, otherwise
it&apos;s the timeout value currently configured.
</para>
<para>
</simpara>
<simpara>
That is, after instanciating an
<classname>EvTimer</classname>
with an
@@ -131,7 +131,7 @@
<literal>7.0</literal>
(likely slightly less as callback invocation takes some time too), and
so on.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>

24
reference/ev/evtimer/again.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evtimer.again" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evtimer.again">
<refnamediv>
<refname>EvTimer::again</refname>
<refpurpose>Restarts the timer watcher</refpurpose>
@@ -11,31 +11,31 @@
<modifier>public</modifier>
<type>void</type>
<methodname>EvTimer::again</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
This will act as if the timer timed out and restart it again if it is
repeating. The exact semantics are:
</para>
</simpara>
<orderedlist>
<listitem>
<para>
<simpara>
if the timer is pending, its pending status is cleared.
</para>
</simpara>
</listitem>
<listitem>
<para>
<simpara>
if the timer is started but non-repeating, stop it (as if it timed out).
</para>
</simpara>
</listitem>
<listitem>
<para>
<simpara>
if the timer is repeating, either start it if necessary (with the
<varname>repeat</varname>
value), or reset the running timer to the
<varname>repeat</varname>
value.
</para>
</simpara>
</listitem>
</orderedlist>
</refsect1>
@@ -45,9 +45,9 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

32
reference/ev/evtimer/construct.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evtimer.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evtimer.construct">
<refnamediv>
<refname>EvTimer::__construct</refname>
<refpurpose>Constructs an EvTimer watcher object</refpurpose>
@@ -22,22 +22,20 @@
<type>callable</type>
<parameter>callback</parameter>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>int</type>
<parameter>priority</parameter>
<initializer>0</initializer>
</methodparam>
</constructorsynopsis>
<para>
<simpara>
Constructs an EvTimer watcher object.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -47,11 +45,11 @@
<parameter>after</parameter>
</term>
<listitem>
<para>
<simpara>
Configures the timer to trigger after
<parameter>after</parameter>
seconds.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -59,13 +57,13 @@
<parameter>repeat</parameter>
</term>
<listitem>
<para>
<simpara>
If repeat is
<literal>0.0</literal>,
then it will automatically be stopped once the timeout is reached. If
it is positive, then the timer will automatically be configured to
trigger again every repeat seconds later, until stopped manually.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -73,10 +71,10 @@
<parameter>callback</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -84,9 +82,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data associated with the watcher.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -94,9 +92,9 @@
<parameter>priority</parameter>
</term>
<listitem>
<para>
<simpara>
<link linkend="ev.constants.watcher-pri">Watcher priority</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>

36
reference/ev/evtimer/createstopped.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evtimer.createstopped" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evtimer.createstopped">
<refnamediv>
<refname>EvTimer::createStopped</refname>
<refpurpose>Creates EvTimer stopped watcher object</refpurpose>
@@ -25,24 +25,22 @@
<type>callable</type>
<parameter>callback</parameter>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<methodparam choice="opt">
<type>int</type>
<parameter>priority</parameter>
<initializer>0</initializer>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Creates EvTimer stopped watcher object. Unlike
<methodname>EvTimer::__construct</methodname>,
this method doesn't start the watcher automatically.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -52,11 +50,11 @@
<parameter>after</parameter>
</term>
<listitem>
<para>
<simpara>
Configures the timer to trigger after
<parameter>after</parameter>
seconds.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -64,13 +62,13 @@
<parameter>repeat</parameter>
</term>
<listitem>
<para>
<simpara>
If repeat is
<literal>0.0</literal>,
then it will automatically be stopped once the timeout is reached. If
it is positive, then the timer will automatically be configured to
trigger again every repeat seconds later, until stopped manually.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -78,10 +76,10 @@
<parameter>callback</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -89,9 +87,9 @@
<parameter>data</parameter>
</term>
<listitem>
<para>
<simpara>
Custom data associated with the watcher.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -99,18 +97,18 @@
<parameter>priority</parameter>
</term>
<listitem>
<para>
<simpara>
<link linkend="ev.constants.watcher-pri">Watcher priority</link>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns EvTimer watcher object on success.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

18
reference/ev/evtimer/set.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evtimer.set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evtimer.set">
<refnamediv>
<refname>EvTimer::set</refname>
<refpurpose>Configures the watcher</refpurpose>
@@ -20,9 +20,9 @@
<parameter>repeat</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Configures the watcher
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -32,11 +32,11 @@
<parameter>after</parameter>
</term>
<listitem>
<para>
<simpara>
Configures the timer to trigger after
<parameter>after</parameter>
seconds.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -44,22 +44,22 @@
<parameter>repeat</parameter>
</term>
<listitem>
<para>
<simpara>
If repeat is
<literal>0.0</literal>,
then it will automatically be stopped once the timeout is reached. If
it is positive, then the timer will automatically be configured to
trigger again every repeat seconds later, until stopped manually.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

22
reference/ev/evwatcher.xml
View File

@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.evwatcher" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.evwatcher" role="class">
<title>The EvWatcher class</title>
<titleabbrev>EvWatcher</titleabbrev>
<partintro>
<!-- {{{ EvWatcher intro -->
<section xml:id="evwatcher.intro">
&reftitle.intro;
<para>
<simpara>
<classname>EvWatcher</classname>
is a base class for all watchers(
<classname>EvCheck</classname>,
@@ -18,7 +18,7 @@
<modifier>abstract</modifier>,
one can&apos;t(and don&apos;t need to) create EvWatcher objects
directly.
</para>
</simpara>
</section>
<!-- }}} -->
<section xml:id="evwatcher.synopsis">
@@ -69,10 +69,10 @@
<varname>is_active</varname>
</term>
<listitem>
<para>
<simpara>
<emphasis>Readonly</emphasis>.
&true; if the watcher is active. &false; otherwise.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="evwatcher.props.data">
@@ -80,9 +80,9 @@
<varname>data</varname>
</term>
<listitem>
<para>
<simpara>
User custom data associated with the watcher
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="evwatcher.props.is-pending">
@@ -90,14 +90,14 @@
<varname>is_pending</varname>
</term>
<listitem>
<para>
<simpara>
<emphasis>Readonly</emphasis>
.&true; if the watcher is pending, i.e. it has outstanding events, but
its callback has not yet been invoked. &false; otherwise. As long, as a
watcher is pending(but not active), one must
<emphasis>not</emphasis>
change its priority.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="evwatcher.props.priority">
@@ -105,7 +105,7 @@
<varname>priority</varname>
</term>
<listitem>
<para>
<simpara>
<type>int</type>
between
<constant>Ev::MINPRI</constant>
@@ -119,7 +119,7 @@
<classname>EvIdle</classname>
watchers provide functionality to suppress invocation when higher
priority events are pending.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>

19
reference/ev/evwatcher/clear.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evwatcher.clear" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evwatcher.clear">
<refnamediv>
<refname>EvWatcher::clear</refname>
<refpurpose>Clear watcher pending status</refpurpose>
@@ -11,9 +11,9 @@
<modifier>public</modifier>
<type>int</type>
<methodname>EvWatcher::clear</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
If the watcher is pending, this method clears its
<varname>pending</varname>
status and returns its
@@ -21,11 +21,11 @@
bitset(as if its callback was invoked). If the watcher isn&apos;t pending
it does nothing and returns
<literal>0</literal>.
</para>
<para>
</simpara>
<simpara>
Sometimes it can be useful to "poll" a watcher instead of waiting for its
callback to be invoked, which can be accomplished with this function.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -33,15 +33,14 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
In case if the watcher is pending, returns
<varname>revents</varname>
bitset as if the
<link
linkend="ev.watcher-callbacks">watcher callback</link>
<link linkend="ev.watcher-callbacks">watcher callback</link>
had been invoked. Otherwise returns
<literal>0</literal>.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

10
reference/ev/evwatcher/construct.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evwatcher.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evwatcher.construct">
<refnamediv>
<refname>EvWatcher::__construct</refname>
<refpurpose>Abstract constructor of a watcher object</refpurpose>
@@ -11,20 +11,20 @@
<modifier>abstract</modifier>
<modifier>public</modifier>
<methodname>EvWatcher::__construct</methodname>
<void />
<void/>
</constructorsynopsis>
<para>
<simpara>
<methodname>EvWatcher::__construct</methodname>
is an abstract constructor of a watcher object implemented in the derived
classes.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

14
reference/ev/evwatcher/feed.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evwatcher.feed" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evwatcher.feed">
<refnamediv>
<refname>EvWatcher::feed</refname>
<refpurpose>Feeds the given revents set into the event loop</refpurpose>
@@ -16,10 +16,10 @@
<parameter>revents</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Feeds the given revents set into the event loop, as if the specified event
had happened for the watcher.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -29,19 +29,19 @@
<parameter>revents</parameter>
</term>
<listitem>
<para>
<simpara>
Bit mask of watcher
<link linkend="ev.constants.watcher-revents">received events</link>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

12
reference/ev/evwatcher/getloop.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evwatcher.getloop" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evwatcher.getloop">
<refnamediv>
<refname>EvWatcher::getLoop</refname>
<refpurpose>Returns the loop responsible for the watcher</refpurpose>
@@ -11,11 +11,11 @@
<modifier>public</modifier>
<type>EvLoop</type>
<methodname>EvWatcher::getLoop</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns the loop responsible for the watcher
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -23,11 +23,11 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns
<classname>EvLoop</classname>
event loop object responsible for the watcher.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

14
reference/ev/evwatcher/invoke.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evwatcher.invoke" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evwatcher.invoke">
<refnamediv>
<refname>EvWatcher::invoke</refname>
<refpurpose>Invokes the watcher callback with the given received events bit
@@ -17,9 +17,9 @@
<parameter>revents</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Invokes the watcher callback with the given received events bit mask.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -29,19 +29,19 @@
<parameter>revents</parameter>
</term>
<listitem>
<para>
<simpara>
Bit mask of watcher
<link linkend="ev.constants.watcher-revents">received events</link>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

22
reference/ev/evwatcher/keepalive.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evwatcher.keepalive" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evwatcher.keepalive">
<refnamediv>
<refname>EvWatcher::keepalive</refname>
<refpurpose>Configures whether to keep the loop from returning</refpurpose>
@@ -16,7 +16,7 @@
<parameter>value</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Configures whether to keep the loop from returning. With keepalive
<parameter>value</parameter>
set to &false; the watcher won&apos;t keep
@@ -24,20 +24,20 @@
/
<methodname>EvLoop::run</methodname>
from returning even though the watcher is active.
</para>
<para>
</simpara>
<simpara>
Watchers have keepalive
<parameter>value</parameter>
&true; by default.
</para>
<para>
</simpara>
<simpara>
Clearing keepalive status is useful when returning from
<methodname>Ev::run</methodname>
/
<methodname>EvLoop::run</methodname>
just because of the watcher is undesirable. It could be a long running UDP
socket watcher or so.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -47,7 +47,7 @@
<parameter>value</parameter>
</term>
<listitem>
<para>
<simpara>
With keepalive
<parameter>value</parameter>
set to &false; the watcher won&apos;t keep
@@ -55,16 +55,16 @@
/
<methodname>EvLoop::run</methodname>
from returning even though the watcher is active.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the previous state.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

14
reference/ev/evwatcher/setcallback.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evwatcher.setcallback" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evwatcher.setcallback">
<refnamediv>
<refname>EvWatcher::setCallback</refname>
<refpurpose>Sets new callback for the watcher</refpurpose>
@@ -16,9 +16,9 @@
<parameter>callback</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Sets new callback for the watcher
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -28,19 +28,19 @@
<parameter>callback</parameter>
</term>
<listitem>
<para>
<simpara>
See
<link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

12
reference/ev/evwatcher/start.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evwatcher.start" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evwatcher.start">
<refnamediv>
<refname>EvWatcher::start</refname>
<refpurpose>Starts the watcher</refpurpose>
@@ -11,12 +11,12 @@
<modifier>public</modifier>
<type>void</type>
<methodname>EvWatcher::start</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Marks the watcher as active. Note that only active watchers will receive
events.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -24,9 +24,9 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

12
reference/ev/evwatcher/stop.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evwatcher.stop" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evwatcher.stop">
<refnamediv>
<refname>EvWatcher::stop</refname>
<refpurpose>Stops the watcher</refpurpose>
@@ -11,12 +11,12 @@
<modifier>public</modifier>
<type>void</type>
<methodname>EvWatcher::stop</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Marks the watcher as inactive. Note that only active watchers will receive
events.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -24,9 +24,9 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

Some files were not shown because too many files have changed in this diff Show More