ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.pod
(Generate patch)

Comparing libev/ev.pod (file contents):
Revision 1.245 by root, Tue Jun 30 06:24:38 2009 UTC vs.
Revision 1.259 by root, Sun Jul 19 01:36:34 2009 UTC

620happily wraps around with enough iterations. 620happily wraps around with enough iterations.
621 621
622This value can sometimes be useful as a generation counter of sorts (it 622This value can sometimes be useful as a generation counter of sorts (it
623"ticks" the number of loop iterations), as it roughly corresponds with 623"ticks" the number of loop iterations), as it roughly corresponds with
624C<ev_prepare> and C<ev_check> calls. 624C<ev_prepare> and C<ev_check> calls.
625
626=item unsigned int ev_loop_depth (loop)
627
628Returns the number of times C<ev_loop> was entered minus the number of
629times C<ev_loop> was exited, in other words, the recursion depth.
630
631Outside C<ev_loop>, this number is zero. In a callback, this number is
632C<1>, unless C<ev_loop> was invoked recursively (or from another thread),
633in which case it is higher.
634
635Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread
636etc.), doesn't count as exit.
625 637
626=item unsigned int ev_backend (loop) 638=item unsigned int ev_backend (loop)
627 639
628Returns one of the C<EVBACKEND_*> flags indicating the event backend in 640Returns one of the C<EVBACKEND_*> flags indicating the event backend in
629use. 641use.
844more often than 100 times per second: 856more often than 100 times per second:
845 857
846 ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1); 858 ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1);
847 ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01); 859 ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
848 860
861=item ev_invoke_pending (loop)
862
863This call will simply invoke all pending watchers while resetting their
864pending state. Normally, C<ev_loop> does this automatically when required,
865but when overriding the invoke callback this call comes handy.
866
867=item int ev_pending_count (loop)
868
869Returns the number of pending watchers - zero indicates that no watchers
870are pending.
871
872=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
873
874This overrides the invoke pending functionality of the loop: Instead of
875invoking all pending watchers when there are any, C<ev_loop> will call
876this callback instead. This is useful, for example, when you want to
877invoke the actual watchers inside another context (another thread etc.).
878
879If you want to reset the callback, use C<ev_invoke_pending> as new
880callback.
881
882=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))
883
884Sometimes you want to share the same loop between multiple threads. This
885can be done relatively simply by putting mutex_lock/unlock calls around
886each call to a libev function.
887
888However, C<ev_loop> can run an indefinite time, so it is not feasible to
889wait for it to return. One way around this is to wake up the loop via
890C<ev_unloop> and C<av_async_send>, another way is to set these I<release>
891and I<acquire> callbacks on the loop.
892
893When set, then C<release> will be called just before the thread is
894suspended waiting for new events, and C<acquire> is called just
895afterwards.
896
897Ideally, C<release> will just call your mutex_unlock function, and
898C<acquire> will just call the mutex_lock function again.
899
900While event loop modifications are allowed between invocations of
901C<release> and C<acquire> (that's their only purpose after all), no
902modifications done will affect the event loop, i.e. adding watchers will
903have no effect on the set of file descriptors being watched, or the time
904waited. USe an C<ev_async> watcher to wake up C<ev_loop> when you want it
905to take note of any changes you made.
906
907In theory, threads executing C<ev_loop> will be async-cancel safe between
908invocations of C<release> and C<acquire>.
909
910See also the locking example in the C<THREADS> section later in this
911document.
912
913=item ev_set_userdata (loop, void *data)
914
915=item ev_userdata (loop)
916
917Set and retrieve a single C<void *> associated with a loop. When
918C<ev_set_userdata> has never been called, then C<ev_userdata> returns
919C<0.>
920
921These two functions can be used to associate arbitrary data with a loop,
922and are intended solely for the C<invoke_pending_cb>, C<release> and
923C<acquire> callbacks described above, but of course can be (ab-)used for
924any other purpose as well.
925
849=item ev_loop_verify (loop) 926=item ev_loop_verify (loop)
850 927
851This function only does something when C<EV_VERIFY> support has been 928This function only does something when C<EV_VERIFY> support has been
852compiled in, which is the default for non-minimal builds. It tries to go 929compiled in, which is the default for non-minimal builds. It tries to go
853through all internal structures and checks them for validity. If anything 930through all internal structures and checks them for validity. If anything
1480 1557
1481The callback is guaranteed to be invoked only I<after> its timeout has 1558The callback is guaranteed to be invoked only I<after> its timeout has
1482passed (not I<at>, so on systems with very low-resolution clocks this 1559passed (not I<at>, so on systems with very low-resolution clocks this
1483might introduce a small delay). If multiple timers become ready during the 1560might introduce a small delay). If multiple timers become ready during the
1484same loop iteration then the ones with earlier time-out values are invoked 1561same loop iteration then the ones with earlier time-out values are invoked
1485before ones with later time-out values (but this is no longer true when a 1562before ones of the same priority with later time-out values (but this is
1486callback calls C<ev_loop> recursively). 1563no longer true when a callback calls C<ev_loop> recursively).
1487 1564
1488=head3 Be smart about timeouts 1565=head3 Be smart about timeouts
1489 1566
1490Many real-world problems involve some kind of timeout, usually for error 1567Many real-world problems involve some kind of timeout, usually for error
1491recovery. A typical example is an HTTP request - if the other side hangs, 1568recovery. A typical example is an HTTP request - if the other side hangs,
1678 1755
1679If the event loop is suspended for a long time, you can also force an 1756If the event loop is suspended for a long time, you can also force an
1680update of the time returned by C<ev_now ()> by calling C<ev_now_update 1757update of the time returned by C<ev_now ()> by calling C<ev_now_update
1681()>. 1758()>.
1682 1759
1760=head3 The special problems of suspended animation
1761
1762When you leave the server world it is quite customary to hit machines that
1763can suspend/hibernate - what happens to the clocks during such a suspend?
1764
1765Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes
1766all processes, while the clocks (C<times>, C<CLOCK_MONOTONIC>) continue
1767to run until the system is suspended, but they will not advance while the
1768system is suspended. That means, on resume, it will be as if the program
1769was frozen for a few seconds, but the suspend time will not be counted
1770towards C<ev_timer> when a monotonic clock source is used. The real time
1771clock advanced as expected, but if it is used as sole clocksource, then a
1772long suspend would be detected as a time jump by libev, and timers would
1773be adjusted accordingly.
1774
1775I would not be surprised to see different behaviour in different between
1776operating systems, OS versions or even different hardware.
1777
1778The other form of suspend (job control, or sending a SIGSTOP) will see a
1779time jump in the monotonic clocks and the realtime clock. If the program
1780is suspended for a very long time, and monotonic clock sources are in use,
1781then you can expect C<ev_timer>s to expire as the full suspension time
1782will be counted towards the timers. When no monotonic clock source is in
1783use, then libev will again assume a timejump and adjust accordingly.
1784
1785It might be beneficial for this latter case to call C<ev_suspend>
1786and C<ev_resume> in code that handles C<SIGTSTP>, to at least get
1787deterministic behaviour in this case (you can do nothing against
1788C<SIGSTOP>).
1789
1683=head3 Watcher-Specific Functions and Data Members 1790=head3 Watcher-Specific Functions and Data Members
1684 1791
1685=over 4 1792=over 4
1686 1793
1687=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 1794=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
1712If the timer is repeating, either start it if necessary (with the 1819If the timer is repeating, either start it if necessary (with the
1713C<repeat> value), or reset the running timer to the C<repeat> value. 1820C<repeat> value), or reset the running timer to the C<repeat> value.
1714 1821
1715This sounds a bit complicated, see L<Be smart about timeouts>, above, for a 1822This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1716usage example. 1823usage example.
1824
1825=item ev_timer_remaining (loop, ev_timer *)
1826
1827Returns the remaining time until a timer fires. If the timer is active,
1828then this time is relative to the current event loop time, otherwise it's
1829the timeout value currently configured.
1830
1831That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
1832C<5>. When the timer is started and one second passes, C<ev_timer_remain>
1833will return C<4>. When the timer expires and is restarted, it will return
1834roughly C<7> (likely slightly less as callback invocation takes some time,
1835too), and so on.
1717 1836
1718=item ev_tstamp repeat [read-write] 1837=item ev_tstamp repeat [read-write]
1719 1838
1720The current C<repeat> value. Will be used each time the watcher times out 1839The current C<repeat> value. Will be used each time the watcher times out
1721or C<ev_timer_again> is called, and determines the next timeout (if any), 1840or C<ev_timer_again> is called, and determines the next timeout (if any),
1957Signal watchers will trigger an event when the process receives a specific 2076Signal watchers will trigger an event when the process receives a specific
1958signal one or more times. Even though signals are very asynchronous, libev 2077signal one or more times. Even though signals are very asynchronous, libev
1959will try it's best to deliver signals synchronously, i.e. as part of the 2078will try it's best to deliver signals synchronously, i.e. as part of the
1960normal event processing, like any other event. 2079normal event processing, like any other event.
1961 2080
2081Note that only the default loop supports registering signal watchers
2082currently.
2083
1962If you want signals asynchronously, just use C<sigaction> as you would 2084If you want signals asynchronously, just use C<sigaction> as you would
1963do without libev and forget about sharing the signal. You can even use 2085do without libev and forget about sharing the signal. You can even use
1964C<ev_async> from a signal handler to synchronously wake up an event loop. 2086C<ev_async> from a signal handler to synchronously wake up an event loop.
1965 2087
1966You can configure as many watchers as you like per signal. Only when the 2088You can configure as many watchers as you like per signal. Only when the
1967first watcher gets started will libev actually register a signal handler 2089first watcher gets started will libev actually register something with
1968with the kernel (thus it coexists with your own signal handlers as long as 2090the kernel (thus it coexists with your own signal handlers as long as you
1969you don't register any with libev for the same signal). Similarly, when 2091don't register any with libev for the same signal).
1970the last signal watcher for a signal is stopped, libev will reset the 2092
1971signal handler to SIG_DFL (regardless of what it was set to before). 2093Both the signal mask state (C<sigprocmask>) and the signal handler state
2094(C<sigaction>) are unspecified after starting a signal watcher (and after
2095sotpping it again), that is, libev might or might not block the signal,
2096and might or might not set or restore the installed signal handler.
1972 2097
1973If possible and supported, libev will install its handlers with 2098If possible and supported, libev will install its handlers with
1974C<SA_RESTART> behaviour enabled, so system calls should not be unduly 2099C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
1975interrupted. If you have a problem with system calls getting interrupted by 2100not be unduly interrupted. If you have a problem with system calls getting
1976signals you can block all signals in an C<ev_check> watcher and unblock 2101interrupted by signals you can block all signals in an C<ev_check> watcher
1977them in an C<ev_prepare> watcher. 2102and unblock them in an C<ev_prepare> watcher.
1978 2103
1979=head3 Watcher-Specific Functions and Data Members 2104=head3 Watcher-Specific Functions and Data Members
1980 2105
1981=over 4 2106=over 4
1982 2107
2020in the next callback invocation is not. 2145in the next callback invocation is not.
2021 2146
2022Only the default event loop is capable of handling signals, and therefore 2147Only the default event loop is capable of handling signals, and therefore
2023you can only register child watchers in the default event loop. 2148you can only register child watchers in the default event loop.
2024 2149
2150Due to some design glitches inside libev, child watchers will always be
2151handled at maximum priority (their priority is set to C<EV_MAXPRI> by
2152libev)
2153
2025=head3 Process Interaction 2154=head3 Process Interaction
2026 2155
2027Libev grabs C<SIGCHLD> as soon as the default event loop is 2156Libev grabs C<SIGCHLD> as soon as the default event loop is
2028initialised. This is necessary to guarantee proper behaviour even if 2157initialised. This is necessary to guarantee proper behaviour even if the
2029the first child watcher is started after the child exits. The occurrence 2158first child watcher is started after the child exits. The occurrence
2030of C<SIGCHLD> is recorded asynchronously, but child reaping is done 2159of C<SIGCHLD> is recorded asynchronously, but child reaping is done
2031synchronously as part of the event loop processing. Libev always reaps all 2160synchronously as part of the event loop processing. Libev always reaps all
2032children, even ones not watched. 2161children, even ones not watched.
2033 2162
2034=head3 Overriding the Built-In Processing 2163=head3 Overriding the Built-In Processing
2044=head3 Stopping the Child Watcher 2173=head3 Stopping the Child Watcher
2045 2174
2046Currently, the child watcher never gets stopped, even when the 2175Currently, the child watcher never gets stopped, even when the
2047child terminates, so normally one needs to stop the watcher in the 2176child terminates, so normally one needs to stop the watcher in the
2048callback. Future versions of libev might stop the watcher automatically 2177callback. Future versions of libev might stop the watcher automatically
2049when a child exit is detected. 2178when a child exit is detected (calling C<ev_child_stop> twice is not a
2179problem).
2050 2180
2051=head3 Watcher-Specific Functions and Data Members 2181=head3 Watcher-Specific Functions and Data Members
2052 2182
2053=over 4 2183=over 4
2054 2184
3655defined to be C<0>, then they are not. 3785defined to be C<0>, then they are not.
3656 3786
3657=item EV_MINIMAL 3787=item EV_MINIMAL
3658 3788
3659If you need to shave off some kilobytes of code at the expense of some 3789If you need to shave off some kilobytes of code at the expense of some
3660speed, define this symbol to C<1>. Currently this is used to override some 3790speed (but with the full API), define this symbol to C<1>. Currently this
3661inlining decisions, saves roughly 30% code size on amd64. It also selects a 3791is used to override some inlining decisions, saves roughly 30% code size
3662much smaller 2-heap for timer management over the default 4-heap. 3792on amd64. It also selects a much smaller 2-heap for timer management over
3793the default 4-heap.
3794
3795You can save even more by disabling watcher types you do not need
3796and setting C<EV_MAXPRI> == C<EV_MINPRI>. Also, disabling C<assert>
3797(C<-DNDEBUG>) will usually reduce code size a lot.
3798
3799Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to
3800provide a bare-bones event library. See C<ev.h> for details on what parts
3801of the API are still available, and do not complain if this subset changes
3802over time.
3663 3803
3664=item EV_PID_HASHSIZE 3804=item EV_PID_HASHSIZE
3665 3805
3666C<ev_child> watchers use a small hash table to distribute workload by 3806C<ev_child> watchers use a small hash table to distribute workload by
3667pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more 3807pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
3853default loop and triggering an C<ev_async> watcher from the default loop 3993default loop and triggering an C<ev_async> watcher from the default loop
3854watcher callback into the event loop interested in the signal. 3994watcher callback into the event loop interested in the signal.
3855 3995
3856=back 3996=back
3857 3997
3998=head4 THREAD LOCKING EXAMPLE
3999
4000Here is a fictitious example of how to run an event loop in a different
4001thread than where callbacks are being invoked and watchers are
4002created/added/removed.
4003
4004For a real-world example, see the C<EV::Loop::Async> perl module,
4005which uses exactly this technique (which is suited for many high-level
4006languages).
4007
4008The example uses a pthread mutex to protect the loop data, a condition
4009variable to wait for callback invocations, an async watcher to notify the
4010event loop thread and an unspecified mechanism to wake up the main thread.
4011
4012First, you need to associate some data with the event loop:
4013
4014 typedef struct {
4015 mutex_t lock; /* global loop lock */
4016 ev_async async_w;
4017 thread_t tid;
4018 cond_t invoke_cv;
4019 } userdata;
4020
4021 void prepare_loop (EV_P)
4022 {
4023 // for simplicity, we use a static userdata struct.
4024 static userdata u;
4025
4026 ev_async_init (&u->async_w, async_cb);
4027 ev_async_start (EV_A_ &u->async_w);
4028
4029 pthread_mutex_init (&u->lock, 0);
4030 pthread_cond_init (&u->invoke_cv, 0);
4031
4032 // now associate this with the loop
4033 ev_set_userdata (EV_A_ u);
4034 ev_set_invoke_pending_cb (EV_A_ l_invoke);
4035 ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4036
4037 // then create the thread running ev_loop
4038 pthread_create (&u->tid, 0, l_run, EV_A);
4039 }
4040
4041The callback for the C<ev_async> watcher does nothing: the watcher is used
4042solely to wake up the event loop so it takes notice of any new watchers
4043that might have been added:
4044
4045 static void
4046 async_cb (EV_P_ ev_async *w, int revents)
4047 {
4048 // just used for the side effects
4049 }
4050
4051The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
4052protecting the loop data, respectively.
4053
4054 static void
4055 l_release (EV_P)
4056 {
4057 userdata *u = ev_userdata (EV_A);
4058 pthread_mutex_unlock (&u->lock);
4059 }
4060
4061 static void
4062 l_acquire (EV_P)
4063 {
4064 userdata *u = ev_userdata (EV_A);
4065 pthread_mutex_lock (&u->lock);
4066 }
4067
4068The event loop thread first acquires the mutex, and then jumps straight
4069into C<ev_loop>:
4070
4071 void *
4072 l_run (void *thr_arg)
4073 {
4074 struct ev_loop *loop = (struct ev_loop *)thr_arg;
4075
4076 l_acquire (EV_A);
4077 pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4078 ev_loop (EV_A_ 0);
4079 l_release (EV_A);
4080
4081 return 0;
4082 }
4083
4084Instead of invoking all pending watchers, the C<l_invoke> callback will
4085signal the main thread via some unspecified mechanism (signals? pipe
4086writes? C<Async::Interrupt>?) and then waits until all pending watchers
4087have been called (in a while loop because a) spurious wakeups are possible
4088and b) skipping inter-thread-communication when there are no pending
4089watchers is very beneficial):
4090
4091 static void
4092 l_invoke (EV_P)
4093 {
4094 userdata *u = ev_userdata (EV_A);
4095
4096 while (ev_pending_count (EV_A))
4097 {
4098 wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4099 pthread_cond_wait (&u->invoke_cv, &u->lock);
4100 }
4101 }
4102
4103Now, whenever the main thread gets told to invoke pending watchers, it
4104will grab the lock, call C<ev_invoke_pending> and then signal the loop
4105thread to continue:
4106
4107 static void
4108 real_invoke_pending (EV_P)
4109 {
4110 userdata *u = ev_userdata (EV_A);
4111
4112 pthread_mutex_lock (&u->lock);
4113 ev_invoke_pending (EV_A);
4114 pthread_cond_signal (&u->invoke_cv);
4115 pthread_mutex_unlock (&u->lock);
4116 }
4117
4118Whenever you want to start/stop a watcher or do other modifications to an
4119event loop, you will now have to lock:
4120
4121 ev_timer timeout_watcher;
4122 userdata *u = ev_userdata (EV_A);
4123
4124 ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4125
4126 pthread_mutex_lock (&u->lock);
4127 ev_timer_start (EV_A_ &timeout_watcher);
4128 ev_async_send (EV_A_ &u->async_w);
4129 pthread_mutex_unlock (&u->lock);
4130
4131Note that sending the C<ev_async> watcher is required because otherwise
4132an event loop currently blocking in the kernel will have no knowledge
4133about the newly added timer. By waking up the loop it will pick up any new
4134watchers in the next event loop iteration.
4135
3858=head3 COROUTINES 4136=head3 COROUTINES
3859 4137
3860Libev is very accommodating to coroutines ("cooperative threads"): 4138Libev is very accommodating to coroutines ("cooperative threads"):
3861libev fully supports nesting calls to its functions from different 4139libev fully supports nesting calls to its functions from different
3862coroutines (e.g. you can call C<ev_loop> on the same loop from two 4140coroutines (e.g. you can call C<ev_loop> on the same loop from two
3863different coroutines, and switch freely between both coroutines running the 4141different coroutines, and switch freely between both coroutines running
3864loop, as long as you don't confuse yourself). The only exception is that 4142the loop, as long as you don't confuse yourself). The only exception is
3865you must not do this from C<ev_periodic> reschedule callbacks. 4143that you must not do this from C<ev_periodic> reschedule callbacks.
3866 4144
3867Care has been taken to ensure that libev does not keep local state inside 4145Care has been taken to ensure that libev does not keep local state inside
3868C<ev_loop>, and other calls do not usually allow for coroutine switches as 4146C<ev_loop>, and other calls do not usually allow for coroutine switches as
3869they do not call any callbacks. 4147they do not call any callbacks.
3870 4148
4077=item C<double> must hold a time value in seconds with enough accuracy 4355=item C<double> must hold a time value in seconds with enough accuracy
4078 4356
4079The type C<double> is used to represent timestamps. It is required to 4357The type C<double> is used to represent timestamps. It is required to
4080have at least 51 bits of mantissa (and 9 bits of exponent), which is good 4358have at least 51 bits of mantissa (and 9 bits of exponent), which is good
4081enough for at least into the year 4000. This requirement is fulfilled by 4359enough for at least into the year 4000. This requirement is fulfilled by
4082implementations implementing IEEE 754 (basically all existing ones). 4360implementations implementing IEEE 754, which is basically all existing
4361ones. With IEEE 754 doubles, you get microsecond accuracy until at least
43622200.
4083 4363
4084=back 4364=back
4085 4365
4086If you know of other additional requirements drop me a note. 4366If you know of other additional requirements drop me a note.
4087 4367

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines