*** empty log message ***

[software/libev.git] / ev.pod

diff --git a/ev.pod b/ev.pod
index ab57ffbd559a2819c7d245ec80c9900ebb82d558..905e935ccbbb3af9e2027e1fd0a04222c14b8931 100644 (file)
--- a/ev.pod
+++ b/ev.pod
@@ -935,6 +935,8 @@ the libev application should not optimise around libev but should leave
 optimisations to libev.
 
 
 optimisations to libev.
 
 

+=head3 Watcher-Specific Functions
+

 =over 4
 
 =item ev_io_init (ev_io *, callback, int fd, int events)
 =over 4
 
 =item ev_io_init (ev_io *, callback, int fd, int events)


@@ -997,6 +999,8 @@ The callback is guarenteed to be invoked only when its timeout has passed,
 but if multiple timers become ready during the same loop iteration then
 order of execution is undefined.
 
 but if multiple timers become ready during the same loop iteration then
 order of execution is undefined.
 

+=head3 Watcher-Specific Functions and Data Members
+

 =over 4
 
 =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
 =over 4
 
 =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)


@@ -1111,6 +1115,8 @@ As with timers, the callback is guarenteed to be invoked only when the
 time (C<at>) has been passed, but if multiple periodic timers become ready
 during the same loop iteration then order of execution is undefined.
 
 time (C<at>) has been passed, but if multiple periodic timers become ready
 during the same loop iteration then order of execution is undefined.
 

+=head3 Watcher-Specific Functions and Data Members
+

 =over 4
 
 =item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)
 =over 4
 
 =item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)


@@ -1266,6 +1272,8 @@ as you don't register any with libev). Similarly, when the last signal
 watcher for a signal is stopped libev will reset the signal handler to
 SIG_DFL (regardless of what it was set to before).
 
 watcher for a signal is stopped libev will reset the signal handler to
 SIG_DFL (regardless of what it was set to before).
 

+=head3 Watcher-Specific Functions and Data Members
+

 =over 4
 
 =item ev_signal_init (ev_signal *, callback, int signum)
 =over 4
 
 =item ev_signal_init (ev_signal *, callback, int signum)


@@ -1287,6 +1295,8 @@ The signal the watcher watches out for.
 Child watchers trigger when your process receives a SIGCHLD in response to
 some child status changes (most typically when a child of yours dies).
 
 Child watchers trigger when your process receives a SIGCHLD in response to
 some child status changes (most typically when a child of yours dies).
 

+=head3 Watcher-Specific Functions and Data Members
+

 =over 4
 
 =item ev_child_init (ev_child *, callback, int pid)
 =over 4
 
 =item ev_child_init (ev_child *, callback, int pid)


@@ -1364,6 +1374,8 @@ to fall back to regular polling again even with inotify, but changes are
 usually detected immediately, and if the file exists there will be no
 polling.
 
 usually detected immediately, and if the file exists there will be no
 polling.
 

+=head3 Watcher-Specific Functions and Data Members
+

 =over 4
 
 =item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)
 =over 4
 
 =item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)


@@ -1455,6 +1467,8 @@ effect on its own sometimes), idle watchers are a good place to do
 "pseudo-background processing", or delay processing stuff to after the
 event loop has handled all outstanding events.
 
 "pseudo-background processing", or delay processing stuff to after the
 event loop has handled all outstanding events.
 

+=head3 Watcher-Specific Functions and Data Members
+

 =over 4
 
 =item ev_idle_init (ev_signal *, callback)
 =over 4
 
 =item ev_idle_init (ev_signal *, callback)


@@ -1531,6 +1545,8 @@ loops those other event loops might be in an unusable state until their
 C<ev_check> watcher ran (always remind yourself to coexist peacefully with
 others).
 
 C<ev_check> watcher ran (always remind yourself to coexist peacefully with
 others).
 

+=head3 Watcher-Specific Functions and Data Members
+

 =over 4
 
 =item ev_prepare_init (ev_prepare *, callback)
 =over 4
 
 =item ev_prepare_init (ev_prepare *, callback)


@@ -1741,6 +1757,8 @@ create it, and if that fails, use the normal loop for everything:
   else
     loop_lo = loop_hi;
 
   else
     loop_lo = loop_hi;
 

+=head3 Watcher-Specific Functions and Data Members
+

 =over 4
 
 =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
 =over 4
 
 =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)


@@ -1776,6 +1794,8 @@ and only in the child after the fork. If whoever good citizen calling
 C<ev_default_fork> cheats and calls it in the wrong process, the fork
 handlers will be invoked, too, of course.
 
 C<ev_default_fork> cheats and calls it in the wrong process, the fork
 handlers will be invoked, too, of course.
 

+=head3 Watcher-Specific Functions and Data Members
+

 =over 4
 
 =item ev_fork_init (ev_signal *, callback)
 =over 4
 
 =item ev_fork_init (ev_signal *, callback)


@@ -2001,16 +2021,16 @@ constructor already stores the event loop.
 
 Stops the watcher if it is active. Again, no C<loop> argument.
 
 
 Stops the watcher if it is active. Again, no C<loop> argument.
 

-=item w->again ()       C<ev::timer>, C<ev::periodic> only
+=item w->again () (C<ev::timer>, C<ev::periodic> only)

 
 For C<ev::timer> and C<ev::periodic>, this invokes the corresponding
 C<ev_TYPE_again> function.
 
 
 For C<ev::timer> and C<ev::periodic>, this invokes the corresponding
 C<ev_TYPE_again> function.
 

-=item w->sweep ()       C<ev::embed> only
+=item w->sweep () (C<ev::embed> only)

 
 Invokes C<ev_embed_sweep>.
 
 
 Invokes C<ev_embed_sweep>.
 

-=item w->update ()      C<ev::stat> only
+=item w->update () (C<ev::stat> only)

 
 Invokes C<ev_stat_stat>.
 
 
 Invokes C<ev_stat_stat>.
 


@@ -2040,9 +2060,9 @@ the constructor.
 
 =head1 MACRO MAGIC
 
 
 =head1 MACRO MAGIC
 

-Libev can be compiled with a variety of options, the most fundemantal is
-C<EV_MULTIPLICITY>. This option determines whether (most) functions and
-callbacks have an initial C<struct ev_loop *> argument.
+Libev can be compiled with a variety of options, the most fundamantal
+of which is C<EV_MULTIPLICITY>. This option determines whether (most)
+functions and callbacks have an initial C<struct ev_loop *> argument.

 
 To make it easier to write programs that cope with either variant, the
 following macros are defined:
 
 To make it easier to write programs that cope with either variant, the
 following macros are defined: