--- libev/ev.pod 2011/01/30 23:07:20 1.364
+++ libev/ev.pod 2014/04/26 14:28:48 1.432
@@ -1,3 +1,5 @@
+=encoding utf-8
+
=head1 NAME
libev - a high performance full-featured event loop written in C
@@ -84,9 +86,9 @@
This manual tries to be very detailed, but unfortunately, this also makes
it very long. If you just want to know the basics of libev, I suggest
-reading L, then the L above and
-look up the missing functions in L and the C and
-C sections in L.
+reading L , then the L above and
+look up the missing functions in L and the C and
+C sections in L.
=head1 ABOUT LIBEV
@@ -176,13 +178,19 @@
Returns the current time as libev would use it. Please note that the
C function is usually faster and also often returns the timestamp
you actually want to know. Also interesting is the combination of
-C and C.
+C and C.
=item ev_sleep (ev_tstamp interval)
-Sleep for the given interval: The current thread will be blocked until
-either it is interrupted or the given time interval has passed. Basically
-this is a sub-second-resolution C.
+Sleep for the given interval: The current thread will be blocked
+until either it is interrupted or the given time interval has
+passed (approximately - it might return a bit earlier even if not
+interrupted). Returns immediately if C<< interval <= 0 >>.
+
+Basically this is a sub-second-resolution C.
+
+The range of the C is limited - libev only guarantees to work
+with sleep times of up to one day (C<< interval <= 86400 >>).
=item int ev_version_major ()
@@ -243,7 +251,7 @@
See the description of C watchers for more info.
-=item ev_set_allocator (void *(*cb)(void *ptr, long size))
+=item ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())
Sets the allocation function to use (the prototype is similar - the
semantics are identical to the C C89/SuS/POSIX function). It is
@@ -279,7 +287,7 @@
...
ev_set_allocator (persistent_realloc);
-=item ev_set_syserr_cb (void (*cb)(const char *msg))
+=item ev_set_syserr_cb (void (*cb)(const char *msg) throw ())
Set the callback function to call on a retryable system call error (such
as failed select, poll, epoll_wait). The message is a printable string
@@ -392,8 +400,10 @@
or setgid) then libev will I look at the environment variable
C. Otherwise (the default), this environment variable will
override the flags completely if it is found in the environment. This is
-useful to try out specific backends to test their performance, or to work
-around bugs.
+useful to try out specific backends to test their performance, to work
+around bugs, or to make libev threadsafe (accessing environment variables
+cannot be done in a threadsafe way, but usually it works if no other
+thread modifies them).
=item C
@@ -437,7 +447,7 @@
=item C
When this flag is specified, then libev will avoid to modify the signal
-mask. Specifically, this means you ahve to make sure signals are unblocked
+mask. Specifically, this means you have to make sure signals are unblocked
when you want to receive them.
This behaviour is useful when you want to do your own signal handling, or
@@ -485,10 +495,10 @@
Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9
kernels).
-For few fds, this backend is a bit little slower than poll and select,
-but it scales phenomenally better. While poll and select usually scale
-like O(total_fds) where n is the total number of fds (or the highest fd),
-epoll scales either O(1) or O(active_fds).
+For few fds, this backend is a bit little slower than poll and select, but
+it scales phenomenally better. While poll and select usually scale like
+O(total_fds) where total_fds is the total number of fds (or the highest
+fd), epoll scales either O(1) or O(active_fds).
The epoll mechanism deserves honorable mention as the most misdesigned
of the more advanced event mechanisms: mere annoyances include silently
@@ -501,19 +511,22 @@
set, which can take considerable time (one syscall per file descriptor)
and is of course hard to detect.
-Epoll is also notoriously buggy - embedding epoll fds I work, but
-of course I, and epoll just loves to report events for totally
-I file descriptors (even already closed ones, so one cannot
-even remove them from the set) than registered in the set (especially
-on SMP systems). Libev tries to counter these spurious notifications by
-employing an additional generation counter and comparing that against the
-events to filter out spurious ones, recreating the set when required. Last
+Epoll is also notoriously buggy - embedding epoll fds I work,
+but of course I, and epoll just loves to report events for
+totally I file descriptors (even already closed ones, so
+one cannot even remove them from the set) than registered in the set
+(especially on SMP systems). Libev tries to counter these spurious
+notifications by employing an additional generation counter and comparing
+that against the events to filter out spurious ones, recreating the set
+when required. Epoll also erroneously rounds down timeouts, but gives you
+no way to know when and by how much, so sometimes you have to busy-wait
+because epoll returns immediately despite a nonzero timeout. And last
not least, it also refuses to work with some file descriptors which work
perfectly fine with C (files, many character devices...).
-Epoll is truly the train wreck analog among event poll mechanisms,
-a frankenpoll, cobbled together in a hurry, no thought to design or
-interaction with others.
+Epoll is truly the train wreck among event poll mechanisms, a frankenpoll,
+cobbled together in a hurry, no thought to design or interaction with
+others. Oh, the pain, will it ever stop...
While stopping, setting and starting an I/O watcher in the same iteration
will result in some caching, there is still a system call per such
@@ -560,9 +573,9 @@
kernel is more efficient (which says nothing about its actual speed, of
course). While stopping, setting and starting an I/O watcher does never
cause an extra system call as with C, it still adds up to
-two event changes per incident. Support for C is very bad (but
-sane, unlike epoll) and it drops fds silently in similarly hard-to-detect
-cases
+two event changes per incident. Support for C is very bad (you
+might have to leak fd's on fork, but it's more sane than epoll) and it
+drops fds silently in similarly hard-to-detect cases.
This backend usually performs well under most conditions.
@@ -601,11 +614,11 @@
On the negative side, the interface is I - so bizarre that
even sun itself gets it wrong in their code examples: The event polling
-function sometimes returning events to the caller even though an error
+function sometimes returns events to the caller even though an error
occurred, but with no indication whether it has done so or not (yes, it's
-even documented that way) - deadly for edge-triggered interfaces where
-you absolutely have to know whether an event occurred or not because you
-have to re-arm the watcher.
+even documented that way) - deadly for edge-triggered interfaces where you
+absolutely have to know whether an event occurred or not because you have
+to re-arm the watcher.
Fortunately libev seems to be able to work around these idiocies.
@@ -677,7 +690,7 @@
the child process. You I call it (or use C) in the
child before resuming or calling C.
-Again, you I to call it on I loop that you want to re-use after
+Again, you I to call it on I loop that you want to re-use after
a fork, I. This is
because some kernel interfaces *cough* I *cough* do funny things
during fork.
@@ -757,7 +770,7 @@
very long time without entering the event loop, updating libev's idea of
the current time is a good idea.
-See also L in the C section.
+See also L in the C section.
=item ev_suspend (loop)
@@ -785,18 +798,22 @@
Calling C/C has the side effect of updating the
event loop time (see C).
-=item ev_run (loop, int flags)
+=item bool ev_run (loop, int flags)
Finally, this is it, the event handler. This function usually is called
after you have initialised all your watchers and you want to start
handling events. It will ask the operating system for any new events, call
-the watcher callbacks, an then repeat the whole process indefinitely: This
+the watcher callbacks, and then repeat the whole process indefinitely: This
is why event loops are called I.
If the flags argument is specified as C<0>, it will keep handling events
until either no event watchers are active anymore or C was
called.
+The return value is false if there are no more active watchers (which
+usually means "all jobs done" or "deadlock"), and true in all other cases
+(which usually means " you should call C again").
+
Please note that an explicit C is usually better than
relying on all watchers to be stopped when deciding when a program has
finished (especially in interactive programs), but having a program
@@ -804,8 +821,8 @@
of relying on its watchers stopping correctly, that is truly a thing of
beauty.
-This function is also I exception-safe - you can break out of
-a C call by calling C in a callback, throwing a C++
+This function is I exception-safe - you can break out of a
+C call by calling C in a callback, throwing a C++
exception and so on. This does not decrement the C value, nor
will it clear any outstanding C breaks.
@@ -827,7 +844,9 @@
own C"). However, a pair of C/C watchers is
usually a better approach for this kind of thing.
-Here are the gory details of what C does:
+Here are the gory details of what C does (this is for your
+understanding, not a guarantee that things will work exactly like this in
+future versions):
- Increment loop depth.
- Reset the ev_break status.
@@ -943,10 +962,11 @@
By setting a higher I you allow libev to spend more
time collecting I/O events, so you can handle more events per iteration,
at the cost of increasing latency. Timeouts (both C and
-C) will be not affected. Setting this to a non-null value will
+C) will not be affected. Setting this to a non-null value will
introduce an additional C call into most loop iterations. The
sleep time ensures that libev will not poll for I/O events more often then
-once per this interval, on average.
+once per this interval, on average (as long as the host time resolution is
+good enough).
Likewise, by setting a higher I you allow libev
to spend more time collecting timeouts, at the expense of increased
@@ -1002,7 +1022,7 @@
If you want to reset the callback, use C as new
callback.
-=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))
+=item ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ())
Sometimes you want to share the same loop between multiple threads. This
can be done relatively simply by putting mutex_lock/unlock calls around
@@ -1010,7 +1030,7 @@
However, C can run an indefinite time, so it is not feasible
to wait for it to return. One way around this is to wake up the event
-loop via C and C, another way is to set these
+loop via C and C, another way is to set these
I and I callbacks on the loop.
When set, then C will be called just before the thread is
@@ -1160,13 +1180,18 @@
=item C
-All C watchers are invoked just I C starts
-to gather new events, and all C watchers are invoked just after
-C has gathered them, but before it invokes any callbacks for any
-received events. Callbacks of both watcher types can start and stop as
-many watchers as they want, and all of them will be taken into account
-(for example, a C watcher might start an idle watcher to keep
-C from blocking).
+All C watchers are invoked just I C starts to
+gather new events, and all C watchers are queued (not invoked)
+just after C has gathered them, but before it queues any callbacks
+for any received events. That means C watchers are the last
+watchers invoked before the event loop sleeps or polls for new events, and
+C watchers will be invoked before any other watchers of the same
+or lower priority within an event loop iteration.
+
+Callbacks of both watcher types can start and stop as many watchers as
+they want, and all of them will be taken into account (for example, a
+C watcher might start an idle watcher to keep C from
+blocking).
=item C
@@ -1299,7 +1324,7 @@
Returns the callback currently set on the watcher.
-=item ev_cb_set (ev_TYPE *watcher, callback)
+=item ev_set_cb (ev_TYPE *watcher, callback)
Change the callback. You can change the callback at virtually any time
(modulo threads).
@@ -1327,7 +1352,7 @@
The default priority used by watchers when no priority has been set is
always C<0>, which is supposed to not be too high and not be too low :).
-See L, below, for a more thorough treatment of
+See L , below, for a more thorough treatment of
priorities.
=item ev_invoke (loop, ev_TYPE *watcher, int revents)
@@ -1362,7 +1387,7 @@
=back
-See also the L and L and L idioms.
=head2 WATCHER STATES
@@ -1374,9 +1399,9 @@
=over 4
-=item initialiased
+=item initialised
-Before a watcher can be registered with the event looop it has to be
+Before a watcher can be registered with the event loop it has to be
initialised. This can be done with a call to C, or calls to
C followed by the watcher-specific C function.
@@ -1761,10 +1786,11 @@
The callback is guaranteed to be invoked only I its timeout has
passed (not I, so on systems with very low-resolution clocks this
-might introduce a small delay). If multiple timers become ready during the
-same loop iteration then the ones with earlier time-out values are invoked
-before ones of the same priority with later time-out values (but this is
-no longer true when a callback calls C recursively).
+might introduce a small delay, see "the special problem of being too
+early", below). If multiple timers become ready during the same loop
+iteration then the ones with earlier time-out values are invoked before
+ones of the same priority with later time-out values (but this is no
+longer true when a callback calls C recursively).
=head3 Be smart about timeouts
@@ -1849,63 +1875,77 @@
but remember the time of last activity, and check for a real timeout only
within the callback:
+ ev_tstamp timeout = 60.;
ev_tstamp last_activity; // time of last activity
+ ev_timer timer;
static void
callback (EV_P_ ev_timer *w, int revents)
{
- ev_tstamp now = ev_now (EV_A);
- ev_tstamp timeout = last_activity + 60.;
+ // calculate when the timeout would happen
+ ev_tstamp after = last_activity - ev_now (EV_A) + timeout;
- // if last_activity + 60. is older than now, we did time out
- if (timeout < now)
+ // if negative, it means we the timeout already occurred
+ if (after < 0.)
{
// timeout occurred, take action
}
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->repeat = timeout - now;
- ev_timer_again (EV_A_ w);
+ // callback was invoked, but there was some recent
+ // activity. simply restart the timer to time out
+ // after "after" seconds, which is the earliest time
+ // the timeout can occur.
+ ev_timer_set (w, after, 0.);
+ ev_timer_start (EV_A_ w);
}
}
-To summarise the callback: first calculate the real timeout (defined
-as "60 seconds after the last activity"), then check if that time has
-been reached, which means something I, in fact, time out. Otherwise
-the callback was invoked too early (C is in the future), so
-re-schedule the timer to fire at that future time, to see if maybe we have
-a timeout then.
-
-Note how C is used, taking advantage of the
-C optimisation when the timer is already running.
+To summarise the callback: first calculate in how many seconds the
+timeout will occur (by calculating the absolute time when it would occur,
+C, and subtracting the current time, C from that).
+
+If this value is negative, then we are already past the timeout, i.e. we
+timed out, and need to do whatever is needed in this case.
+
+Otherwise, we now the earliest time at which the timeout would trigger,
+and simply start the timer with this timeout value.
+
+In other words, each time the callback is invoked it will check whether
+the timeout occurred. If not, it will simply reschedule itself to check
+again at the earliest time it could time out. Rinse. Repeat.
This scheme causes more callback invocations (about one every 60 seconds
minus half the average time between activity), but virtually no calls to
libev to change the timeout.
-To start the timer, simply initialise the watcher and set C
-to the current time (meaning we just have some activity :), then call the
-callback, which will "do the right thing" and start the timer:
+To start the machinery, simply initialise the watcher and set
+C to the current time (meaning there was some activity just
+now), then call the callback, which will "do the right thing" and start
+the timer:
+
+ last_activity = ev_now (EV_A);
+ ev_init (&timer, callback);
+ callback (EV_A_ &timer, 0);
- ev_init (timer, callback);
- last_activity = ev_now (loop);
- callback (loop, timer, EV_TIMER);
-
-And when there is some activity, simply store the current time in
+When there is some activity, simply store the current time in
C, no libev calls at all:
- last_activity = ev_now (loop);
+ if (activity detected)
+ last_activity = ev_now (EV_A);
+
+When your timeout value changes, then the timeout can be changed by simply
+providing a new value, stopping the timer and calling the callback, which
+will again do the right thing (for example, time out immediately :).
+
+ timeout = new_value;
+ ev_timer_stop (EV_A_ &timer);
+ callback (EV_A_ &timer, 0);
This technique is slightly more complex, but in most cases where the
time-out is unlikely to be triggered, much more efficient.
-Changing the timeout is trivial as well (if it isn't hard-coded in the
-callback :) - just change the timeout and invoke the callback, which will
-fix things for you.
-
=item 4. Wee, just use a double-linked list for your timeouts.
If there is not one request, but many thousands (millions...), all
@@ -1941,10 +1981,47 @@
off after the first million or so of active timers, i.e. it's usually
overkill :)
+=head3 The special problem of being too early
+
+If you ask a timer to call your callback after three seconds, then
+you expect it to be invoked after three seconds - but of course, this
+cannot be guaranteed to infinite precision. Less obviously, it cannot be
+guaranteed to any precision by libev - imagine somebody suspending the
+process with a STOP signal for a few hours for example.
+
+So, libev tries to invoke your callback as soon as possible I the
+delay has occurred, but cannot guarantee this.
+
+A less obvious failure mode is calling your callback too early: many event
+loops compare timestamps with a "elapsed delay >= requested delay", but
+this can cause your callback to be invoked much earlier than you would
+expect.
+
+To see why, imagine a system with a clock that only offers full second
+resolution (think windows if you can't come up with a broken enough OS
+yourself). If you schedule a one-second timer at the time 500.9, then the
+event loop will schedule your timeout to elapse at a system time of 500
+(500.9 truncated to the resolution) + 1, or 501.
+
+If an event library looks at the timeout 0.1s later, it will see "501 >=
+501" and invoke the callback 0.1s after it was started, even though a
+one-second delay was requested - this is being "too early", despite best
+intentions.
+
+This is the reason why libev will never invoke the callback if the elapsed
+delay equals the requested delay, but only when the elapsed delay is
+larger than the requested delay. In the example above, libev would only invoke
+the callback at system time 502, or 1.1s after the timer was started.
+
+So, while libev cannot guarantee that your callback will be invoked
+exactly when requested, it I and I guarantee that the requested
+delay has actually elapsed, or in other words, it always errs on the "too
+late" side of things.
+
=head3 The special problem of time updates
-Establishing the current time is a costly operation (it usually takes at
-least two system calls): EV therefore updates its idea of the current
+Establishing the current time is a costly operation (it usually takes
+at least one system call): EV therefore updates its idea of the current
time only before and after C collects new events, which causes a
growing difference between C and C when handling
lots of events in one iteration.
@@ -1961,6 +2038,39 @@
update of the time returned by C by calling C.
+=head3 The special problem of unsynchronised clocks
+
+Modern systems have a variety of clocks - libev itself uses the normal
+"wall clock" clock and, if available, the monotonic clock (to avoid time
+jumps).
+
+Neither of these clocks is synchronised with each other or any other clock
+on the system, so C might return a considerably different time
+than C or C. On a GNU/Linux system, for example,
+a call to C might return a second count that is one higher
+than a directly following call to C.
+
+The moral of this is to only compare libev-related timestamps with
+C and C, at least if you want better precision than
+a second or so.
+
+One more problem arises due to this lack of synchronisation: if libev uses
+the system monotonic clock and you compare timestamps from C
+or C from when you started your timer and when your callback is
+invoked, you will find that sometimes the callback is a bit "early".
+
+This is because Cs work in real time, not wall clock time, so
+libev makes sure your callback is not invoked before the delay happened,
+I, not the system clock.
+
+If your timeouts are based on a physical timescale (e.g. "time out this
+connection after 100 seconds") then this shouldn't bother you as it is
+exactly the right behaviour.
+
+If you want to compare wall clock/system timestamps to your timers, then
+you need to use Cs, as these are based on the wall clock
+time, where your comparisons will always generate correct results.
+
=head3 The special problems of suspended animation
When you leave the server world it is quite customary to hit machines that
@@ -2013,17 +2123,26 @@
=item ev_timer_again (loop, ev_timer *)
-This will act as if the timer timed out and restart it again if it is
-repeating. The exact semantics are:
+This will act as if the timer timed out, and restarts it again if it is
+repeating. It basically works like calling C, updating the
+timeout to the C value and calling C.
+
+The exact semantics are as in the following rules, all of which will be
+applied to the watcher:
+
+=over 4
+
+=item If the timer is pending, the pending status is always cleared.
-If the timer is pending, its pending status is cleared.
+=item If the timer is started but non-repeating, stop it (as if it timed
+out, without invoking it).
-If the timer is started but non-repeating, stop it (as if it timed out).
+=item If the timer is repeating, make the C value the new timeout
+and start the timer, if necessary.
-If the timer is repeating, either start it if necessary (with the
-C value), or reset the running timer to the C value.
+=back
-This sounds a bit complicated, see L, above, for a
+This sounds a bit complicated, see L , above, for a
usage example.
=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
@@ -2153,9 +2272,12 @@
C will try to run the callback in this mode at the next possible
time where C, regardless of any time jumps.
-For numerical stability it is preferable that the C value is near
-C (the current time), but there is no range requirement for
-this value, and in fact is often specified as zero.
+The C I be positive, and for numerical stability, the
+interval value should be higher than C<1/8192> (which is around 100
+microseconds) and C should be higher than C<0> and should have
+at most a similar magnitude as the current time (say, within a factor of
+ten). Typical values for offset are, in fact, C<0> or something between
+C<0> and C, which is also the recommended range.
Note also that there is an upper limit to how often a timer can fire (CPU
speed for example), so if C is very small then timing stability
@@ -2273,7 +2395,7 @@
ev_periodic_init (&hourly_tick, clock_cb,
fmod (ev_now (loop), 3600.), 3600., 0);
ev_periodic_start (loop, &hourly_tick);
-
+
=head2 C - signal me when a signal gets signalled!
@@ -2293,9 +2415,9 @@
C in both the default loop and another loop at the same time. At
the moment, C is permanently tied to the default loop.
-When the first watcher gets started will libev actually register something
-with the kernel (thus it coexists with your own signal handlers as long as
-you don't register any with libev for the same signal).
+Only after the first watcher for a signal is started will libev actually
+register something with the kernel. It thus coexists with your own signal
+handlers as long as you don't register any with libev for the same signal.
If possible and supported, libev will install its handlers with
C (or equivalent) behaviour enabled, so system calls should
@@ -2490,8 +2612,9 @@
This watches a file system path for attribute changes. That is, it calls
C on that path in regular intervals (or when the OS says it changed)
-and sees if it changed compared to the last time, invoking the callback if
-it did.
+and sees if it changed compared to the last time, invoking the callback
+if it did. Starting the watcher C's the file, so only changes that
+happen after the watcher has been started will be reported.
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
@@ -2731,6 +2854,20 @@
"pseudo-background processing", or delay processing stuff to after the
event loop has handled all outstanding events.
+=head3 Abusing an C watcher for its side-effect
+
+As long as there is at least one active idle watcher, libev will never
+sleep unnecessarily. Or in other words, it will loop as fast as possible.
+For this to work, the idle watcher doesn't need to be invoked at all - the
+lowest priority will do.
+
+This mode of operation can be useful together with an C watcher,
+to do something on each event loop iteration - for example to balance load
+between different connections.
+
+See L for a longer
+example.
+
=head3 Watcher-Specific Functions and Data Members
=over 4
@@ -2751,7 +2888,12 @@
static void
idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
{
+ // stop the watcher
+ ev_idle_stop (loop, w);
+
+ // now we can free it
free (w);
+
// now do something you wanted to do when the program has
// no longer anything immediate to do.
}
@@ -2763,7 +2905,7 @@
=head2 C and C - customise your event loop!
-Prepare and check watchers are usually (but not always) used in pairs:
+Prepare and check watchers are often (but not always) used in pairs:
prepare watchers get invoked before the process blocks and check watchers
afterwards.
@@ -2801,9 +2943,10 @@
loop from blocking if lower-priority coroutines are active, thus mapping
low-priority coroutines to idle/background tasks).
-It is recommended to give C watchers highest (C)
-priority, to ensure that they are being run before any other watchers
-after the poll (this doesn't matter for C watchers).
+When used for this purpose, it is recommended to give C watchers
+highest (C) priority, to ensure that they are being run before
+any other watchers after the poll (this doesn't matter for C
+watchers).
Also, C watchers (and C watchers, too) should not
activate ("feed") events into libev. While libev fully supports this, they
@@ -2813,6 +2956,25 @@
C watcher ran (always remind yourself to coexist peacefully with
others).
+=head3 Abusing an C watcher for its side-effect
+
+C (and less often also C) watchers can also be
+useful because they are called once per event loop iteration. For
+example, if you want to handle a large number of connections fairly, you
+normally only do a bit of work for each active connection, and if there
+is more work to do, you wait for the next event loop iteration, so other
+connections have a chance of making progress.
+
+Using an C watcher is almost enough: it will be called on the
+next event loop iteration. However, that isn't as soon as possible -
+without external events, your C watcher will not be invoked.
+
+This is where C watchers come in handy - all you need is a
+single global idle watcher that is active as long as you have one active
+C watcher. The C watcher makes sure the event loop
+will not sleep, and the C watcher makes sure a callback gets
+invoked. Neither watcher alone can do that.
+
=head3 Watcher-Specific Functions and Data Members
=over 4
@@ -3022,7 +3184,7 @@
=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
-=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)
+=item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)
Configures the watcher to embed the given loop, which must be
embeddable. If the callback is C<0>, then C will be
@@ -3053,7 +3215,7 @@
struct ev_loop *loop_hi = ev_default_init (0);
struct ev_loop *loop_lo = 0;
ev_embed embed;
-
+
// see if there is a chance of getting one that works
// (remember that a flags value of 0 means autodetection)
loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
@@ -3077,7 +3239,7 @@
struct ev_loop *loop = ev_default_init (0);
struct ev_loop *loop_socket = 0;
ev_embed embed;
-
+
if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
{
@@ -3095,11 +3257,11 @@
Fork watchers are called when a C was detected (usually because
whoever is a good citizen cared to tell libev about it by calling
-C or C). The invocation is done before the
-event loop blocks next and before C watchers are being called,
-and only in the child after the fork. If whoever good citizen calling
-C cheats and calls it in the wrong process, the fork
-handlers will be invoked, too, of course.
+C). The invocation is done before the event loop blocks next
+and before C watchers are being called, and only in the child
+after the fork. If whoever good citizen calling C cheats
+and calls it in the wrong process, the fork handlers will be invoked, too,
+of course.
=head3 The special problem of life after fork - how is it possible?
@@ -3202,14 +3364,11 @@
This functionality is very similar to C watchers, as signals,
too, are asynchronous in nature, and signals, too, will be compressed
(i.e. the number of callback invocations may be less than the number of
-C calls). In fact, you could use signal watchers as a kind
+C calls). In fact, you could use signal watchers as a kind
of "global async watchers" by using a watcher on an otherwise unused
signal, and C to signal this watcher from another thread,
even without knowing which loop owns the signal.
-Unlike C watchers, C works with any event loop, not
-just the default loop.
-
=head3 Queueing
C does not support queueing of data in any way. The reason
@@ -3318,13 +3477,16 @@
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 watchers are level-triggered, set on C,
-reset when the event loop detects that).
-
-This call incurs the overhead of a system call only once per event loop
-iteration, so while the overhead might be noticeable, it doesn't apply to
-repeated calls to C for the same event loop.
+compressed into a single callback invocation (another way to look at
+this is that C watchers are level-triggered: they are set on
+C, reset when the event loop detects that).
+
+This call incurs the overhead of at most one extra system call per event
+loop iteration, if the event loop is blocked, and no syscall at all if
+the event loop (or your program) is processing events. That means that
+repeated calls are basically free (there is no need to avoid calls for
+performance reasons) and that the overhead becomes smaller (typically
+zero) under load.
=item bool = ev_async_pending (ev_async *)
@@ -3389,7 +3551,7 @@
=item ev_feed_fd_event (loop, int fd, int revents)
Feed an event on the given fd, as if a file descriptor backend detected
-the given events it.
+the given events.
=item ev_feed_signal_event (loop, int signum)
@@ -3473,6 +3635,46 @@
(((char *)w) - offsetof (struct my_biggy, t2));
}
+=head2 AVOIDING FINISHING BEFORE RETURNING
+
+Often you have structures like this in event-based programs:
+
+ callback ()
+ {
+ free (request);
+ }
+
+ request = start_new_request (..., callback);
+
+The intent is to start some "lengthy" operation. The C could be
+used to cancel the operation, or do other things with it.
+
+It's not uncommon to have code paths in C that
+immediately invoke the callback, for example, to report errors. Or you add
+some caching layer that finds that it can skip the lengthy aspects of the
+operation and simply invoke the callback with the result.
+
+The problem here is that this will happen I C
+has returned, so C is not set.
+
+Even if you pass the request by some safer means to the callback, you
+might want to do something to the request after starting it, such as
+canceling it, which probably isn't working so well when the callback has
+already been invoked.
+
+A common way around all these issues is to make sure that
+C I returns before the callback is invoked. If
+C immediately knows the result, it can artificially
+delay invoking the callback by using a C or C watcher for
+example, or more sneakily, by reusing an existing (stopped) watcher and
+pushing it into the pending queue:
+
+ ev_set_cb (watcher, callback);
+ ev_feed_event (EV_A_ watcher, 0);
+
+This way, C can safely return before the callback is
+invoked, while not delaying callback invocation too much.
+
=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
Often (especially in GUI toolkits) there are places where you have
@@ -3483,7 +3685,7 @@
main C call, but not the nested one (e.g. user clicked "Quit", but
a modal "Are you sure?" dialog is still waiting), or just the nested one
and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
-other combination: In these cases, C will not work alone.
+other combination: In these cases, a simple C will not work.
The solution is to maintain "break this loop" variable for each C
invocation, and use a loop around C until the condition is
@@ -3495,7 +3697,7 @@
while (!exit_main_loop)
ev_run (EV_DEFAULT_ EVRUN_ONCE);
- // in a model watcher
+ // in a modal watcher
int exit_nested_loop = 0;
while (!exit_nested_loop)
@@ -3679,20 +3881,20 @@
void
wait_for_event (ev_watcher *w)
{
- ev_cb_set (w) = current_coro;
+ ev_set_cb (w, current_coro);
switch_to (libev_coro);
}
That basically suspends the coroutine inside C and
continues the libev coroutine, which, when appropriate, switches back to
-this or any other coroutine. I am sure if you sue this your own :)
+this or any other coroutine.
You can do similar tricks if you have, say, threads with an event queue -
instead of storing a coroutine, you store the queue object and instead of
switching to a coroutine, you push the watcher onto the queue and notify
any waiters.
-To embed libev, see L, but in short, it's easiest to create two
+To embed libev, see L , but in short, it's easiest to create two
files, F and F that include the respective libev files:
// my_ev.h
@@ -3746,12 +3948,45 @@
=head1 C++ SUPPORT
+=head2 C API
+
+The normal C API should work fine when used from C++: both ev.h and the
+libev sources can be compiled as C++. Therefore, code that uses the C API
+will work fine.
+
+Proper exception specifications might have to be added to callbacks passed
+to libev: exceptions may be thrown only from watcher callbacks, all
+other callbacks (allocator, syserr, loop acquire/release and periodic
+reschedule callbacks) must not throw exceptions, and might need a C specification. If you have code that needs to be compiled as both C
+and C++ you can use the C macro for this:
+
+ static void
+ fatal_error (const char *msg) EV_THROW
+ {
+ perror (msg);
+ abort ();
+ }
+
+ ...
+ ev_set_syserr_cb (fatal_error);
+
+The only API functions that can currently throw exceptions are C,
+C, C and C (the latter
+because it runs cleanup watchers).
+
+Throwing exceptions in watcher callbacks is only supported if libev itself
+is compiled with a C++ compiler or your C and C++ environments allow
+throwing exceptions through C libraries (most do).
+
+=head2 C++ API
+
Libev comes with some simplistic wrapper classes for C++ that mainly allow
you to use some convenience methods to start/stop watchers and also change
the callback model to a model using method callbacks on objects.
To use it,
-
+
#include
This automatically includes F and puts all of its definitions (many
@@ -3770,6 +4005,10 @@
you need support for other types of functors please contact the author
(preferably after implementing it).
+For all this to work, your C++ compiler either has to use the same calling
+conventions as your C compiler (for static member functions), or you have
+to embed libev and compile libev itself as C++.
+
Here is a list of things available in the C namespace:
=over 4
@@ -3788,7 +4027,7 @@
For each C watcher in F there is a corresponding class of
the same name in the C namespace, with the exception of C
which is called C to avoid clashes with the C macro
-defines by many implementations.
+defined by many implementations.
All of those classes have these methods:
@@ -3860,7 +4099,7 @@
...
}
}
-
+
myfunctor f;
ev::io w;
@@ -3888,10 +4127,14 @@
=item w->set ([arguments])
-Basically the same as C, with the same arguments. Either this
-method or a suitable start method must be called at least once. Unlike the
-C counterpart, an active watcher gets automatically stopped and restarted
-when reconfiguring it with this method.
+Basically the same as C (except for C watchers>),
+with the same arguments. Either this method or a suitable start method
+must be called at least once. Unlike the C counterpart, an active watcher
+gets automatically stopped and restarted when reconfiguring it with this
+method.
+
+For C watchers this method is called C, to avoid
+clashing with the C method.
=item w->start ()
@@ -3931,7 +4174,7 @@
class myclass
{
ev::io io ; void io_cb (ev::io &w, int revents);
- ev::io2 io2 ; void io2_cb (ev::io &w, int revents);
+ ev::io io2 ; void io2_cb (ev::io &w, int revents);
ev::idle idle; void idle_cb (ev::idle &w, int revents);
myclass (int fd)
@@ -3992,7 +4235,7 @@
=item D
Leandro Lucarella has written a D language binding (F) for libev, to
-be found at L.
+be found at L.
=item Ocaml
@@ -4005,6 +4248,14 @@
time of this writing, only C and C), to be found at
L.
+=item Javascript
+
+Node.js (L) uses libev as the underlying event library.
+
+=item Others
+
+There are others, and I stopped counting.
+
=back
@@ -4050,7 +4301,11 @@
=item C, C
Similar to the other two macros, this gives you the value of the default
-loop, if multiple loops are supported ("ev loop default").
+loop, if multiple loops are supported ("ev loop default"). The default loop
+will be initialised if it isn't already initialised.
+
+For non-multiplicity builds, these macros do nothing, so you always have
+to initialise the loop somewhere.
=item C, C
@@ -4206,6 +4461,15 @@
In standalone mode, libev will still try to automatically deduce the
configuration, but has to be more conservative.
+=item EV_USE_FLOOR
+
+If defined to be C<1>, libev will use the C function for its
+periodic reschedule calculations, otherwise libev will fall back on a
+portable (slower) implementation. If you enable this, you usually have to
+link against libm or something equivalent. Enabling this when the C
+function is not available will fail, so the safe default is to not enable
+this.
+
=item EV_USE_MONOTONIC
If defined to be C<1>, libev will try to detect the availability of the
@@ -4300,6 +4564,13 @@
file descriptors again. Note that the replacement function has to close
the underlying OS handle.
+=item EV_USE_WSASOCKET
+
+If defined to be C<1>, libev will use C to create its internal
+communication socket, which works better in some environments. Otherwise,
+the normal C function will be used, which works better in other
+environments.
+
=item EV_USE_POLL
If defined to be C<1>, libev will compile in support for the C(2)
@@ -4344,13 +4615,28 @@
be detected at runtime. If undefined, it will be enabled if the headers
indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
+=item EV_NO_SMP
+
+If defined to be C<1>, libev will assume that memory is always coherent
+between threads, that is, threads can be used, but threads never run on
+different cpus (or different cpu cores). This reduces dependencies
+and makes libev faster.
+
+=item EV_NO_THREADS
+
+If defined to be C<1>, libev will assume that it will never be called from
+different threads (that includes signal handlers), which is a stronger
+assumption than C, above. This reduces dependencies and makes
+libev faster.
+
=item EV_ATOMIC_T
Libev requires an integer type (suitable for storing C<0> or C<1>) whose
-access is atomic with respect to other threads or signal contexts. No such
-type is easily found in the C language, so you can provide your own type
-that you know is safe for your purposes. It is used both for signal handler "locking"
-as well as for signal and thread safety in C watchers.
+access is atomic with respect to other threads or signal contexts. No
+such type is easily found in the C language, so you can provide your own
+type that you know is safe for your purposes. It is used both for signal
+handler "locking" as well as for signal and thread safety in C
+watchers.
In the absence of this define, libev will use C
(from F), which is usually good enough on most platforms.
@@ -4387,6 +4673,10 @@
for multiple event loops and there is no first event loop pointer
argument. Instead, all functions act on the single default loop.
+Note that C and C