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

Comparing libev/ev.3 (file contents):
Revision 1.29 by root, Tue Nov 27 20:38:07 2007 UTC vs.
Revision 1.35 by root, Thu Nov 29 17:28:13 2007 UTC

… …
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title ""<STANDARD INPUT>" 1" 131.IX Title ""<STANDARD INPUT>" 1"
132.TH "<STANDARD INPUT>" 1 "2007-11-27" "perl v5.8.8" "User Contributed Perl Documentation" 132.TH "<STANDARD INPUT>" 1 "2007-11-29" "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
… …
210watchers\fR, which are relatively small C structures you initialise with the 210watchers\fR, which are relatively small C structures you initialise with the
211details of the event, and then hand it over to libev by \fIstarting\fR the 211details of the event, and then hand it over to libev by \fIstarting\fR the
212watcher. 212watcher.
213.SH "FEATURES" 213.SH "FEATURES"
214.IX Header "FEATURES" 214.IX Header "FEATURES"
215Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the linux-specific \f(CW\*(C`epoll\*(C'\fR, the 215Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the
216bsd-specific \f(CW\*(C`kqueue\*(C'\fR and the solaris-specific event port mechanisms 216BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms
217for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), relative timers (\f(CW\*(C`ev_timer\*(C'\fR), 217for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface
218(for \f(CW\*(C`ev_stat\*(C'\fR), relative timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers
218absolute timers with customised rescheduling (\f(CW\*(C`ev_periodic\*(C'\fR), synchronous 219with customised rescheduling (\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals
219signals (\f(CW\*(C`ev_signal\*(C'\fR), process status change events (\f(CW\*(C`ev_child\*(C'\fR), and 220(\f(CW\*(C`ev_signal\*(C'\fR), process status change events (\f(CW\*(C`ev_child\*(C'\fR), and event
220event watchers dealing with the event loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR, 221watchers dealing with the event loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR,
221\&\f(CW\*(C`ev_embed\*(C'\fR, \f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR watchers) as well as 222\&\f(CW\*(C`ev_embed\*(C'\fR, \f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR watchers) as well as
222file watchers (\f(CW\*(C`ev_stat\*(C'\fR) and even limited support for fork events 223file watchers (\f(CW\*(C`ev_stat\*(C'\fR) and even limited support for fork events
223(\f(CW\*(C`ev_fork\*(C'\fR). 224(\f(CW\*(C`ev_fork\*(C'\fR).
224.PP 225.PP
225It also is quite fast (see this 226It also is quite fast (see this
… …
304might be supported on the current system, you would need to look at 305might be supported on the current system, you would need to look at
305\&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for 306\&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for
306recommended ones. 307recommended ones.
307.Sp 308.Sp
308See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. 309See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
309.IP "ev_set_allocator (void *(*cb)(void *ptr, size_t size))" 4 310.IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4
310.IX Item "ev_set_allocator (void *(*cb)(void *ptr, size_t size))" 311.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))"
311Sets the allocation function to use (the prototype and semantics are 312Sets the allocation function to use (the prototype is similar \- the
312identical to the realloc C function). It is used to allocate and free 313semantics is identical \- to the realloc C function). It is used to
313memory (no surprises here). If it returns zero when memory needs to be 314allocate and free memory (no surprises here). If it returns zero when
314allocated, the library might abort or take some potentially destructive 315memory needs to be allocated, the library might abort or take some
315action. The default is your system realloc function. 316potentially destructive action. The default is your system realloc
317function.
316.Sp 318.Sp
317You could override this function in high-availability programs to, say, 319You could override this function in high-availability programs to, say,
318free some memory if it cannot allocate memory, to use a special allocator, 320free some memory if it cannot allocate memory, to use a special allocator,
319or even to sleep a while and retry until some memory is available. 321or even to sleep a while and retry until some memory is available.
320.Sp 322.Sp
… …
409or setgid) then libev will \fInot\fR look at the environment variable 411or setgid) then libev will \fInot\fR look at the environment variable
410\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will 412\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will
411override the flags completely if it is found in the environment. This is 413override the flags completely if it is found in the environment. This is
412useful to try out specific backends to test their performance, or to work 414useful to try out specific backends to test their performance, or to work
413around bugs. 415around bugs.
416.ie n .IP """EVFLAG_FORKCHECK""" 4
417.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4
418.IX Item "EVFLAG_FORKCHECK"
419Instead of calling \f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR manually after
420a fork, you can also make libev check for a fork in each iteration by
421enabling this flag.
422.Sp
423This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop,
424and thus this might slow down your event loop if you do a lot of loop
425iterations and little real work, but is usually not noticable (on my
426Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence
427without a syscall and thus \fIvery\fR fast, but my Linux system also has
428\&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster).
429.Sp
430The big advantage of this flag is that you can forget about fork (and
431forget about forgetting to tell libev about forking) when you use this
432flag.
433.Sp
434This flag setting cannot be overriden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR
435environment variable.
414.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 436.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4
415.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 437.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4
416.IX Item "EVBACKEND_SELECT (value 1, portable select backend)" 438.IX Item "EVBACKEND_SELECT (value 1, portable select backend)"
417This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as 439This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as
418libev tries to roll its own fd_set with no limits on the number of fds, 440libev tries to roll its own fd_set with no limits on the number of fds,
… …
1069.IP "ev_timer_again (loop)" 4 1091.IP "ev_timer_again (loop)" 4
1070.IX Item "ev_timer_again (loop)" 1092.IX Item "ev_timer_again (loop)"
1071This will act as if the timer timed out and restart it again if it is 1093This will act as if the timer timed out and restart it again if it is
1072repeating. The exact semantics are: 1094repeating. The exact semantics are:
1073.Sp 1095.Sp
1096If the timer is pending, its pending status is cleared.
1097.Sp
1074If the timer is started but nonrepeating, stop it. 1098If the timer is started but nonrepeating, stop it (as if it timed out).
1075.Sp 1099.Sp
1076If the timer is repeating, either start it if necessary (with the repeat 1100If the timer is repeating, either start it if necessary (with the
1077value), or reset the running timer to the repeat value. 1101\&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value.
1078.Sp 1102.Sp
1079This sounds a bit complicated, but here is a useful and typical 1103This sounds a bit complicated, but here is a useful and typical
1080example: Imagine you have a tcp connection and you want a so-called 1104example: Imagine you have a tcp connection and you want a so-called idle
1081idle timeout, that is, you want to be called when there have been, 1105timeout, that is, you want to be called when there have been, say, 60
1082say, 60 seconds of inactivity on the socket. The easiest way to do 1106seconds of inactivity on the socket. The easiest way to do this is to
1083this is to configure an \f(CW\*(C`ev_timer\*(C'\fR with \f(CW\*(C`after\*(C'\fR=\f(CW\*(C`repeat\*(C'\fR=\f(CW60\fR and calling 1107configure an \f(CW\*(C`ev_timer\*(C'\fR with a \f(CW\*(C`repeat\*(C'\fR value of \f(CW60\fR and then call
1084\&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If 1108\&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If
1085you go into an idle state where you do not expect data to travel on the 1109you go into an idle state where you do not expect data to travel on the
1086socket, you can stop the timer, and again will automatically restart it if 1110socket, you can \f(CW\*(C`ev_timer_stop\*(C'\fR the timer, and \f(CW\*(C`ev_timer_again\*(C'\fR will
1087need be. 1111automatically restart it if need be.
1088.Sp 1112.Sp
1089You can also ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR altogether 1113That means you can ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR
1090and only ever use the \f(CW\*(C`repeat\*(C'\fR value: 1114altogether and only ever use the \f(CW\*(C`repeat\*(C'\fR value and \f(CW\*(C`ev_timer_again\*(C'\fR:
1091.Sp 1115.Sp
1092.Vb 8 1116.Vb 8
1093\& ev_timer_init (timer, callback, 0., 5.); 1117\& ev_timer_init (timer, callback, 0., 5.);
1094\& ev_timer_again (loop, timer); 1118\& ev_timer_again (loop, timer);
1095\& ... 1119\& ...
… …
1098\& ... 1122\& ...
1099\& timer->again = 10.; 1123\& timer->again = 10.;
1100\& ev_timer_again (loop, timer); 1124\& ev_timer_again (loop, timer);
1101.Ve 1125.Ve
1102.Sp 1126.Sp
1103This is more efficient then stopping/starting the timer eahc time you want 1127This is more slightly efficient then stopping/starting the timer each time
1104to modify its timeout value. 1128you want to modify its timeout value.
1105.IP "ev_tstamp repeat [read\-write]" 4 1129.IP "ev_tstamp repeat [read\-write]" 4
1106.IX Item "ev_tstamp repeat [read-write]" 1130.IX Item "ev_tstamp repeat [read-write]"
1107The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out 1131The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out
1108or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any), 1132or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any),
1109which is also when any modifications are taken into account. 1133which is also when any modifications are taken into account.
… …
1382not exist\*(R" is a status change like any other. The condition \*(L"path does 1406not exist\*(R" is a status change like any other. The condition \*(L"path does
1383not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is 1407not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is
1384otherwise always forced to be at least one) and all the other fields of 1408otherwise always forced to be at least one) and all the other fields of
1385the stat buffer having unspecified contents. 1409the stat buffer having unspecified contents.
1386.PP 1410.PP
1411The path \fIshould\fR be absolute and \fImust not\fR end in a slash. If it is
1412relative and your working directory changes, the behaviour is undefined.
1413.PP
1387Since there is no standard to do this, the portable implementation simply 1414Since there is no standard to do this, the portable implementation simply
1388calls \f(CW\*(C`stat (2)\*(C'\fR regulalry on the path to see if it changed somehow. You 1415calls \f(CW\*(C`stat (2)\*(C'\fR regularly on the path to see if it changed somehow. You
1389can specify a recommended polling interval for this case. If you specify 1416can specify a recommended polling interval for this case. If you specify
1390a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable, 1417a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable,
1391unspecified default\fR value will be used (which you can expect to be around 1418unspecified default\fR value will be used (which you can expect to be around
1392five seconds, although this might change dynamically). Libev will also 1419five seconds, although this might change dynamically). Libev will also
1393impose a minimum interval which is currently around \f(CW0.1\fR, but thats 1420impose a minimum interval which is currently around \f(CW0.1\fR, but thats
… …
1395.PP 1422.PP
1396This watcher type is not meant for massive numbers of stat watchers, 1423This watcher type is not meant for massive numbers of stat watchers,
1397as even with OS-supported change notifications, this can be 1424as even with OS-supported change notifications, this can be
1398resource\-intensive. 1425resource\-intensive.
1399.PP 1426.PP
1400At the time of this writing, no specific \s-1OS\s0 backends are implemented, but 1427At the time of this writing, only the Linux inotify interface is
1401if demand increases, at least a kqueue and inotify backend will be added. 1428implemented (implementing kqueue support is left as an exercise for the
1429reader). Inotify will be used to give hints only and should not change the
1430semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs
1431to fall back to regular polling again even with inotify, but changes are
1432usually detected immediately, and if the file exists there will be no
1433polling.
1402.IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 1434.IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4
1403.IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 1435.IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)"
1404.PD 0 1436.PD 0
1405.IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4 1437.IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4
1406.IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 1438.IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)"
… …
2170otherwise another method will be used as fallback. This is the preferred 2202otherwise another method will be used as fallback. This is the preferred
2171backend for Solaris 10 systems. 2203backend for Solaris 10 systems.
2172.IP "\s-1EV_USE_DEVPOLL\s0" 4 2204.IP "\s-1EV_USE_DEVPOLL\s0" 4
2173.IX Item "EV_USE_DEVPOLL" 2205.IX Item "EV_USE_DEVPOLL"
2174reserved for future expansion, works like the \s-1USE\s0 symbols above. 2206reserved for future expansion, works like the \s-1USE\s0 symbols above.
2207.IP "\s-1EV_USE_INOTIFY\s0" 4
2208.IX Item "EV_USE_INOTIFY"
2209If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify
2210interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will
2211be detected at runtime.
2175.IP "\s-1EV_H\s0" 4 2212.IP "\s-1EV_H\s0" 4
2176.IX Item "EV_H" 2213.IX Item "EV_H"
2177The name of the \fIev.h\fR header file used to include it. The default if 2214The name of the \fIev.h\fR header file used to include it. The default if
2178undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This 2215undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This
2179can be used to virtually rename the \fIev.h\fR header file in case of conflicts. 2216can be used to virtually rename the \fIev.h\fR header file in case of conflicts.
… …
2224.IP "\s-1EV_PID_HASHSIZE\s0" 4 2261.IP "\s-1EV_PID_HASHSIZE\s0" 4
2225.IX Item "EV_PID_HASHSIZE" 2262.IX Item "EV_PID_HASHSIZE"
2226\&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by 2263\&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by
2227pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more 2264pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more
2228than enough. If you need to manage thousands of children you might want to 2265than enough. If you need to manage thousands of children you might want to
2229increase this value. 2266increase this value (\fImust\fR be a power of two).
2267.IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4
2268.IX Item "EV_INOTIFY_HASHSIZE"
2269\&\f(CW\*(C`ev_staz\*(C'\fR watchers use a small hash table to distribute workload by
2270inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR),
2271usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR
2272watchers you might want to increase this value (\fImust\fR be a power of
2273two).
2230.IP "\s-1EV_COMMON\s0" 4 2274.IP "\s-1EV_COMMON\s0" 4
2231.IX Item "EV_COMMON" 2275.IX Item "EV_COMMON"
2232By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining 2276By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining
2233this macro to a something else you can include more and other types of 2277this macro to a something else you can include more and other types of
2234members. You have to define it each time you include one of the files, 2278members. You have to define it each time you include one of the files,
… …
2298.IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 2342.IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)"
2299.IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 2343.IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4
2300.IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" 2344.IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)"
2301.IP "Stopping check/prepare/idle watchers: O(1)" 4 2345.IP "Stopping check/prepare/idle watchers: O(1)" 4
2302.IX Item "Stopping check/prepare/idle watchers: O(1)" 2346.IX Item "Stopping check/prepare/idle watchers: O(1)"
2303.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))" 4 2347.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4
2304.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))" 2348.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))"
2305.IP "Finding the next timer per loop iteration: O(1)" 4 2349.IP "Finding the next timer per loop iteration: O(1)" 4
2306.IX Item "Finding the next timer per loop iteration: O(1)" 2350.IX Item "Finding the next timer per loop iteration: O(1)"
2307.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 2351.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4
2308.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 2352.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)"
2309.IP "Activating one watcher: O(1)" 4 2353.IP "Activating one watcher: O(1)" 4

Diff Legend

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