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

Comparing libev/ev.3 (file contents):
Revision 1.28 by root, Tue Nov 27 20:26:50 2007 UTC vs.
Revision 1.34 by root, Thu Nov 29 12:21:21 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
… …
856Returns a true value iff the watcher is pending, (i.e. it has outstanding 858Returns a true value iff the watcher is pending, (i.e. it has outstanding
857events but its callback has not yet been invoked). As long as a watcher 859events but its callback has not yet been invoked). As long as a watcher
858is pending (but not active) you must not call an init function on it (but 860is pending (but not active) you must not call an init function on it (but
859\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe) and you must make sure the watcher is available to 861\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe) and you must make sure the watcher is available to
860libev (e.g. you cnanot \f(CW\*(C`free ()\*(C'\fR it). 862libev (e.g. you cnanot \f(CW\*(C`free ()\*(C'\fR it).
861.IP "callback = ev_cb (ev_TYPE *watcher)" 4 863.IP "callback ev_cb (ev_TYPE *watcher)" 4
862.IX Item "callback = ev_cb (ev_TYPE *watcher)" 864.IX Item "callback ev_cb (ev_TYPE *watcher)"
863Returns the callback currently set on the watcher. 865Returns the callback currently set on the watcher.
864.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 866.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4
865.IX Item "ev_cb_set (ev_TYPE *watcher, callback)" 867.IX Item "ev_cb_set (ev_TYPE *watcher, callback)"
866Change the callback. You can change the callback at virtually any time 868Change the callback. You can change the callback at virtually any time
867(modulo threads). 869(modulo threads).
… …
893\& struct my_io *w = (struct my_io *)w_; 895\& struct my_io *w = (struct my_io *)w_;
894\& ... 896\& ...
895\& } 897\& }
896.Ve 898.Ve
897.PP 899.PP
898More interesting and less C\-conformant ways of catsing your callback type 900More interesting and less C\-conformant ways of casting your callback type
899have been omitted.... 901instead have been omitted.
902.PP
903Another common scenario is having some data structure with multiple
904watchers:
905.PP
906.Vb 6
907\& struct my_biggy
908\& {
909\& int some_data;
910\& ev_timer t1;
911\& ev_timer t2;
912\& }
913.Ve
914.PP
915In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more complicated,
916you need to use \f(CW\*(C`offsetof\*(C'\fR:
917.PP
918.Vb 1
919\& #include <stddef.h>
920.Ve
921.PP
922.Vb 6
923\& static void
924\& t1_cb (EV_P_ struct ev_timer *w, int revents)
925\& {
926\& struct my_biggy big = (struct my_biggy *
927\& (((char *)w) - offsetof (struct my_biggy, t1));
928\& }
929.Ve
930.PP
931.Vb 6
932\& static void
933\& t2_cb (EV_P_ struct ev_timer *w, int revents)
934\& {
935\& struct my_biggy big = (struct my_biggy *
936\& (((char *)w) - offsetof (struct my_biggy, t2));
937\& }
938.Ve
900.SH "WATCHER TYPES" 939.SH "WATCHER TYPES"
901.IX Header "WATCHER TYPES" 940.IX Header "WATCHER TYPES"
902This section describes each watcher in detail, but will not repeat 941This section describes each watcher in detail, but will not repeat
903information given in the last section. Any initialisation/set macros, 942information given in the last section. Any initialisation/set macros,
904functions and members specific to the watcher type are explained. 943functions and members specific to the watcher type are explained.
… …
1032.IP "ev_timer_again (loop)" 4 1071.IP "ev_timer_again (loop)" 4
1033.IX Item "ev_timer_again (loop)" 1072.IX Item "ev_timer_again (loop)"
1034This will act as if the timer timed out and restart it again if it is 1073This will act as if the timer timed out and restart it again if it is
1035repeating. The exact semantics are: 1074repeating. The exact semantics are:
1036.Sp 1075.Sp
1076If the timer is pending, its pending status is cleared.
1077.Sp
1037If the timer is started but nonrepeating, stop it. 1078If the timer is started but nonrepeating, stop it (as if it timed out).
1038.Sp 1079.Sp
1039If the timer is repeating, either start it if necessary (with the repeat 1080If the timer is repeating, either start it if necessary (with the
1040value), or reset the running timer to the repeat value. 1081\&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value.
1041.Sp 1082.Sp
1042This sounds a bit complicated, but here is a useful and typical 1083This sounds a bit complicated, but here is a useful and typical
1043example: Imagine you have a tcp connection and you want a so-called 1084example: Imagine you have a tcp connection and you want a so-called idle
1044idle timeout, that is, you want to be called when there have been, 1085timeout, that is, you want to be called when there have been, say, 60
1045say, 60 seconds of inactivity on the socket. The easiest way to do 1086seconds of inactivity on the socket. The easiest way to do this is to
1046this 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 1087configure an \f(CW\*(C`ev_timer\*(C'\fR with a \f(CW\*(C`repeat\*(C'\fR value of \f(CW60\fR and then call
1047\&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If 1088\&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If
1048you go into an idle state where you do not expect data to travel on the 1089you go into an idle state where you do not expect data to travel on the
1049socket, you can stop the timer, and again will automatically restart it if 1090socket, you can \f(CW\*(C`ev_timer_stop\*(C'\fR the timer, and \f(CW\*(C`ev_timer_again\*(C'\fR will
1050need be. 1091automatically restart it if need be.
1051.Sp 1092.Sp
1052You can also ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR altogether 1093That means you can ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR
1053and only ever use the \f(CW\*(C`repeat\*(C'\fR value: 1094altogether and only ever use the \f(CW\*(C`repeat\*(C'\fR value and \f(CW\*(C`ev_timer_again\*(C'\fR:
1054.Sp 1095.Sp
1055.Vb 8 1096.Vb 8
1056\& ev_timer_init (timer, callback, 0., 5.); 1097\& ev_timer_init (timer, callback, 0., 5.);
1057\& ev_timer_again (loop, timer); 1098\& ev_timer_again (loop, timer);
1058\& ... 1099\& ...
… …
1061\& ... 1102\& ...
1062\& timer->again = 10.; 1103\& timer->again = 10.;
1063\& ev_timer_again (loop, timer); 1104\& ev_timer_again (loop, timer);
1064.Ve 1105.Ve
1065.Sp 1106.Sp
1066This is more efficient then stopping/starting the timer eahc time you want 1107This is more slightly efficient then stopping/starting the timer each time
1067to modify its timeout value. 1108you want to modify its timeout value.
1068.IP "ev_tstamp repeat [read\-write]" 4 1109.IP "ev_tstamp repeat [read\-write]" 4
1069.IX Item "ev_tstamp repeat [read-write]" 1110.IX Item "ev_tstamp repeat [read-write]"
1070The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out 1111The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out
1071or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any), 1112or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any),
1072which is also when any modifications are taken into account. 1113which is also when any modifications are taken into account.
… …
1345not exist\*(R" is a status change like any other. The condition \*(L"path does 1386not exist\*(R" is a status change like any other. The condition \*(L"path does
1346not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is 1387not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is
1347otherwise always forced to be at least one) and all the other fields of 1388otherwise always forced to be at least one) and all the other fields of
1348the stat buffer having unspecified contents. 1389the stat buffer having unspecified contents.
1349.PP 1390.PP
1391The path \fIshould\fR be absolute and \fImust not\fR end in a slash. If it is
1392relative and your working directory changes, the behaviour is undefined.
1393.PP
1350Since there is no standard to do this, the portable implementation simply 1394Since there is no standard to do this, the portable implementation simply
1351calls \f(CW\*(C`stat (2)\*(C'\fR regulalry on the path to see if it changed somehow. You 1395calls \f(CW\*(C`stat (2)\*(C'\fR regularly on the path to see if it changed somehow. You
1352can specify a recommended polling interval for this case. If you specify 1396can specify a recommended polling interval for this case. If you specify
1353a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable, 1397a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable,
1354unspecified default\fR value will be used (which you can expect to be around 1398unspecified default\fR value will be used (which you can expect to be around
1355five seconds, although this might change dynamically). Libev will also 1399five seconds, although this might change dynamically). Libev will also
1356impose a minimum interval which is currently around \f(CW0.1\fR, but thats 1400impose a minimum interval which is currently around \f(CW0.1\fR, but thats
… …
1358.PP 1402.PP
1359This watcher type is not meant for massive numbers of stat watchers, 1403This watcher type is not meant for massive numbers of stat watchers,
1360as even with OS-supported change notifications, this can be 1404as even with OS-supported change notifications, this can be
1361resource\-intensive. 1405resource\-intensive.
1362.PP 1406.PP
1363At the time of this writing, no specific \s-1OS\s0 backends are implemented, but 1407At the time of this writing, only the Linux inotify interface is
1364if demand increases, at least a kqueue and inotify backend will be added. 1408implemented (implementing kqueue support is left as an exercise for the
1409reader). Inotify will be used to give hints only and should not change the
1410semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs
1411to fall back to regular polling again even with inotify, but changes are
1412usually detected immediately, and if the file exists there will be no
1413polling.
1365.IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 1414.IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4
1366.IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 1415.IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)"
1367.PD 0 1416.PD 0
1368.IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4 1417.IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4
1369.IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 1418.IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)"
… …
2133otherwise another method will be used as fallback. This is the preferred 2182otherwise another method will be used as fallback. This is the preferred
2134backend for Solaris 10 systems. 2183backend for Solaris 10 systems.
2135.IP "\s-1EV_USE_DEVPOLL\s0" 4 2184.IP "\s-1EV_USE_DEVPOLL\s0" 4
2136.IX Item "EV_USE_DEVPOLL" 2185.IX Item "EV_USE_DEVPOLL"
2137reserved for future expansion, works like the \s-1USE\s0 symbols above. 2186reserved for future expansion, works like the \s-1USE\s0 symbols above.
2187.IP "\s-1EV_USE_INOTIFY\s0" 4
2188.IX Item "EV_USE_INOTIFY"
2189If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify
2190interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will
2191be detected at runtime.
2138.IP "\s-1EV_H\s0" 4 2192.IP "\s-1EV_H\s0" 4
2139.IX Item "EV_H" 2193.IX Item "EV_H"
2140The name of the \fIev.h\fR header file used to include it. The default if 2194The name of the \fIev.h\fR header file used to include it. The default if
2141undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This 2195undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This
2142can be used to virtually rename the \fIev.h\fR header file in case of conflicts. 2196can be used to virtually rename the \fIev.h\fR header file in case of conflicts.
… …
2187.IP "\s-1EV_PID_HASHSIZE\s0" 4 2241.IP "\s-1EV_PID_HASHSIZE\s0" 4
2188.IX Item "EV_PID_HASHSIZE" 2242.IX Item "EV_PID_HASHSIZE"
2189\&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by 2243\&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by
2190pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more 2244pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more
2191than enough. If you need to manage thousands of children you might want to 2245than enough. If you need to manage thousands of children you might want to
2192increase this value. 2246increase this value (\fImust\fR be a power of two).
2247.IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4
2248.IX Item "EV_INOTIFY_HASHSIZE"
2249\&\f(CW\*(C`ev_staz\*(C'\fR watchers use a small hash table to distribute workload by
2250inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR),
2251usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR
2252watchers you might want to increase this value (\fImust\fR be a power of
2253two).
2193.IP "\s-1EV_COMMON\s0" 4 2254.IP "\s-1EV_COMMON\s0" 4
2194.IX Item "EV_COMMON" 2255.IX Item "EV_COMMON"
2195By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining 2256By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining
2196this macro to a something else you can include more and other types of 2257this macro to a something else you can include more and other types of
2197members. You have to define it each time you include one of the files, 2258members. You have to define it each time you include one of the files,
… …
2261.IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 2322.IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)"
2262.IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 2323.IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4
2263.IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" 2324.IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)"
2264.IP "Stopping check/prepare/idle watchers: O(1)" 4 2325.IP "Stopping check/prepare/idle watchers: O(1)" 4
2265.IX Item "Stopping check/prepare/idle watchers: O(1)" 2326.IX Item "Stopping check/prepare/idle watchers: O(1)"
2266.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))" 4 2327.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4
2267.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))" 2328.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))"
2268.IP "Finding the next timer per loop iteration: O(1)" 4 2329.IP "Finding the next timer per loop iteration: O(1)" 4
2269.IX Item "Finding the next timer per loop iteration: O(1)" 2330.IX Item "Finding the next timer per loop iteration: O(1)"
2270.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 2331.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4
2271.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 2332.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)"
2272.IP "Activating one watcher: O(1)" 4 2333.IP "Activating one watcher: O(1)" 4

Diff Legend

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