[ViewVC] Diff of: cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.10 by root, Mon Nov 12 08:32:27 2007 UTC vs.
Revision 1.16 by root, Mon Nov 12 08:47:14 2007 UTC

 As long as your watcher is active (has been started but not stopped) you
 must not touch the values stored in it. Most specifically you must never
 reinitialise it or call its set method.
-You cna check whether an event is active by calling the C<ev_is_active
+You can check whether an event is active by calling the C<ev_is_active
 (watcher *)> macro. To see whether an event is outstanding (but the
-callback for it has not been called yet) you cna use the C<ev_is_pending
+callback for it has not been called yet) you can use the C<ev_is_pending
 (watcher *)> macro.
 Each and every callback receives the event loop pointer as first, the
 registered watcher structure as second, and a bitset of received events as
 third argument.
-The rceeived events usually include a single bit per event type received
+The received events usually include a single bit per event type received
 (you can receive multiple events at the same time). The possible bit masks
 are:
 =over 4
 =back
 =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
 Each watcher has, by default, a member C<void *data> that you can change
-and read at any time, libev will completely ignore it. This cna be used
+and read at any time, libev will completely ignore it. This can be used
 to associate arbitrary data with your watcher. If you need more data and
 don't want to allocate memory and store a pointer to it in that data
 member, you can also "subclass" the watcher type and provide your own
 data:
 =head1 WATCHER TYPES
 This section describes each watcher in detail, but will not repeat
 information given in the last section.
-=head2 C<ev_io> - is my file descriptor readable or writable
+=head2 C<ev_io> - is this file descriptor readable or writable
 I/O watchers check whether a file descriptor is readable or writable
 in each iteration of the event loop (This behaviour is called
 level-triggering because you keep receiving events as long as the
-condition persists. Remember you cna stop the watcher if you don't want to
+condition persists. Remember you can stop the watcher if you don't want to
 act on the event and neither want to receive future events).
 In general you can register as many read and/or write event watchers oer
 fd as you want (as long as you don't confuse yourself). Setting all file
 descriptors to non-blocking mode is also usually a good idea (but not
 state where you do not expect data to travel on the socket, you can stop
 the timer, and again will automatically restart it if need be.
 =back
-=head2 C<ev_periodic> - to cron or not to cron it
+=head2 C<ev_periodic> - to cron or not to cron
 Periodic watchers are also timers of a kind, but they are very versatile
 (and unfortunately a bit complex).
 Unlike C<ev_timer>'s, they are not based on real time (or relative time)
    ev_periodic_set (&periodic, 0., 3600., 0);
 This doesn't mean there will always be 3600 seconds in between triggers,
 but only that the the callback will be called when the system time shows a
-full hour (UTC), or more correct, when the system time is evenly divisible
+full hour (UTC), or more correctly, when the system time is evenly divisible
 by 3600.
 Another way to think about it (for the mathematically inclined) is that
 C<ev_periodic> will try to run the callback in this mode at the next possible
 time where C<time = at (mod interval)>, regardless of any time jumps.
 ignored. Instead, each time the periodic watcher gets scheduled, the
 reschedule callback will be called with the watcher as first, and the
 current time as second argument.
 NOTE: I<This callback MUST NOT stop or destroy the periodic or any other
-periodic watcher, ever, or make any event loop modificstions>. If you need
+periodic watcher, ever, or make any event loop modifications>. If you need
-to stop it, return 1e30 (or so, fudge fudge) and stop it afterwards.
+to stop it, return C<now + 1e30> (or so, fudge fudge) and stop it afterwards.
+Also, I<< this callback must always return a time that is later than the
+passed C<now> value >>. Not even C<now> itself will be ok.
-Its prototype is c<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
+Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
 ev_tstamp now)>, e.g.:
    static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
    {
      return now + 60.;
 Signal watchers will trigger an event when the process receives a specific
 signal one or more times. Even though signals are very asynchronous, libev
 will try it's best to deliver signals synchronously, i.e. as part of the
 normal event processing, like any other event.
-You cna configure as many watchers as you like per signal. Only when the
+You can configure as many watchers as you like per signal. Only when the
 first watcher gets started will libev actually register a signal watcher
 with the kernel (thus it coexists with your own signal handlers as long
 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).
 =item ev_child_set (ev_child *, int pid)
 Configures the watcher to wait for status changes of process C<pid> (or
 I<any> process if C<pid> is specified as C<0>). The callback can look
 at the C<rstatus> member of the C<ev_child> watcher structure to see
-the status word (use the macros from C<sys/wait.h>). The C<rpid> member
+the status word (use the macros from C<sys/wait.h> and see your systems
-contains the pid of the process causing the status change.
+C<waitpid> documentation). The C<rpid> member contains the pid of the
+process causing the status change.
 =back
 =head2 C<ev_idle> - when you've got nothing better to do
-Idle watchers trigger events when there are no other I/O or timer (or
+Idle watchers trigger events when there are no other events are pending
-periodic) events pending. That is, as long as your process is busy
+(prepare, check and other idle watchers do not count). That is, as long
-handling sockets or timeouts it will not be called. But when your process
+as your process is busy handling sockets or timeouts (or even signals,
-is idle all idle watchers are being called again and again - until
+imagine) it will not be triggered. But when your process is idle all idle
+watchers are being called again and again, once per event loop iteration -
-stopped, that is, or your process receives more events.
+until stopped, that is, or your process receives more events and becomes
+busy.
 The most noteworthy effect is that as long as any idle watchers are
 active, the process will not block when waiting for new events.
 Apart from keeping your process non-blocking (which is a useful
 kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
 believe me.
 =back
-=head2 prepare and check - your hooks into the event loop
+=head2 C<ev_prepare> and C<ev_check> - customise your event loop
-Prepare and check watchers usually (but not always) are used in
+Prepare and check watchers are usually (but not always) used in tandem:
-tandom. Prepare watchers get invoked before the process blocks and check
+Prepare watchers get invoked before the process blocks and check watchers
-watchers afterwards.
+afterwards.
 Their main purpose is to integrate other event mechanisms into libev. This
 could be used, for example, to track variable changes, implement your own
 watchers, integrate net-snmp or a coroutine library and lots more.
 This is done by examining in each prepare call which file descriptors need
-to be watched by the other library, registering C<ev_io> watchers for them
+to be watched by the other library, registering C<ev_io> watchers for
-and starting an C<ev_timer> watcher for any timeouts (many libraries provide
+them and starting an C<ev_timer> watcher for any timeouts (many libraries
-just this functionality). Then, in the check watcher you check for any
+provide just this functionality). Then, in the check watcher you check for
-events that occured (by making your callbacks set soem flags for example)
+any events that occured (by checking the pending status of all watchers
-and call back into the library.
+and stopping them) and call back into the library. The I/O and timer
+callbacks will never actually be called (but must be valid neverthelles,
+because you never know, you know?).
-As another example, the perl Coro module uses these hooks to integrate
+As another example, the Perl Coro module uses these hooks to integrate
 coroutines into libev programs, by yielding to other active coroutines
 during each prepare and only letting the process block if no coroutines
-are ready to run.
+are ready to run (its actually more complicated, it only runs coroutines
+with priority higher than the event loop and one lower priority once,
+using idle watchers to keep the event loop from blocking if lower-priority
+coroutines exist, thus mapping low-priority coroutines to idle/background
+tasks).
 =over 4
 =item ev_prepare_init (ev_prepare *, callback)
 =item ev_check_init (ev_check *, callback)
 Initialises and configures the prepare or check watcher - they have no
 parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
-macros, but using them is utterly, utterly pointless.
+macros, but using them is utterly, utterly and completely pointless.
 =back
 =head1 OTHER FUNCTIONS
-There are some other fucntions of possible interest. Described. Here. Now.
+There are some other functions of possible interest. Described. Here. Now.
 =over 4
 =item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)
 callback on whichever event happens first and automatically stop both
 watchers. This is useful if you want to wait for a single event on an fd
 or timeout without havign to allocate/configure/start/stop/free one or
 more watchers yourself.
-If C<fd> is less than 0, then no I/O watcher will be started and events is
+If C<fd> is less than 0, then no I/O watcher will be started and events
-ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and C<events> set
+is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and
-will be craeted and started.
+C<events> set will be craeted and started.
 If C<timeout> is less than 0, then no timeout watcher will be
-started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and repeat
+started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
-= 0) will be started.
+repeat = 0) will be started. While C<0> is a valid timeout, it is of
+dubious value.
-The callback has the type C<void (*cb)(int revents, void *arg)> and
+The callback has the type C<void (*cb)(int revents, void *arg)> and gets
-gets passed an events set (normally a combination of C<EV_ERROR>, C<EV_READ>,
+passed an events set like normal event callbacks (with a combination of
-C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg> value passed to C<ev_once>:
+C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>
+value passed to C<ev_once>:
   static void stdin_ready (int revents, void *arg)
   {
     if (revents & EV_TIMEOUT)
-      /* doh, nothing entered */
+      /* doh, nothing entered */;
     else if (revents & EV_READ)
-      /* stdin might have data for us, joy! */
+      /* stdin might have data for us, joy! */;
   }
-  ev_once (STDIN_FILENO, EV_READm 10., stdin_ready, 0);
+  ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
 =item ev_feed_event (loop, watcher, int events)
 Feeds the given event set into the event loop, as if the specified event
-has happened for the specified watcher (which must be a pointer to an
+had happened for the specified watcher (which must be a pointer to an
-initialised but not necessarily active event watcher).
+initialised but not necessarily started event watcher).
 =item ev_feed_fd_event (loop, int fd, int revents)
-Feed an event on the given fd, as if a file descriptor backend detected it.
+Feed an event on the given fd, as if a file descriptor backend detected
+the given events it.
 =item ev_feed_signal_event (loop, int signum)
 Feed an event as if the given signal occured (loop must be the default loop!).

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing libev/ev.pod (file contents): Revision 1.10 by root, Mon Nov 12 08:32:27 2007 UTC vs. Revision 1.16 by root, Mon Nov 12 08:47:14 2007 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.10 by root, Mon Nov 12 08:32:27 2007 UTC vs.
Revision 1.16 by root, Mon Nov 12 08:47:14 2007 UTC