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

Comparing libev/ev.3 (file contents):
Revision 1.57 by root, Sat Dec 22 11:49:17 2007 UTC vs.
Revision 1.59 by root, Tue Dec 25 07:16:53 2007 UTC

127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "EV 1" 131.IX Title "EV 1"
132.TH EV 1 "2007-12-22" "perl v5.8.8" "User Contributed Perl Documentation" 132.TH EV 1 "2007-12-25" "perl v5.8.8" "User Contributed Perl Documentation"
133.SH "NAME" 133.SH "NAME"
134libev \- a high performance full\-featured event loop written in C 134libev \- a high performance full\-featured event loop written in C
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137.Vb 1 137.Vb 1
138\& #include <ev.h> 138\& #include <ev.h>
139.Ve 139.Ve
140.SH "EXAMPLE PROGRAM" 140.Sh "\s-1EXAMPLE\s0 \s-1PROGRAM\s0"
141.IX Header "EXAMPLE PROGRAM" 141.IX Subsection "EXAMPLE PROGRAM"
142.Vb 1 142.Vb 1
143\& #include <ev.h> 143\& #include <ev.h>
144.Ve 144.Ve
145.PP 145.PP
146.Vb 2 146.Vb 2
212.PP 212.PP
213You register interest in certain events by registering so-called \fIevent 213You register interest in certain events by registering so-called \fIevent
214watchers\fR, which are relatively small C structures you initialise with the 214watchers\fR, which are relatively small C structures you initialise with the
215details of the event, and then hand it over to libev by \fIstarting\fR the 215details of the event, and then hand it over to libev by \fIstarting\fR the
216watcher. 216watcher.
217.SH "FEATURES" 217.Sh "\s-1FEATURES\s0"
218.IX Header "FEATURES" 218.IX Subsection "FEATURES"
219Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the 219Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the
220BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms 220BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms
221for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface 221for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface
222(for \f(CW\*(C`ev_stat\*(C'\fR), relative timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers 222(for \f(CW\*(C`ev_stat\*(C'\fR), relative timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers
223with customised rescheduling (\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals 223with customised rescheduling (\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals
228(\f(CW\*(C`ev_fork\*(C'\fR). 228(\f(CW\*(C`ev_fork\*(C'\fR).
229.PP 229.PP
230It also is quite fast (see this 230It also is quite fast (see this
231benchmark comparing it to libevent 231benchmark comparing it to libevent
232for example). 232for example).
233.SH "CONVENTIONS" 233.Sh "\s-1CONVENTIONS\s0"
234.IX Header "CONVENTIONS" 234.IX Subsection "CONVENTIONS"
235Libev is very configurable. In this manual the default configuration will 235Libev is very configurable. In this manual the default configuration will
236be described, which supports multiple event loops. For more info about 236be described, which supports multiple event loops. For more info about
237various configuration options please have a look at \fB\s-1EMBED\s0\fR section in 237various configuration options please have a look at \fB\s-1EMBED\s0\fR section in
238this manual. If libev was configured without support for multiple event 238this manual. If libev was configured without support for multiple event
239loops, then all functions taking an initial argument of name \f(CW\*(C`loop\*(C'\fR 239loops, then all functions taking an initial argument of name \f(CW\*(C`loop\*(C'\fR
240(which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have this argument. 240(which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have this argument.
241.SH "TIME REPRESENTATION" 241.Sh "\s-1TIME\s0 \s-1REPRESENTATION\s0"
242.IX Header "TIME REPRESENTATION" 242.IX Subsection "TIME REPRESENTATION"
243Libev represents time as a single floating point number, representing the 243Libev represents time as a single floating point number, representing the
244(fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near 244(fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near
245the beginning of 1970, details are complicated, don't ask). This type is 245the beginning of 1970, details are complicated, don't ask). This type is
246called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually aliases 246called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually aliases
247to the \f(CW\*(C`double\*(C'\fR type in C, and when you need to do any calculations on 247to the \f(CW\*(C`double\*(C'\fR type in C, and when you need to do any calculations on
451.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 451.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4
452.IX Item "EVBACKEND_SELECT (value 1, portable select backend)" 452.IX Item "EVBACKEND_SELECT (value 1, portable select backend)"
453This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as 453This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as
454libev tries to roll its own fd_set with no limits on the number of fds, 454libev tries to roll its own fd_set with no limits on the number of fds,
455but if that fails, expect a fairly low limit on the number of fds when 455but if that fails, expect a fairly low limit on the number of fds when
456using this backend. It doesn't scale too well (O(highest_fd)), but its usually 456using this backend. It doesn't scale too well (O(highest_fd)), but its
457the fastest backend for a low number of fds. 457usually the fastest backend for a low number of (low\-numbered :) fds.
458.Sp
459To get good performance out of this backend you need a high amount of
460parallelity (most of the file descriptors should be busy). If you are
461writing a server, you should \f(CW\*(C`accept ()\*(C'\fR in a loop to accept as many
462connections as possible during one iteration. You might also want to have
463a look at \f(CW\*(C`ev_set_io_collect_interval ()\*(C'\fR to increase the amount of
464readyness notifications you get per iteration.
458.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4 465.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4
459.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4 466.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4
460.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)" 467.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)"
461And this is your standard \fIpoll\fR\|(2) backend. It's more complicated than 468And this is your standard \fIpoll\fR\|(2) backend. It's more complicated
462select, but handles sparse fds better and has no artificial limit on the 469than select, but handles sparse fds better and has no artificial
463number of fds you can use (except it will slow down considerably with a 470limit on the number of fds you can use (except it will slow down
464lot of inactive fds). It scales similarly to select, i.e. O(total_fds). 471considerably with a lot of inactive fds). It scales similarly to select,
472i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for
473performance tips.
465.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4 474.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4
466.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 475.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4
467.IX Item "EVBACKEND_EPOLL (value 4, Linux)" 476.IX Item "EVBACKEND_EPOLL (value 4, Linux)"
468For few fds, this backend is a bit little slower than poll and select, 477For few fds, this backend is a bit little slower than poll and select,
469but it scales phenomenally better. While poll and select usually scale 478but it scales phenomenally better. While poll and select usually scale
470like O(total_fds) where n is the total number of fds (or the highest fd), 479like O(total_fds) where n is the total number of fds (or the highest fd),
471epoll scales either O(1) or O(active_fds). The epoll design has a number 480epoll scales either O(1) or O(active_fds). The epoll design has a number
472of shortcomings, such as silently dropping events in some hard-to-detect 481of shortcomings, such as silently dropping events in some hard-to-detect
473cases and rewiring a syscall per fd change, no fork support and bad 482cases and rewiring a syscall per fd change, no fork support and bad
474support for dup: 483support for dup.
475.Sp 484.Sp
476While stopping, setting and starting an I/O watcher in the same iteration 485While stopping, setting and starting an I/O watcher in the same iteration
477will result in some caching, there is still a syscall per such incident 486will result in some caching, there is still a syscall per such incident
478(because the fd could point to a different file description now), so its 487(because the fd could point to a different file description now), so its
479best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors might not work 488best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors might not work
480very well if you register events for both fds. 489very well if you register events for both fds.
481.Sp 490.Sp
482Please note that epoll sometimes generates spurious notifications, so you 491Please note that epoll sometimes generates spurious notifications, so you
483need to use non-blocking I/O or other means to avoid blocking when no data 492need to use non-blocking I/O or other means to avoid blocking when no data
484(or space) is available. 493(or space) is available.
494.Sp
495Best performance from this backend is achieved by not unregistering all
496watchers for a file descriptor until it has been closed, if possible, i.e.
497keep at least one watcher active per fd at all times.
498.Sp
499While nominally embeddeble in other event loops, this feature is broken in
500all kernel versions tested so far.
485.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 501.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4
486.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4 502.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4
487.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" 503.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)"
488Kqueue deserves special mention, as at the time of this writing, it 504Kqueue deserves special mention, as at the time of this writing, it
489was broken on all BSDs except NetBSD (usually it doesn't work reliably 505was broken on all BSDs except NetBSD (usually it doesn't work reliably
501kernel is more efficient (which says nothing about its actual speed, of 517kernel is more efficient (which says nothing about its actual speed, of
502course). While stopping, setting and starting an I/O watcher does never 518course). While stopping, setting and starting an I/O watcher does never
503cause an extra syscall as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to 519cause an extra syscall as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to
504two event changes per incident, support for \f(CW\*(C`fork ()\*(C'\fR is very bad and it 520two event changes per incident, support for \f(CW\*(C`fork ()\*(C'\fR is very bad and it
505drops fds silently in similarly hard-to-detect cases. 521drops fds silently in similarly hard-to-detect cases.
522.Sp
523This backend usually performs well under most conditions.
524.Sp
525While nominally embeddable in other event loops, this doesn't work
526everywhere, so you might need to test for this. And since it is broken
527almost everywhere, you should only use it when you have a lot of sockets
528(for which it usually works), by embedding it into another event loop
529(e.g. \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR) and using it only for
530sockets.
506.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 531.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4
507.el .IP "\f(CWEVBACKEND_DEVPOLL\fR (value 16, Solaris 8)" 4 532.el .IP "\f(CWEVBACKEND_DEVPOLL\fR (value 16, Solaris 8)" 4
508.IX Item "EVBACKEND_DEVPOLL (value 16, Solaris 8)" 533.IX Item "EVBACKEND_DEVPOLL (value 16, Solaris 8)"
509This is not implemented yet (and might never be). 534This is not implemented yet (and might never be, unless you send me an
535implementation). According to reports, \f(CW\*(C`/dev/poll\*(C'\fR only supports sockets
536and is not embeddable, which would limit the usefulness of this backend
537immensely.
510.ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4 538.ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4
511.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 539.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4
512.IX Item "EVBACKEND_PORT (value 32, Solaris 10)" 540.IX Item "EVBACKEND_PORT (value 32, Solaris 10)"
513This uses the Solaris 10 event port mechanism. As with everything on Solaris, 541This uses the Solaris 10 event port mechanism. As with everything on Solaris,
514it's really slow, but it still scales very well (O(active_fds)). 542it's really slow, but it still scales very well (O(active_fds)).
515.Sp 543.Sp
516Please note that solaris event ports can deliver a lot of spurious 544Please note that solaris event ports can deliver a lot of spurious
517notifications, so you need to use non-blocking I/O or other means to avoid 545notifications, so you need to use non-blocking I/O or other means to avoid
518blocking when no data (or space) is available. 546blocking when no data (or space) is available.
547.Sp
548While this backend scales well, it requires one system call per active
549file descriptor per loop iteration. For small and medium numbers of file
550descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend
551might perform better.
519.ie n .IP """EVBACKEND_ALL""" 4 552.ie n .IP """EVBACKEND_ALL""" 4
520.el .IP "\f(CWEVBACKEND_ALL\fR" 4 553.el .IP "\f(CWEVBACKEND_ALL\fR" 4
521.IX Item "EVBACKEND_ALL" 554.IX Item "EVBACKEND_ALL"
522Try all backends (even potentially broken ones that wouldn't be tried 555Try all backends (even potentially broken ones that wouldn't be tried
523with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as 556with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as
524\&\f(CW\*(C`EVBACKEND_ALL & ~EVBACKEND_KQUEUE\*(C'\fR. 557\&\f(CW\*(C`EVBACKEND_ALL & ~EVBACKEND_KQUEUE\*(C'\fR.
558.Sp
559It is definitely not recommended to use this flag.
525.RE 560.RE
526.RS 4 561.RS 4
527.Sp 562.Sp
528If one or more of these are ored into the flags value, then only these 563If one or more of these are ored into the flags value, then only these
529backends will be tried (in the reverse order as given here). If none are 564backends will be tried (in the reverse order as given here). If none are
755overhead for the actual polling but can deliver many events at once. 790overhead for the actual polling but can deliver many events at once.
756.Sp 791.Sp
757By setting a higher \fIio collect interval\fR you allow libev to spend more 792By setting a higher \fIio collect interval\fR you allow libev to spend more
758time collecting I/O events, so you can handle more events per iteration, 793time collecting I/O events, so you can handle more events per iteration,
759at the cost of increasing latency. Timeouts (both \f(CW\*(C`ev_periodic\*(C'\fR and 794at the cost of increasing latency. Timeouts (both \f(CW\*(C`ev_periodic\*(C'\fR and
760\&\f(CW\*(C`ev_timer\*(C'\fR) will be not affected. Setting this to a non-null bvalue will 795\&\f(CW\*(C`ev_timer\*(C'\fR) will be not affected. Setting this to a non-null value will
761introduce an additional \f(CW\*(C`ev_sleep ()\*(C'\fR call into most loop iterations. 796introduce an additional \f(CW\*(C`ev_sleep ()\*(C'\fR call into most loop iterations.
762.Sp 797.Sp
763Likewise, by setting a higher \fItimeout collect interval\fR you allow libev 798Likewise, by setting a higher \fItimeout collect interval\fR you allow libev
764to spend more time collecting timeouts, at the expense of increased 799to spend more time collecting timeouts, at the expense of increased
765latency (the watcher callback will be called later). \f(CW\*(C`ev_io\*(C'\fR watchers 800latency (the watcher callback will be called later). \f(CW\*(C`ev_io\*(C'\fR watchers
1103In general you can register as many read and/or write event watchers per 1138In general you can register as many read and/or write event watchers per
1104fd as you want (as long as you don't confuse yourself). Setting all file 1139fd as you want (as long as you don't confuse yourself). Setting all file
1105descriptors to non-blocking mode is also usually a good idea (but not 1140descriptors to non-blocking mode is also usually a good idea (but not
1106required if you know what you are doing). 1141required if you know what you are doing).
1107.PP 1142.PP
1108You have to be careful with dup'ed file descriptors, though. Some backends
1109(the linux epoll backend is a notable example) cannot handle dup'ed file
1110descriptors correctly if you register interest in two or more fds pointing
1111to the same underlying file/socket/etc. description (that is, they share
1112the same underlying \*(L"file open\*(R").
1113.PP
1114If you must do this, then force the use of a known-to-be-good backend 1143If you must do this, then force the use of a known-to-be-good backend
1115(at the time of this writing, this includes only \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and 1144(at the time of this writing, this includes only \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and
1116\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR). 1145\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR).
1117.PP 1146.PP
1118Another thing you have to watch out for is that it is quite easy to 1147Another thing you have to watch out for is that it is quite easy to
1154.PP 1183.PP
1155\fIThe special problem of dup'ed file descriptors\fR 1184\fIThe special problem of dup'ed file descriptors\fR
1156.IX Subsection "The special problem of dup'ed file descriptors" 1185.IX Subsection "The special problem of dup'ed file descriptors"
1157.PP 1186.PP
1158Some backends (e.g. epoll), cannot register events for file descriptors, 1187Some backends (e.g. epoll), cannot register events for file descriptors,
1159but only events for the underlying file descriptions. That menas when you 1188but only events for the underlying file descriptions. That means when you
1160have \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors and register events for them, only one 1189have \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors or weirder constellations, and register
1161file descriptor might actually receive events. 1190events for them, only one file descriptor might actually receive events.
1162.PP 1191.PP
1163There is no workaorund possible except not registering events 1192There is no workaround possible except not registering events
1164for potentially \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors or to resort to 1193for potentially \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors, or to resort to
1165\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 1194\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1166.PP 1195.PP
1167\fIThe special problem of fork\fR 1196\fIThe special problem of fork\fR
1168.IX Subsection "The special problem of fork" 1197.IX Subsection "The special problem of fork"
1169.PP 1198.PP
1624reader). Inotify will be used to give hints only and should not change the 1653reader). Inotify will be used to give hints only and should not change the
1625semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs 1654semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs
1626to fall back to regular polling again even with inotify, but changes are 1655to fall back to regular polling again even with inotify, but changes are
1627usually detected immediately, and if the file exists there will be no 1656usually detected immediately, and if the file exists there will be no
1628polling. 1657polling.
1658.PP
1659\fIInotify\fR
1660.IX Subsection "Inotify"
1661.PP
1662When \f(CW\*(C`inotify (7)\*(C'\fR support has been compiled into libev (generally only
1663available on Linux) and present at runtime, it will be used to speed up
1664change detection where possible. The inotify descriptor will be created lazily
1665when the first \f(CW\*(C`ev_stat\*(C'\fR watcher is being started.
1666.PP
1667Inotify presense does not change the semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers
1668except that changes might be detected earlier, and in some cases, to avoid
1669making regular \f(CW\*(C`stat\*(C'\fR calls. Even in the presense of inotify support
1670there are many cases where libev has to resort to regular \f(CW\*(C`stat\*(C'\fR polling.
1671.PP
1672(There is no support for kqueue, as apparently it cannot be used to
1673implement this functionality, due to the requirement of having a file
1674descriptor open on the object at all times).
1675.PP
1676\fIThe special problem of stat time resolution\fR
1677.IX Subsection "The special problem of stat time resolution"
1678.PP
1679The \f(CW\*(C`stat ()\*(C'\fR syscall only supports full-second resolution portably, and
1680even on systems where the resolution is higher, many filesystems still
1681only support whole seconds.
1682.PP
1683That means that, if the time is the only thing that changes, you might
1684miss updates: on the first update, \f(CW\*(C`ev_stat\*(C'\fR detects a change and calls
1685your callback, which does something. When there is another update within
1686the same second, \f(CW\*(C`ev_stat\*(C'\fR will be unable to detect it.
1687.PP
1688The solution to this is to delay acting on a change for a second (or till
1689the next second boundary), using a roughly one-second delay \f(CW\*(C`ev_timer\*(C'\fR
1690(\f(CW\*(C`ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)\*(C'\fR). The \f(CW.01\fR
1691is added to work around small timing inconsistencies of some operating
1692systems.
1629.PP 1693.PP
1630\fIWatcher-Specific Functions and Data Members\fR 1694\fIWatcher-Specific Functions and Data Members\fR
1631.IX Subsection "Watcher-Specific Functions and Data Members" 1695.IX Subsection "Watcher-Specific Functions and Data Members"
1632.IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 1696.IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4
1633.IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 1697.IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)"
1665The specified interval. 1729The specified interval.
1666.IP "const char *path [read\-only]" 4 1730.IP "const char *path [read\-only]" 4
1667.IX Item "const char *path [read-only]" 1731.IX Item "const char *path [read-only]"
1668The filesystem path that is being watched. 1732The filesystem path that is being watched.
1669.PP 1733.PP
1734\fIExamples\fR
1735.IX Subsection "Examples"
1736.PP
1670Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes. 1737Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes.
1671.PP 1738.PP
1672.Vb 15 1739.Vb 15
1673\& static void 1740\& static void
1674\& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) 1741\& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1691\& ... 1758\& ...
1692\& ev_stat passwd; 1759\& ev_stat passwd;
1693.Ve 1760.Ve
1694.PP 1761.PP
1695.Vb 2 1762.Vb 2
1696\& ev_stat_init (&passwd, passwd_cb, "/etc/passwd"); 1763\& ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
1697\& ev_stat_start (loop, &passwd); 1764\& ev_stat_start (loop, &passwd);
1765.Ve
1766.PP
1767Example: Like above, but additionally use a one-second delay so we do not
1768miss updates (however, frequent updates will delay processing, too, so
1769one might do the work both on \f(CW\*(C`ev_stat\*(C'\fR callback invocation \fIand\fR on
1770\&\f(CW\*(C`ev_timer\*(C'\fR callback invocation).
1771.PP
1772.Vb 2
1773\& static ev_stat passwd;
1774\& static ev_timer timer;
1775.Ve
1776.PP
1777.Vb 4
1778\& static void
1779\& timer_cb (EV_P_ ev_timer *w, int revents)
1780\& {
1781\& ev_timer_stop (EV_A_ w);
1782.Ve
1783.PP
1784.Vb 2
1785\& /* now it's one second after the most recent passwd change */
1786\& }
1787.Ve
1788.PP
1789.Vb 6
1790\& static void
1791\& stat_cb (EV_P_ ev_stat *w, int revents)
1792\& {
1793\& /* reset the one-second timer */
1794\& ev_timer_again (EV_A_ &timer);
1795\& }
1796.Ve
1797.PP
1798.Vb 4
1799\& ...
1800\& ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1801\& ev_stat_start (loop, &passwd);
1802\& ev_timer_init (&timer, timer_cb, 0., 1.01);
1698.Ve 1803.Ve
1699.ie n .Sh """ev_idle"" \- when you've got nothing better to do..." 1804.ie n .Sh """ev_idle"" \- when you've got nothing better to do..."
1700.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." 1805.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..."
1701.IX Subsection "ev_idle - when you've got nothing better to do..." 1806.IX Subsection "ev_idle - when you've got nothing better to do..."
1702Idle watchers trigger events when no other events of the same or higher 1807Idle watchers trigger events when no other events of the same or higher
2598interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will 2703interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will
2599be detected at runtime. 2704be detected at runtime.
2600.IP "\s-1EV_H\s0" 4 2705.IP "\s-1EV_H\s0" 4
2601.IX Item "EV_H" 2706.IX Item "EV_H"
2602The name of the \fIev.h\fR header file used to include it. The default if 2707The name of the \fIev.h\fR header file used to include it. The default if
2603undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This 2708undefined is \f(CW"ev.h"\fR in \fIevent.h\fR and \fIev.c\fR. This can be used to
2604can be used to virtually rename the \fIev.h\fR header file in case of conflicts. 2709virtually rename the \fIev.h\fR header file in case of conflicts.
2605.IP "\s-1EV_CONFIG_H\s0" 4 2710.IP "\s-1EV_CONFIG_H\s0" 4
2606.IX Item "EV_CONFIG_H" 2711.IX Item "EV_CONFIG_H"
2607If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override 2712If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override
2608\&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to 2713\&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to
2609\&\f(CW\*(C`EV_H\*(C'\fR, above. 2714\&\f(CW\*(C`EV_H\*(C'\fR, above.
2610.IP "\s-1EV_EVENT_H\s0" 4 2715.IP "\s-1EV_EVENT_H\s0" 4
2611.IX Item "EV_EVENT_H" 2716.IX Item "EV_EVENT_H"
2612Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea 2717Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea
2613of how the \fIevent.h\fR header can be found. 2718of how the \fIevent.h\fR header can be found, the dfeault is \f(CW"event.h"\fR.
2614.IP "\s-1EV_PROTOTYPES\s0" 4 2719.IP "\s-1EV_PROTOTYPES\s0" 4
2615.IX Item "EV_PROTOTYPES" 2720.IX Item "EV_PROTOTYPES"
2616If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function 2721If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function
2617prototypes, but still define all the structs and other symbols. This is 2722prototypes, but still define all the structs and other symbols. This is
2618occasionally useful if you want to provide your own wrapper functions 2723occasionally useful if you want to provide your own wrapper functions
2675pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more 2780pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more
2676than enough. If you need to manage thousands of children you might want to 2781than enough. If you need to manage thousands of children you might want to
2677increase this value (\fImust\fR be a power of two). 2782increase this value (\fImust\fR be a power of two).
2678.IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4 2783.IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4
2679.IX Item "EV_INOTIFY_HASHSIZE" 2784.IX Item "EV_INOTIFY_HASHSIZE"
2680\&\f(CW\*(C`ev_staz\*(C'\fR watchers use a small hash table to distribute workload by 2785\&\f(CW\*(C`ev_stat\*(C'\fR watchers use a small hash table to distribute workload by
2681inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), 2786inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR),
2682usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR 2787usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR
2683watchers you might want to increase this value (\fImust\fR be a power of 2788watchers you might want to increase this value (\fImust\fR be a power of
2684two). 2789two).
2685.IP "\s-1EV_COMMON\s0" 4 2790.IP "\s-1EV_COMMON\s0" 4
2789.RS 4 2894.RS 4
2790.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 2895.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4
2791.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 2896.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)"
2792This means that, when you have a watcher that triggers in one hour and 2897This means that, when you have a watcher that triggers in one hour and
2793there are 100 watchers that would trigger before that then inserting will 2898there are 100 watchers that would trigger before that then inserting will
2794have to skip those 100 watchers. 2899have to skip roughly seven (\f(CW\*(C`ld 100\*(C'\fR) of these watchers.
2795.IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4 2900.IP "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)" 4
2796.IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 2901.IX Item "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)"
2797That means that for changing a timer costs less than removing/adding them 2902That means that changing a timer costs less than removing/adding them
2798as only the relative motion in the event queue has to be paid for. 2903as only the relative motion in the event queue has to be paid for.
2799.IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 2904.IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4
2800.IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" 2905.IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)"
2801These just add the watcher into an array or at the head of a list. 2906These just add the watcher into an array or at the head of a list.
2907.IP "Stopping check/prepare/idle watchers: O(1)" 4
2802=item Stopping check/prepare/idle watchers: O(1) 2908.IX Item "Stopping check/prepare/idle watchers: O(1)"
2909.PD 0
2803.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4 2910.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4
2804.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))" 2911.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))"
2912.PD
2805These watchers are stored in lists then need to be walked to find the 2913These watchers are stored in lists then need to be walked to find the
2806correct watcher to remove. The lists are usually short (you don't usually 2914correct watcher to remove. The lists are usually short (you don't usually
2807have many watchers waiting for the same fd or signal). 2915have many watchers waiting for the same fd or signal).
2808.IP "Finding the next timer per loop iteration: O(1)" 4 2916.IP "Finding the next timer in each loop iteration: O(1)" 4
2809.IX Item "Finding the next timer per loop iteration: O(1)" 2917.IX Item "Finding the next timer in each loop iteration: O(1)"
2810.PD 0 2918By virtue of using a binary heap, the next timer is always found at the
2919beginning of the storage array.
2811.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 2920.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4
2812.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 2921.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)"
2813.PD
2814A change means an I/O watcher gets started or stopped, which requires 2922A change means an I/O watcher gets started or stopped, which requires
2815libev to recalculate its status (and possibly tell the kernel). 2923libev to recalculate its status (and possibly tell the kernel, depending
2816.IP "Activating one watcher: O(1)" 4 2924on backend and wether \f(CW\*(C`ev_io_set\*(C'\fR was used).
2817.IX Item "Activating one watcher: O(1)" 2925.IP "Activating one watcher (putting it into the pending state): O(1)" 4
2926.IX Item "Activating one watcher (putting it into the pending state): O(1)"
2818.PD 0 2927.PD 0
2819.IP "Priority handling: O(number_of_priorities)" 4 2928.IP "Priority handling: O(number_of_priorities)" 4
2820.IX Item "Priority handling: O(number_of_priorities)" 2929.IX Item "Priority handling: O(number_of_priorities)"
2821.PD 2930.PD
2822Priorities are implemented by allocating some space for each 2931Priorities are implemented by allocating some space for each
2823priority. When doing priority-based operations, libev usually has to 2932priority. When doing priority-based operations, libev usually has to
2824linearly search all the priorities. 2933linearly search all the priorities, but starting/stopping and activating
2934watchers becomes O(1) w.r.t. prioritiy handling.
2825.RE 2935.RE
2826.RS 4 2936.RS 4
2827.SH "AUTHOR" 2937.SH "AUTHOR"
2828.IX Header "AUTHOR" 2938.IX Header "AUTHOR"
2829Marc Lehmann <libev@schmorp.de>. 2939Marc Lehmann <libev@schmorp.de>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines