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

Comparing libev/ev.pod (file contents):
Revision 1.212 by root, Mon Nov 3 15:13:53 2008 UTC vs.
Revision 1.231 by root, Wed Apr 15 19:35:53 2009 UTC

 =head2 EXAMPLE PROGRAM
    // a single header file is required
    #include <ev.h>
+   #include <stdio.h> // for puts
    // every watcher type has its own typedef'd struct
    // with the name ev_TYPE
    ev_io stdin_watcher;
    ev_timer timeout_watcher;
    int
    main (void)
    {
      // use the default event loop unless you have special needs
-     ev_loop *loop = ev_default_loop (0);
+     struct ev_loop *loop = ev_default_loop (0);
      // initialise an io watcher, then start it
      // this one will watch for stdin to become readable
      ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
      ev_io_start (loop, &stdin_watcher);
 starting a watcher (without re-setting it) also usually doesn't cause
 extra overhead. A fork can both result in spurious notifications as well
 as in libev having to destroy and recreate the epoll object, which can
 take considerable time and thus should be avoided.
+All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or
+faster than epoll for maybe up to a hundred file descriptors, depending on
+the usage. So sad.
 While nominally embeddable in other event loops, this feature is broken in
 all kernel versions tested so far.
 This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
 C<EVBACKEND_POLL>.
 While nominally embeddable in other event loops, this doesn't work
 everywhere, so you might need to test for this. And since it is broken
 almost everywhere, you should only use it when you have a lot of sockets
 (for which it usually works), by embedding it into another event loop
-(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and, did I mention it,
+(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> (but C<poll> is of course
-using it only for sockets.
+also broken on OS X)) and, did I mention it, using it only for sockets.
 This backend maps C<EV_READ> into an C<EVFILT_READ> kevent with
 C<NOTE_EOF>, and C<EV_WRITE> into an C<EVFILT_WRITE> kevent with
 C<NOTE_EOF>.
 This function is rarely useful, but when some event callback runs for a
 very long time without entering the event loop, updating libev's idea of
 the current time is a good idea.
 See also "The special problem of time updates" in the C<ev_timer> section.
+=item ev_suspend (loop)
+=item ev_resume (loop)
+These two functions suspend and resume a loop, for use when the loop is
+not used for a while and timeouts should not be processed.
+A typical use case would be an interactive program such as a game:  When
+the user presses C<^Z> to suspend the game and resumes it an hour later it
+would be best to handle timeouts as if no time had actually passed while
+the program was suspended. This can be achieved by calling C<ev_suspend>
+in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling
+C<ev_resume> directly afterwards to resume timer processing.
+Effectively, all C<ev_timer> watchers will be delayed by the time spend
+between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers
+will be rescheduled (that is, they will lose any events that would have
+occured while suspended).
+After calling C<ev_suspend> you B<must not> call I<any> function on the
+given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>
+without a previous call to C<ev_suspend>.
+Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
+event loop time (see C<ev_now_update>).
 =item ev_loop (loop, int flags)
 Finally, this is it, the event handler. This function usually is called
 after you initialised all your watchers and you want to start handling
 If you have a watcher you never unregister that should not keep C<ev_loop>
 from returning, call ev_unref() after starting, and ev_ref() before
 stopping it.
-As an example, libev itself uses this for its internal signal pipe: It is
+As an example, libev itself uses this for its internal signal pipe: It
-not visible to the libev user and should not keep C<ev_loop> from exiting
+is not visible to the libev user and should not keep C<ev_loop> from
-if no event watchers registered by it are active. It is also an excellent
+exiting if no event watchers registered by it are active. It is also an
-way to do this for generic recurring timers or from within third-party
+excellent way to do this for generic recurring timers or from within
-libraries. Just remember to I<unref after start> and I<ref before stop>
+third-party libraries. Just remember to I<unref after start> and I<ref
-(but only if the watcher wasn't active before, or was active before,
+before stop> (but only if the watcher wasn't active before, or was active
-respectively).
+before, respectively. Note also that libev might stop watchers itself
+(e.g. non-repeating timers) in which case you have to C<ev_ref>
+in the callback).
 Example: Create a signal watcher, but keep it from keeping C<ev_loop>
 running when nothing else is active.
    ev_signal exitsig;
 C<ev_fork>).
 =item C<EV_ASYNC>
 The given async watcher has been asynchronously notified (see C<ev_async>).
+=item C<EV_CUSTOM>
+Not ever sent (or otherwise used) by libev itself, but can be freely used
+by libev users to signal watchers (e.g. via C<ev_feed_event>).
 =item C<EV_ERROR>
 An unspecified error has occurred, the watcher has been stopped. This might
 happen because the watcher could not be properly started because libev
 year, it will still time out after (roughly) one hour. "Roughly" because
 detecting time jumps is hard, and some inaccuracies are unavoidable (the
 monotonic clock option helps a lot here).
 The callback is guaranteed to be invoked only I<after> its timeout has
-passed, but if multiple timers become ready during the same loop iteration
+passed. If multiple timers become ready during the same loop iteration
-then order of execution is undefined.
+then the ones with earlier time-out values are invoked before ones with
+later time-out values (but this is no longer true when a callback calls
+C<ev_loop> recursively).
 =head3 Be smart about timeouts
 Many real-world problems involve some kind of timeout, usually for error
 recovery. A typical example is an HTTP request - if the other side hangs,
      else
        {
          // callback was invoked, but there was some activity, re-arm
          // the watcher to fire in last_activity + 60, which is
          // guaranteed to be in the future, so "again" is positive:
-         w->again = timeout - now;
+         w->repeat = timeout - now;
          ev_timer_again (EV_A_ w);
        }
    }
 To summarise the callback: first calculate the real timeout (defined
 =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)
+Unlike C<ev_timer>, periodic watchers are not based on real time (or
-but on wall clock time (absolute time). You can tell a periodic watcher
+relative time, the physical time that passes) but on wall clock time
-to trigger after some specific point in time. For example, if you tell a
+(absolute time, the thing you can read on your calender or clock). The
-periodic watcher to trigger in 10 seconds (by specifying e.g. C<ev_now ()
+difference is that wall clock time can run faster or slower than real
-+ 10.>, that is, an absolute time not a delay) and then reset your system
+time, and time jumps are not uncommon (e.g. when you adjust your
-clock to January of the previous year, then it will take more than year
+wrist-watch).
-to trigger the event (unlike an C<ev_timer>, which would still trigger
-roughly 10 seconds later as it uses a relative timeout).
+You can tell a periodic watcher to trigger after some specific point
+in time: for example, if you tell a periodic watcher to trigger "in 10
+seconds" (by specifying e.g. C<ev_now () + 10.>, that is, an absolute time
+not a delay) and then reset your system clock to January of the previous
+year, then it will take a year or more to trigger the event (unlike an
+C<ev_timer>, which would still trigger roughly 10 seconds after starting
+it, as it uses a relative timeout).
-C<ev_periodic>s can also be used to implement vastly more complex timers,
+C<ev_periodic> watchers can also be used to implement vastly more complex
-such as triggering an event on each "midnight, local time", or other
+timers, such as triggering an event on each "midnight, local time", or
-complicated rules.
+other complicated rules. This cannot be done with C<ev_timer> watchers, as
+those cannot react to time jumps.
 As with timers, the callback is guaranteed to be invoked only when the
-time (C<at>) has passed, but if multiple periodic timers become ready
+point in time where it is supposed to trigger has passed. If multiple
-during the same loop iteration, then order of execution is undefined.
+timers become ready during the same loop iteration then the ones with
+earlier time-out values are invoked before ones with later time-out values
+(but this is no longer true when a callback calls C<ev_loop> recursively).
 =head3 Watcher-Specific Functions and Data Members
 =over 4
-=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)
+=item ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
-=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)
+=item ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
-Lots of arguments, lets sort it out... There are basically three modes of
+Lots of arguments, let's sort it out... There are basically three modes of
 operation, and we will explain them from simplest to most complex:
 =over 4
-=item * absolute timer (at = time, interval = reschedule_cb = 0)
+=item * absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0)
 In this configuration the watcher triggers an event after the wall clock
-time C<at> has passed. It will not repeat and will not adjust when a time
+time C<offset> has passed. It will not repeat and will not adjust when a
-jump occurs, that is, if it is to be run at January 1st 2011 then it will
+time jump occurs, that is, if it is to be run at January 1st 2011 then it
-only run when the system clock reaches or surpasses this time.
+will be stopped and invoked when the system clock reaches or surpasses
+this point in time.
-=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
+=item * repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0)
 In this mode the watcher will always be scheduled to time out at the next
-C<at + N * interval> time (for some integer N, which can also be negative)
+C<offset + N * interval> time (for some integer N, which can also be
-and then repeat, regardless of any time jumps.
+negative) and then repeat, regardless of any time jumps. The C<offset>
+argument is merely an offset into the C<interval> periods.
 This can be used to create timers that do not drift with respect to the
-system clock, for example, here is a C<ev_periodic> that triggers each
+system clock, for example, here is an C<ev_periodic> that triggers each
-hour, on the hour:
+hour, on the hour (with respect to UTC):
    ev_periodic_set (&periodic, 0., 3600., 0);
 This doesn't mean there will always be 3600 seconds in between triggers,
 but only that the callback will be called when the system time shows a
 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.
+time where C<time = offset (mod interval)>, regardless of any time jumps.
-For numerical stability it is preferable that the C<at> value is near
+For numerical stability it is preferable that the C<offset> value is near
 C<ev_now ()> (the current time), but there is no range requirement for
 this value, and in fact is often specified as zero.
 Note also that there is an upper limit to how often a timer can fire (CPU
 speed for example), so if C<interval> is very small then timing stability
 will of course deteriorate. Libev itself tries to be exact to be about one
 millisecond (if the OS supports it and the machine is fast enough).
-=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)
+=item * manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback)
-In this mode the values for C<interval> and C<at> are both being
+In this mode the values for C<interval> and C<offset> are both being
 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 any periodic watcher,
+NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, ever,
-ever, or make ANY event loop modifications whatsoever>.
+or make ANY other event loop modifications whatsoever, unless explicitly
+allowed by documentation here>.
 If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop
 it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the
 only event loop modification you are allowed to do).
 a different time than the last time it was called (e.g. in a crond like
 program when the crontabs have changed).
 =item ev_tstamp ev_periodic_at (ev_periodic *)
-When active, returns the absolute time that the watcher is supposed to
+When active, returns the absolute time that the watcher is supposed
-trigger next.
+to trigger next. This is not the same as the C<offset> argument to
+C<ev_periodic_set>, but indeed works even in interval and manual
+rescheduling modes.
 =item ev_tstamp offset [read-write]
 When repeating, this contains the offset value, otherwise this is the
-absolute point in time (the C<at> value passed to C<ev_periodic_set>).
+absolute point in time (the C<offset> value passed to C<ev_periodic_set>,
+although libev might modify this value for better numerical stability).
 Can be modified any time, but changes only take effect when the periodic
 timer fires or C<ev_periodic_again> is being called.
 =item ev_tstamp interval [read-write]
 the process. The exception are C<ev_stat> watchers - those call C<stat
 ()>, which is a synchronous operation.
 For local paths, this usually doesn't matter: unless the system is very
 busy or the intervals between stat's are large, a stat call will be fast,
-as the path data is suually in memory already (except when starting the
+as the path data is usually in memory already (except when starting the
 watcher).
 For networked file systems, calling C<stat ()> can block an indefinite
 time due to network issues, and even under good conditions, a stat call
 often takes multiple milliseconds.
 =head3 Watcher-Specific Functions and Data Members
 =over 4
-=item ev_idle_init (ev_signal *, callback)
+=item ev_idle_init (ev_idle *, callback)
 Initialises and configures the idle watcher - it has no parameters of any
 kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
 believe me.
 some fds have to be watched and handled very quickly (with low latency),
 and even priorities and idle watchers might have too much overhead. In
 this case you would put all the high priority stuff in one loop and all
 the rest in a second one, and embed the second one in the first.
-As long as the watcher is active, the callback will be invoked every time
+As long as the watcher is active, the callback will be invoked every
-there might be events pending in the embedded loop. The callback must then
+time there might be events pending in the embedded loop. The callback
-call C<ev_embed_sweep (mainloop, watcher)> to make a single sweep and invoke
+must then call C<ev_embed_sweep (mainloop, watcher)> to make a single
-their callbacks (you could also start an idle watcher to give the embedded
+sweep and invoke their callbacks (the callback doesn't need to invoke the
-loop strictly lower priority for example). You can also set the callback
+C<ev_embed_sweep> function directly, it could also start an idle watcher
-to C<0>, in which case the embed watcher will automatically execute the
+to give the embedded loop strictly lower priority for example).
-embedded loop sweep.
-As long as the watcher is started it will automatically handle events. The
+You can also set the callback to C<0>, in which case the embed watcher
-callback will be invoked whenever some events have been handled. You can
+will automatically execute the embedded loop sweep whenever necessary.
-set the callback to C<0> to avoid having to specify one if you are not
-interested in that.
-Also, there have not currently been made special provisions for forking:
+Fork detection will be handled transparently while the C<ev_embed> watcher
-when you fork, you not only have to call C<ev_loop_fork> on both loops,
+is active, i.e., the embedded loop will automatically be forked when the
-but you will also have to stop and restart any C<ev_embed> watchers
+embedding loop forks. In other cases, the user is responsible for calling
-yourself - but you can use a fork watcher to handle this automatically,
+C<ev_loop_fork> on the embedded loop.
-and future versions of libev might do just that.
 Unfortunately, not all backends are embeddable: only the ones returned by
 C<ev_embeddable_backends> are, which, unfortunately, does not include any
 portable one.
 an C<EV_ASYNC> event on the watcher into the event loop. Unlike
 C<ev_feed_event>, this call is safe to do from other threads, signal or
 similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding
 section below on what exactly this means).
+Note that, as with other watchers in libev, multiple events might get
+compressed into a single callback invocation (another way to look at this
+is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,
+reset when the event loop detects that).
-This call incurs the overhead of a system call only once per loop iteration,
+This call incurs the overhead of a system call only once per event loop
-so while the overhead might be noticeable, it doesn't apply to repeated
+iteration, so while the overhead might be noticeable, it doesn't apply to
-calls to C<ev_async_send>.
+repeated calls to C<ev_async_send> for the same event loop.
 =item bool = ev_async_pending (ev_async *)
 Returns a non-zero value when C<ev_async_send> has been called on the
 watcher but the event has not yet been processed (or even noted) by the
 C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
 the loop iterates next and checks for the watcher to have become active,
 it will reset the flag again. C<ev_async_pending> can be used to very
 quickly check whether invoking the loop might be a good idea.
-Not that this does I<not> check whether the watcher itself is pending, only
+Not that this does I<not> check whether the watcher itself is pending,
-whether it has been requested to make this watcher pending.
+only whether it has been requested to make this watcher pending: there
+is a time window between the event loop checking and resetting the async
+notification, and the callback being invoked.
 =back
 =head1 OTHER FUNCTIONS
    myclass obj;
    ev::io iow;
    iow.set <myclass, &myclass::io_cb> (&obj);
+=item w->set (object *)
+This is an B<experimental> feature that might go away in a future version.
+This is a variation of a method callback - leaving out the method to call
+will default the method to C<operator ()>, which makes it possible to use
+functor objects without having to manually specify the C<operator ()> all
+the time. Incidentally, you can then also leave out the template argument
+list.
+The C<operator ()> method prototype must be C<void operator ()(watcher &w,
+int revents)>.
+See the method-C<set> above for more details.
+Example: use a functor object as callback.
+   struct myfunctor
+   {
+     void operator() (ev::io &w, int revents)
+     {
+       ...
+     }
+   }
+   myfunctor f;
+   ev::io w;
+   w.set (&f);
 =item w->set<function> (void *data = 0)
 Also sets a callback, but uses a static method or plain function as
 callback. The optional C<data> argument will be stored in the watcher's
 C<data> member and is free for you to use.
 L<http://software.schmorp.de/pkg/EV>.
 =item Python
 Python bindings can be found at L<http://code.google.com/p/pyev/>. It
-seems to be quite complete and well-documented. Note, however, that the
+seems to be quite complete and well-documented.
-patch they require for libev is outright dangerous as it breaks the ABI
-for everybody else, and therefore, should never be applied in an installed
-libev (if python requires an incompatible ABI then it needs to embed
-libev).
 =item Ruby
 Tony Arcieri has written a ruby extension that offers access to a subset
 of the libev API and adds file handle abstractions, asynchronous DNS and
 more on top of it. It can be found via gem servers. Its homepage is at
 L<http://rev.rubyforge.org/>.
+Roger Pack reports that using the link order C<-lws2_32 -lmsvcrt-ruby-190>
+makes rev work even on mingw.
+=item Haskell
+A haskell binding to libev is available at
+L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
 =item D
 Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
 be found at L<http://proj.llucax.com.ar/wiki/evd>.
 keeps libev from including F<config.h>, and it also defines dummy
 implementations for some libevent functions (such as logging, which is not
 supported). It will also not define any of the structs usually found in
 F<event.h> that are not directly supported by the libev core alone.
+In stanbdalone mode, libev will still try to automatically deduce the
+configuration, but has to be more conservative.
 =item EV_USE_MONOTONIC
 If defined to be C<1>, libev will try to detect the availability of the
-monotonic clock option at both compile time and runtime. Otherwise no use
+monotonic clock option at both compile time and runtime. Otherwise no
-of the monotonic clock option will be attempted. If you enable this, you
+use of the monotonic clock option will be attempted. If you enable this,
-usually have to link against librt or something similar. Enabling it when
+you usually have to link against librt or something similar. Enabling it
-the functionality isn't available is safe, though, although you have
+when the functionality isn't available is safe, though, although you have
 to make sure you link against any libraries where the C<clock_gettime>
-function is hiding in (often F<-lrt>).
+function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>.
 =item EV_USE_REALTIME
 If defined to be C<1>, libev will try to detect the availability of the
-real-time clock option at compile time (and assume its availability at
+real-time clock option at compile time (and assume its availability
-runtime if successful). Otherwise no use of the real-time clock option will
+at runtime if successful). Otherwise no use of the real-time clock
-be attempted. This effectively replaces C<gettimeofday> by C<clock_get
+option will be attempted. This effectively replaces C<gettimeofday>
-(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the
+by C<clock_get (CLOCK_REALTIME, ...)> and will not normally affect
-note about libraries in the description of C<EV_USE_MONOTONIC>, though.
+correctness. See the note about libraries in the description of
+C<EV_USE_MONOTONIC>, though. Defaults to the opposite value of
+C<EV_USE_CLOCK_SYSCALL>.
+=item EV_USE_CLOCK_SYSCALL
+If defined to be C<1>, libev will try to use a direct syscall instead
+of calling the system-provided C<clock_gettime> function. This option
+exists because on GNU/Linux, C<clock_gettime> is in C<librt>, but C<librt>
+unconditionally pulls in C<libpthread>, slowing down single-threaded
+programs needlessly. Using a direct syscall is slightly slower (in
+theory), because no optimised vdso implementation can be used, but avoids
+the pthread dependency. Defaults to C<1> on GNU/Linux with glibc 2.x or
+higher, as it simplifies linking (no need for C<-lrt>).
 =item EV_USE_NANOSLEEP
 If defined to be C<1>, libev will assume that C<nanosleep ()> is available
 and will use it for delays. Otherwise it will use C<select ()>.
 =item EV_SELECT_USE_FD_SET
 If defined to C<1>, then the select backend will use the system C<fd_set>
 structure. This is useful if libev doesn't compile due to a missing
-C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout on
+C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout
-exotic systems. This usually limits the range of file descriptors to some
+on exotic systems. This usually limits the range of file descriptors to
-low limit such as 1024 or might have other limitations (winsocket only
+some low limit such as 1024 or might have other limitations (winsocket
-allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might
+only allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation,
-influence the size of the C<fd_set> used.
+configures the maximum size of the C<fd_set>.
 =item EV_SELECT_IS_WINSOCKET
 When defined to C<1>, the select backend will assume that
 select/socket/connect etc. don't understand file descriptors but

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.212 by root, Mon Nov 3 15:13:53 2008 UTC vs. Revision 1.231 by root, Wed Apr 15 19:35:53 2009 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.212 by root, Mon Nov 3 15:13:53 2008 UTC vs.
Revision 1.231 by root, Wed Apr 15 19:35:53 2009 UTC