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

Comparing libev/ev.3 (file contents):
Revision 1.19 by root, Sat Nov 24 16:57:38 2007 UTC vs.
Revision 1.27 by root, Tue Nov 27 20:15:01 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-24" "perl v5.8.8" "User Contributed Perl Documentation" 132.TH "<STANDARD INPUT>" 1 "2007-11-27" "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 2
138\& /* this is the only header you need */
138\& #include <ev.h> 139\& #include <ev.h>
140.Ve
141.PP
142.Vb 3
143\& /* what follows is a fully working example program */
144\& ev_io stdin_watcher;
145\& ev_timer timeout_watcher;
146.Ve
147.PP
148.Vb 8
149\& /* called when data readable on stdin */
150\& static void
151\& stdin_cb (EV_P_ struct ev_io *w, int revents)
152\& {
153\& /* puts ("stdin ready"); */
154\& ev_io_stop (EV_A_ w); /* just a syntax example */
155\& ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */
156\& }
157.Ve
158.PP
159.Vb 6
160\& static void
161\& timeout_cb (EV_P_ struct ev_timer *w, int revents)
162\& {
163\& /* puts ("timeout"); */
164\& ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */
165\& }
166.Ve
167.PP
168.Vb 4
169\& int
170\& main (void)
171\& {
172\& struct ev_loop *loop = ev_default_loop (0);
173.Ve
174.PP
175.Vb 3
176\& /* initialise an io watcher, then start it */
177\& ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
178\& ev_io_start (loop, &stdin_watcher);
179.Ve
180.PP
181.Vb 3
182\& /* simple non-repeating 5.5 second timeout */
183\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
184\& ev_timer_start (loop, &timeout_watcher);
185.Ve
186.PP
187.Vb 2
188\& /* loop till timeout or data ready */
189\& ev_loop (loop, 0);
190.Ve
191.PP
192.Vb 2
193\& return 0;
194\& }
139.Ve 195.Ve
140.SH "DESCRIPTION" 196.SH "DESCRIPTION"
141.IX Header "DESCRIPTION" 197.IX Header "DESCRIPTION"
142Libev is an event loop: you register interest in certain events (such as a 198Libev is an event loop: you register interest in certain events (such as a
143file descriptor being readable or a timeout occuring), and it will manage 199file descriptor being readable or a timeout occuring), and it will manage
240might be supported on the current system, you would need to look at 296might be supported on the current system, you would need to look at
241\&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for 297\&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for
242recommended ones. 298recommended ones.
243.Sp 299.Sp
244See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. 300See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
245.IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4 301.IP "ev_set_allocator (void *(*cb)(void *ptr, size_t size))" 4
246.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" 302.IX Item "ev_set_allocator (void *(*cb)(void *ptr, size_t size))"
247Sets the allocation function to use (the prototype is similar to the 303Sets the allocation function to use (the prototype and semantics are
248realloc C function, the semantics are identical). It is used to allocate 304identical to the realloc C function). It is used to allocate and free
249and free memory (no surprises here). If it returns zero when memory 305memory (no surprises here). If it returns zero when memory needs to be
250needs to be allocated, the library might abort or take some potentially 306allocated, the library might abort or take some potentially destructive
251destructive action. The default is your system realloc function. 307action. The default is your system realloc function.
252.Sp 308.Sp
253You could override this function in high-availability programs to, say, 309You could override this function in high-availability programs to, say,
254free some memory if it cannot allocate memory, to use a special allocator, 310free some memory if it cannot allocate memory, to use a special allocator,
255or even to sleep a while and retry until some memory is available. 311or even to sleep a while and retry until some memory is available.
256.Sp 312.Sp
257Example: replace the libev allocator with one that waits a bit and then 313Example: replace the libev allocator with one that waits a bit and then
258retries: better than mine). 314retries: better than mine).
259.Sp 315.Sp
260.Vb 6 316.Vb 6
261\& static void * 317\& static void *
262\& persistent_realloc (void *ptr, long size) 318\& persistent_realloc (void *ptr, size_t size)
263\& { 319\& {
264\& for (;;) 320\& for (;;)
265\& { 321\& {
266\& void *newptr = realloc (ptr, size); 322\& void *newptr = realloc (ptr, size);
267.Ve 323.Ve
684The signal specified in the \f(CW\*(C`ev_signal\*(C'\fR watcher has been received by a thread. 740The signal specified in the \f(CW\*(C`ev_signal\*(C'\fR watcher has been received by a thread.
685.ie n .IP """EV_CHILD""" 4 741.ie n .IP """EV_CHILD""" 4
686.el .IP "\f(CWEV_CHILD\fR" 4 742.el .IP "\f(CWEV_CHILD\fR" 4
687.IX Item "EV_CHILD" 743.IX Item "EV_CHILD"
688The pid specified in the \f(CW\*(C`ev_child\*(C'\fR watcher has received a status change. 744The pid specified in the \f(CW\*(C`ev_child\*(C'\fR watcher has received a status change.
745.ie n .IP """EV_STAT""" 4
746.el .IP "\f(CWEV_STAT\fR" 4
747.IX Item "EV_STAT"
748The path specified in the \f(CW\*(C`ev_stat\*(C'\fR watcher changed its attributes somehow.
689.ie n .IP """EV_IDLE""" 4 749.ie n .IP """EV_IDLE""" 4
690.el .IP "\f(CWEV_IDLE\fR" 4 750.el .IP "\f(CWEV_IDLE\fR" 4
691.IX Item "EV_IDLE" 751.IX Item "EV_IDLE"
692The \f(CW\*(C`ev_idle\*(C'\fR watcher has determined that you have nothing better to do. 752The \f(CW\*(C`ev_idle\*(C'\fR watcher has determined that you have nothing better to do.
693.ie n .IP """EV_PREPARE""" 4 753.ie n .IP """EV_PREPARE""" 4
703\&\f(CW\*(C`ev_loop\*(C'\fR has gathered them, but before it invokes any callbacks for any 763\&\f(CW\*(C`ev_loop\*(C'\fR has gathered them, but before it invokes any callbacks for any
704received events. Callbacks of both watcher types can start and stop as 764received events. Callbacks of both watcher types can start and stop as
705many watchers as they want, and all of them will be taken into account 765many watchers as they want, and all of them will be taken into account
706(for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep 766(for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep
707\&\f(CW\*(C`ev_loop\*(C'\fR from blocking). 767\&\f(CW\*(C`ev_loop\*(C'\fR from blocking).
768.ie n .IP """EV_EMBED""" 4
769.el .IP "\f(CWEV_EMBED\fR" 4
770.IX Item "EV_EMBED"
771The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention.
772.ie n .IP """EV_FORK""" 4
773.el .IP "\f(CWEV_FORK\fR" 4
774.IX Item "EV_FORK"
775The event loop has been resumed in the child process after fork (see
776\&\f(CW\*(C`ev_fork\*(C'\fR).
708.ie n .IP """EV_ERROR""" 4 777.ie n .IP """EV_ERROR""" 4
709.el .IP "\f(CWEV_ERROR\fR" 4 778.el .IP "\f(CWEV_ERROR\fR" 4
710.IX Item "EV_ERROR" 779.IX Item "EV_ERROR"
711An unspecified error has occured, the watcher has been stopped. This might 780An unspecified error has occured, the watcher has been stopped. This might
712happen because the watcher could not be properly started because libev 781happen because the watcher could not be properly started because libev
821More interesting and less C\-conformant ways of catsing your callback type 890More interesting and less C\-conformant ways of catsing your callback type
822have been omitted.... 891have been omitted....
823.SH "WATCHER TYPES" 892.SH "WATCHER TYPES"
824.IX Header "WATCHER TYPES" 893.IX Header "WATCHER TYPES"
825This section describes each watcher in detail, but will not repeat 894This section describes each watcher in detail, but will not repeat
826information given in the last section. 895information given in the last section. Any initialisation/set macros,
896functions and members specific to the watcher type are explained.
897.PP
898Members are additionally marked with either \fI[read\-only]\fR, meaning that,
899while the watcher is active, you can look at the member and expect some
900sensible content, but you must not modify it (you can modify it while the
901watcher is stopped to your hearts content), or \fI[read\-write]\fR, which
902means you can expect it to have some sensible content while the watcher
903is active, but you can also modify it. Modifying it may not do something
904sensible or take immediate effect (or do anything at all), but libev will
905not crash or malfunction in any way.
827.ie n .Sh """ev_io"" \- is this file descriptor readable or writable?" 906.ie n .Sh """ev_io"" \- is this file descriptor readable or writable?"
828.el .Sh "\f(CWev_io\fP \- is this file descriptor readable or writable?" 907.el .Sh "\f(CWev_io\fP \- is this file descriptor readable or writable?"
829.IX Subsection "ev_io - is this file descriptor readable or writable?" 908.IX Subsection "ev_io - is this file descriptor readable or writable?"
830I/O watchers check whether a file descriptor is readable or writable 909I/O watchers check whether a file descriptor is readable or writable
831in each iteration of the event loop, or, more precisely, when reading 910in each iteration of the event loop, or, more precisely, when reading
871.IX Item "ev_io_set (ev_io *, int fd, int events)" 950.IX Item "ev_io_set (ev_io *, int fd, int events)"
872.PD 951.PD
873Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to 952Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to
874rceeive events for and events is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or 953rceeive events for and events is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or
875\&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR to receive the given events. 954\&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR to receive the given events.
955.IP "int fd [read\-only]" 4
956.IX Item "int fd [read-only]"
957The file descriptor being watched.
958.IP "int events [read\-only]" 4
959.IX Item "int events [read-only]"
960The events being watched.
876.PP 961.PP
877Example: call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well 962Example: call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well
878readable, but only once. Since it is likely line\-buffered, you could 963readable, but only once. Since it is likely line\-buffered, you could
879attempt to read a whole line in the callback: 964attempt to read a whole line in the callback:
880.PP 965.PP
945.Sp 1030.Sp
946If the timer is repeating, either start it if necessary (with the repeat 1031If the timer is repeating, either start it if necessary (with the repeat
947value), or reset the running timer to the repeat value. 1032value), or reset the running timer to the repeat value.
948.Sp 1033.Sp
949This sounds a bit complicated, but here is a useful and typical 1034This sounds a bit complicated, but here is a useful and typical
950example: Imagine you have a tcp connection and you want a so-called idle 1035example: Imagine you have a tcp connection and you want a so-called
951timeout, that is, you want to be called when there have been, say, 60 1036idle timeout, that is, you want to be called when there have been,
952seconds of inactivity on the socket. The easiest way to do this is to 1037say, 60 seconds of inactivity on the socket. The easiest way to do
953configure an \f(CW\*(C`ev_timer\*(C'\fR with after=repeat=60 and calling ev_timer_again each 1038this 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
954time you successfully read or write some data. If you go into an idle 1039\&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If
955state where you do not expect data to travel on the socket, you can stop 1040you go into an idle state where you do not expect data to travel on the
956the timer, and again will automatically restart it if need be. 1041socket, you can stop the timer, and again will automatically restart it if
1042need be.
1043.Sp
1044You can also ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR altogether
1045and only ever use the \f(CW\*(C`repeat\*(C'\fR value:
1046.Sp
1047.Vb 8
1048\& ev_timer_init (timer, callback, 0., 5.);
1049\& ev_timer_again (loop, timer);
1050\& ...
1051\& timer->again = 17.;
1052\& ev_timer_again (loop, timer);
1053\& ...
1054\& timer->again = 10.;
1055\& ev_timer_again (loop, timer);
1056.Ve
1057.Sp
1058This is more efficient then stopping/starting the timer eahc time you want
1059to modify its timeout value.
1060.IP "ev_tstamp repeat [read\-write]" 4
1061.IX Item "ev_tstamp repeat [read-write]"
1062The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out
1063or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any),
1064which is also when any modifications are taken into account.
957.PP 1065.PP
958Example: create a timer that fires after 60 seconds. 1066Example: create a timer that fires after 60 seconds.
959.PP 1067.PP
960.Vb 5 1068.Vb 5
961\& static void 1069\& static void
1093.IX Item "ev_periodic_again (loop, ev_periodic *)" 1201.IX Item "ev_periodic_again (loop, ev_periodic *)"
1094Simply stops and restarts the periodic watcher again. This is only useful 1202Simply stops and restarts the periodic watcher again. This is only useful
1095when you changed some parameters or the reschedule callback would return 1203when you changed some parameters or the reschedule callback would return
1096a different time than the last time it was called (e.g. in a crond like 1204a different time than the last time it was called (e.g. in a crond like
1097program when the crontabs have changed). 1205program when the crontabs have changed).
1206.IP "ev_tstamp interval [read\-write]" 4
1207.IX Item "ev_tstamp interval [read-write]"
1208The current interval value. Can be modified any time, but changes only
1209take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being
1210called.
1211.IP "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read\-write]" 4
1212.IX Item "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]"
1213The current reschedule callback, or \f(CW0\fR, if this functionality is
1214switched off. Can be changed any time, but changes only take effect when
1215the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called.
1098.PP 1216.PP
1099Example: call a callback every hour, or, more precisely, whenever the 1217Example: call a callback every hour, or, more precisely, whenever the
1100system clock is divisible by 3600. The callback invocation times have 1218system clock is divisible by 3600. The callback invocation times have
1101potentially a lot of jittering, but good long-term stability. 1219potentially a lot of jittering, but good long-term stability.
1102.PP 1220.PP
1160.IP "ev_signal_set (ev_signal *, int signum)" 4 1278.IP "ev_signal_set (ev_signal *, int signum)" 4
1161.IX Item "ev_signal_set (ev_signal *, int signum)" 1279.IX Item "ev_signal_set (ev_signal *, int signum)"
1162.PD 1280.PD
1163Configures the watcher to trigger on the given signal number (usually one 1281Configures the watcher to trigger on the given signal number (usually one
1164of the \f(CW\*(C`SIGxxx\*(C'\fR constants). 1282of the \f(CW\*(C`SIGxxx\*(C'\fR constants).
1283.IP "int signum [read\-only]" 4
1284.IX Item "int signum [read-only]"
1285The signal the watcher watches out for.
1165.ie n .Sh """ev_child"" \- watch out for process status changes" 1286.ie n .Sh """ev_child"" \- watch out for process status changes"
1166.el .Sh "\f(CWev_child\fP \- watch out for process status changes" 1287.el .Sh "\f(CWev_child\fP \- watch out for process status changes"
1167.IX Subsection "ev_child - watch out for process status changes" 1288.IX Subsection "ev_child - watch out for process status changes"
1168Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to 1289Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to
1169some child status changes (most typically when a child of yours dies). 1290some child status changes (most typically when a child of yours dies).
1177\&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look 1298\&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look
1178at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see 1299at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see
1179the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems 1300the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems
1180\&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the 1301\&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the
1181process causing the status change. 1302process causing the status change.
1303.IP "int pid [read\-only]" 4
1304.IX Item "int pid [read-only]"
1305The process id this watcher watches out for, or \f(CW0\fR, meaning any process id.
1306.IP "int rpid [read\-write]" 4
1307.IX Item "int rpid [read-write]"
1308The process id that detected a status change.
1309.IP "int rstatus [read\-write]" 4
1310.IX Item "int rstatus [read-write]"
1311The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems
1312\&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details).
1182.PP 1313.PP
1183Example: try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0. 1314Example: try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0.
1184.PP 1315.PP
1185.Vb 5 1316.Vb 5
1186\& static void 1317\& static void
1192.PP 1323.PP
1193.Vb 3 1324.Vb 3
1194\& struct ev_signal signal_watcher; 1325\& struct ev_signal signal_watcher;
1195\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT); 1326\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1196\& ev_signal_start (loop, &sigint_cb); 1327\& ev_signal_start (loop, &sigint_cb);
1328.Ve
1329.ie n .Sh """ev_stat"" \- did the file attributes just change?"
1330.el .Sh "\f(CWev_stat\fP \- did the file attributes just change?"
1331.IX Subsection "ev_stat - did the file attributes just change?"
1332This watches a filesystem path for attribute changes. That is, it calls
1333\&\f(CW\*(C`stat\*(C'\fR regularly (or when the \s-1OS\s0 says it changed) and sees if it changed
1334compared to the last time, invoking the callback if it did.
1335.PP
1336The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does
1337not exist\*(R" is a status change like any other. The condition \*(L"path does
1338not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is
1339otherwise always forced to be at least one) and all the other fields of
1340the stat buffer having unspecified contents.
1341.PP
1342Since there is no standard to do this, the portable implementation simply
1343calls \f(CW\*(C`stat (2)\*(C'\fR regulalry on the path to see if it changed somehow. You
1344can specify a recommended polling interval for this case. If you specify
1345a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable,
1346unspecified default\fR value will be used (which you can expect to be around
1347five seconds, although this might change dynamically). Libev will also
1348impose a minimum interval which is currently around \f(CW0.1\fR, but thats
1349usually overkill.
1350.PP
1351This watcher type is not meant for massive numbers of stat watchers,
1352as even with OS-supported change notifications, this can be
1353resource\-intensive.
1354.PP
1355At the time of this writing, no specific \s-1OS\s0 backends are implemented, but
1356if demand increases, at least a kqueue and inotify backend will be added.
1357.IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4
1358.IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)"
1359.PD 0
1360.IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4
1361.IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)"
1362.PD
1363Configures the watcher to wait for status changes of the given
1364\&\f(CW\*(C`path\*(C'\fR. The \f(CW\*(C`interval\*(C'\fR is a hint on how quickly a change is expected to
1365be detected and should normally be specified as \f(CW0\fR to let libev choose
1366a suitable value. The memory pointed to by \f(CW\*(C`path\*(C'\fR must point to the same
1367path for as long as the watcher is active.
1368.Sp
1369The callback will be receive \f(CW\*(C`EV_STAT\*(C'\fR when a change was detected,
1370relative to the attributes at the time the watcher was started (or the
1371last change was detected).
1372.IP "ev_stat_stat (ev_stat *)" 4
1373.IX Item "ev_stat_stat (ev_stat *)"
1374Updates the stat buffer immediately with new values. If you change the
1375watched path in your callback, you could call this fucntion to avoid
1376detecting this change (while introducing a race condition). Can also be
1377useful simply to find out the new values.
1378.IP "ev_statdata attr [read\-only]" 4
1379.IX Item "ev_statdata attr [read-only]"
1380The most-recently detected attributes of the file. Although the type is of
1381\&\f(CW\*(C`ev_statdata\*(C'\fR, this is usually the (or one of the) \f(CW\*(C`struct stat\*(C'\fR types
1382suitable for your system. If the \f(CW\*(C`st_nlink\*(C'\fR member is \f(CW0\fR, then there
1383was some error while \f(CW\*(C`stat\*(C'\fRing the file.
1384.IP "ev_statdata prev [read\-only]" 4
1385.IX Item "ev_statdata prev [read-only]"
1386The previous attributes of the file. The callback gets invoked whenever
1387\&\f(CW\*(C`prev\*(C'\fR != \f(CW\*(C`attr\*(C'\fR.
1388.IP "ev_tstamp interval [read\-only]" 4
1389.IX Item "ev_tstamp interval [read-only]"
1390The specified interval.
1391.IP "const char *path [read\-only]" 4
1392.IX Item "const char *path [read-only]"
1393The filesystem path that is being watched.
1394.PP
1395Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes.
1396.PP
1397.Vb 15
1398\& static void
1399\& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1400\& {
1401\& /* /etc/passwd changed in some way */
1402\& if (w->attr.st_nlink)
1403\& {
1404\& printf ("passwd current size %ld\en", (long)w->attr.st_size);
1405\& printf ("passwd current atime %ld\en", (long)w->attr.st_mtime);
1406\& printf ("passwd current mtime %ld\en", (long)w->attr.st_mtime);
1407\& }
1408\& else
1409\& /* you shalt not abuse printf for puts */
1410\& puts ("wow, /etc/passwd is not there, expect problems. "
1411\& "if this is windows, they already arrived\en");
1412\& }
1413.Ve
1414.PP
1415.Vb 2
1416\& ...
1417\& ev_stat passwd;
1418.Ve
1419.PP
1420.Vb 2
1421\& ev_stat_init (&passwd, passwd_cb, "/etc/passwd");
1422\& ev_stat_start (loop, &passwd);
1197.Ve 1423.Ve
1198.ie n .Sh """ev_idle"" \- when you've got nothing better to do..." 1424.ie n .Sh """ev_idle"" \- when you've got nothing better to do..."
1199.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." 1425.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..."
1200.IX Subsection "ev_idle - when you've got nothing better to do..." 1426.IX Subsection "ev_idle - when you've got nothing better to do..."
1201Idle watchers trigger events when there are no other events are pending 1427Idle watchers trigger events when there are no other events are pending
1242.IX Subsection "ev_prepare and ev_check - customise your event loop!" 1468.IX Subsection "ev_prepare and ev_check - customise your event loop!"
1243Prepare and check watchers are usually (but not always) used in tandem: 1469Prepare and check watchers are usually (but not always) used in tandem:
1244prepare watchers get invoked before the process blocks and check watchers 1470prepare watchers get invoked before the process blocks and check watchers
1245afterwards. 1471afterwards.
1246.PP 1472.PP
1473You \fImust not\fR call \f(CW\*(C`ev_loop\*(C'\fR or similar functions that enter
1474the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR
1475watchers. Other loops than the current one are fine, however. The
1476rationale behind this is that you do not need to check for recursion in
1477those watchers, i.e. the sequence will always be \f(CW\*(C`ev_prepare\*(C'\fR, blocking,
1478\&\f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each kind they will always be
1479called in pairs bracketing the blocking call.
1480.PP
1247Their main purpose is to integrate other event mechanisms into libev and 1481Their main purpose is to integrate other event mechanisms into libev and
1248their use is somewhat advanced. This could be used, for example, to track 1482their use is somewhat advanced. This could be used, for example, to track
1249variable changes, implement your own watchers, integrate net-snmp or a 1483variable changes, implement your own watchers, integrate net-snmp or a
1250coroutine library and lots more. 1484coroutine library and lots more. They are also occasionally useful if
1485you cache some data and want to flush it before blocking (for example,
1486in X programs you might want to do an \f(CW\*(C`XFlush ()\*(C'\fR in an \f(CW\*(C`ev_prepare\*(C'\fR
1487watcher).
1251.PP 1488.PP
1252This is done by examining in each prepare call which file descriptors need 1489This is done by examining in each prepare call which file descriptors need
1253to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers for 1490to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers for
1254them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many libraries 1491them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many libraries
1255provide just this functionality). Then, in the check watcher you check for 1492provide just this functionality). Then, in the check watcher you check for
1274.PD 1511.PD
1275Initialises and configures the prepare or check watcher \- they have no 1512Initialises and configures the prepare or check watcher \- they have no
1276parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR 1513parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR
1277macros, but using them is utterly, utterly and completely pointless. 1514macros, but using them is utterly, utterly and completely pointless.
1278.PP 1515.PP
1279Example: *TODO*. 1516Example: To include a library such as adns, you would add \s-1IO\s0 watchers
1517and a timeout watcher in a prepare handler, as required by libadns, and
1518in a check watcher, destroy them and call into libadns. What follows is
1519pseudo-code only of course:
1520.PP
1521.Vb 2
1522\& static ev_io iow [nfd];
1523\& static ev_timer tw;
1524.Ve
1525.PP
1526.Vb 9
1527\& static void
1528\& io_cb (ev_loop *loop, ev_io *w, int revents)
1529\& {
1530\& // set the relevant poll flags
1531\& // could also call adns_processreadable etc. here
1532\& struct pollfd *fd = (struct pollfd *)w->data;
1533\& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1534\& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1535\& }
1536.Ve
1537.PP
1538.Vb 7
1539\& // create io watchers for each fd and a timer before blocking
1540\& static void
1541\& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
1542\& {
1543\& int timeout = 3600000;truct pollfd fds [nfd];
1544\& // actual code will need to loop here and realloc etc.
1545\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1546.Ve
1547.PP
1548.Vb 3
1549\& /* the callback is illegal, but won't be called as we stop during check */
1550\& ev_timer_init (&tw, 0, timeout * 1e-3);
1551\& ev_timer_start (loop, &tw);
1552.Ve
1553.PP
1554.Vb 6
1555\& // create on ev_io per pollfd
1556\& for (int i = 0; i < nfd; ++i)
1557\& {
1558\& ev_io_init (iow + i, io_cb, fds [i].fd,
1559\& ((fds [i].events & POLLIN ? EV_READ : 0)
1560\& | (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1561.Ve
1562.PP
1563.Vb 5
1564\& fds [i].revents = 0;
1565\& iow [i].data = fds + i;
1566\& ev_io_start (loop, iow + i);
1567\& }
1568\& }
1569.Ve
1570.PP
1571.Vb 5
1572\& // stop all watchers after blocking
1573\& static void
1574\& adns_check_cb (ev_loop *loop, ev_check *w, int revents)
1575\& {
1576\& ev_timer_stop (loop, &tw);
1577.Ve
1578.PP
1579.Vb 2
1580\& for (int i = 0; i < nfd; ++i)
1581\& ev_io_stop (loop, iow + i);
1582.Ve
1583.PP
1584.Vb 2
1585\& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
1586\& }
1587.Ve
1280.ie n .Sh """ev_embed"" \- when one backend isn't enough..." 1588.ie n .Sh """ev_embed"" \- when one backend isn't enough..."
1281.el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." 1589.el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..."
1282.IX Subsection "ev_embed - when one backend isn't enough..." 1590.IX Subsection "ev_embed - when one backend isn't enough..."
1283This is a rather advanced watcher type that lets you embed one event loop 1591This is a rather advanced watcher type that lets you embed one event loop
1284into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded 1592into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded
1367.IP "ev_embed_sweep (loop, ev_embed *)" 4 1675.IP "ev_embed_sweep (loop, ev_embed *)" 4
1368.IX Item "ev_embed_sweep (loop, ev_embed *)" 1676.IX Item "ev_embed_sweep (loop, ev_embed *)"
1369Make a single, non-blocking sweep over the embedded loop. This works 1677Make a single, non-blocking sweep over the embedded loop. This works
1370similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most 1678similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most
1371apropriate way for embedded loops. 1679apropriate way for embedded loops.
1680.IP "struct ev_loop *loop [read\-only]" 4
1681.IX Item "struct ev_loop *loop [read-only]"
1682The embedded event loop.
1683.ie n .Sh """ev_fork"" \- the audacity to resume the event loop after a fork"
1684.el .Sh "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork"
1685.IX Subsection "ev_fork - the audacity to resume the event loop after a fork"
1686Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because
1687whoever is a good citizen cared to tell libev about it by calling
1688\&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the
1689event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called,
1690and only in the child after the fork. If whoever good citizen calling
1691\&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork
1692handlers will be invoked, too, of course.
1693.IP "ev_fork_init (ev_signal *, callback)" 4
1694.IX Item "ev_fork_init (ev_signal *, callback)"
1695Initialises and configures the fork watcher \- it has no parameters of any
1696kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless,
1697believe me.
1372.SH "OTHER FUNCTIONS" 1698.SH "OTHER FUNCTIONS"
1373.IX Header "OTHER FUNCTIONS" 1699.IX Header "OTHER FUNCTIONS"
1374There are some other functions of possible interest. Described. Here. Now. 1700There are some other functions of possible interest. Described. Here. Now.
1375.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 1701.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4
1376.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 1702.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)"
1515\&\f(CW\*(C`ev_TYPE_again\*(C'\fR function. 1841\&\f(CW\*(C`ev_TYPE_again\*(C'\fR function.
1516.ie n .IP "w\->sweep () ""ev::embed"" only" 4 1842.ie n .IP "w\->sweep () ""ev::embed"" only" 4
1517.el .IP "w\->sweep () \f(CWev::embed\fR only" 4 1843.el .IP "w\->sweep () \f(CWev::embed\fR only" 4
1518.IX Item "w->sweep () ev::embed only" 1844.IX Item "w->sweep () ev::embed only"
1519Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR. 1845Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR.
1846.ie n .IP "w\->update () ""ev::stat"" only" 4
1847.el .IP "w\->update () \f(CWev::stat\fR only" 4
1848.IX Item "w->update () ev::stat only"
1849Invokes \f(CW\*(C`ev_stat_stat\*(C'\fR.
1520.RE 1850.RE
1521.RS 4 1851.RS 4
1522.RE 1852.RE
1523.PP 1853.PP
1524Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in 1854Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in
1541\& : io (this, &myclass::io_cb), 1871\& : io (this, &myclass::io_cb),
1542\& idle (this, &myclass::idle_cb) 1872\& idle (this, &myclass::idle_cb)
1543\& { 1873\& {
1544\& io.start (fd, ev::READ); 1874\& io.start (fd, ev::READ);
1545\& } 1875\& }
1876.Ve
1877.SH "MACRO MAGIC"
1878.IX Header "MACRO MAGIC"
1879Libev can be compiled with a variety of options, the most fundemantal is
1880\&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines wether (most) functions and
1881callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument.
1882.PP
1883To make it easier to write programs that cope with either variant, the
1884following macros are defined:
1885.ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4
1886.el .IP "\f(CWEV_A\fR, \f(CWEV_A_\fR" 4
1887.IX Item "EV_A, EV_A_"
1888This provides the loop \fIargument\fR for functions, if one is required (\*(L"ev
1889loop argument\*(R"). The \f(CW\*(C`EV_A\*(C'\fR form is used when this is the sole argument,
1890\&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example:
1891.Sp
1892.Vb 3
1893\& ev_unref (EV_A);
1894\& ev_timer_add (EV_A_ watcher);
1895\& ev_loop (EV_A_ 0);
1896.Ve
1897.Sp
1898It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope,
1899which is often provided by the following macro.
1900.ie n .IP """EV_P""\fR, \f(CW""EV_P_""" 4
1901.el .IP "\f(CWEV_P\fR, \f(CWEV_P_\fR" 4
1902.IX Item "EV_P, EV_P_"
1903This provides the loop \fIparameter\fR for functions, if one is required (\*(L"ev
1904loop parameter\*(R"). The \f(CW\*(C`EV_P\*(C'\fR form is used when this is the sole parameter,
1905\&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example:
1906.Sp
1907.Vb 2
1908\& // this is how ev_unref is being declared
1909\& static void ev_unref (EV_P);
1910.Ve
1911.Sp
1912.Vb 2
1913\& // this is how you can declare your typical callback
1914\& static void cb (EV_P_ ev_timer *w, int revents)
1915.Ve
1916.Sp
1917It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite
1918suitable for use with \f(CW\*(C`EV_A\*(C'\fR.
1919.ie n .IP """EV_DEFAULT""\fR, \f(CW""EV_DEFAULT_""" 4
1920.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4
1921.IX Item "EV_DEFAULT, EV_DEFAULT_"
1922Similar to the other two macros, this gives you the value of the default
1923loop, if multiple loops are supported (\*(L"ev loop default\*(R").
1924.PP
1925Example: Declare and initialise a check watcher, working regardless of
1926wether multiple loops are supported or not.
1927.PP
1928.Vb 5
1929\& static void
1930\& check_cb (EV_P_ ev_timer *w, int revents)
1931\& {
1932\& ev_check_stop (EV_A_ w);
1933\& }
1934.Ve
1935.PP
1936.Vb 4
1937\& ev_check check;
1938\& ev_check_init (&check, check_cb);
1939\& ev_check_start (EV_DEFAULT_ &check);
1940\& ev_loop (EV_DEFAULT_ 0);
1546.Ve 1941.Ve
1547.SH "EMBEDDING" 1942.SH "EMBEDDING"
1548.IX Header "EMBEDDING" 1943.IX Header "EMBEDDING"
1549Libev can (and often is) directly embedded into host 1944Libev can (and often is) directly embedded into host
1550applications. Examples of applications that embed it include the Deliantra 1945applications. Examples of applications that embed it include the Deliantra
1757If undefined or defined to \f(CW1\fR, then all event-loop-specific functions 2152If undefined or defined to \f(CW1\fR, then all event-loop-specific functions
1758will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create 2153will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create
1759additional independent event loops. Otherwise there will be no support 2154additional independent event loops. Otherwise there will be no support
1760for multiple event loops and there is no first event loop pointer 2155for multiple event loops and there is no first event loop pointer
1761argument. Instead, all functions act on the single default loop. 2156argument. Instead, all functions act on the single default loop.
1762.IP "\s-1EV_PERIODICS\s0" 4 2157.IP "\s-1EV_PERIODIC_ENABLE\s0" 4
1763.IX Item "EV_PERIODICS" 2158.IX Item "EV_PERIODIC_ENABLE"
1764If undefined or defined to be \f(CW1\fR, then periodic timers are supported, 2159If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If
1765otherwise not. This saves a few kb of code. 2160defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of
2161code.
2162.IP "\s-1EV_EMBED_ENABLE\s0" 4
2163.IX Item "EV_EMBED_ENABLE"
2164If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If
2165defined to be \f(CW0\fR, then they are not.
2166.IP "\s-1EV_STAT_ENABLE\s0" 4
2167.IX Item "EV_STAT_ENABLE"
2168If undefined or defined to be \f(CW1\fR, then stat watchers are supported. If
2169defined to be \f(CW0\fR, then they are not.
2170.IP "\s-1EV_FORK_ENABLE\s0" 4
2171.IX Item "EV_FORK_ENABLE"
2172If undefined or defined to be \f(CW1\fR, then fork watchers are supported. If
2173defined to be \f(CW0\fR, then they are not.
2174.IP "\s-1EV_MINIMAL\s0" 4
2175.IX Item "EV_MINIMAL"
2176If you need to shave off some kilobytes of code at the expense of some
2177speed, define this symbol to \f(CW1\fR. Currently only used for gcc to override
2178some inlining decisions, saves roughly 30% codesize of amd64.
2179.IP "\s-1EV_PID_HASHSIZE\s0" 4
2180.IX Item "EV_PID_HASHSIZE"
2181\&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by
2182pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more
2183than enough. If you need to manage thousands of children you might want to
2184increase this value.
1766.IP "\s-1EV_COMMON\s0" 4 2185.IP "\s-1EV_COMMON\s0" 4
1767.IX Item "EV_COMMON" 2186.IX Item "EV_COMMON"
1768By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining 2187By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining
1769this macro to a something else you can include more and other types of 2188this macro to a something else you can include more and other types of
1770members. You have to define it each time you include one of the files, 2189members. You have to define it each time you include one of the files,
1819.Sp 2238.Sp
1820.Vb 2 2239.Vb 2
1821\& #include "ev_cpp.h" 2240\& #include "ev_cpp.h"
1822\& #include "ev.c" 2241\& #include "ev.c"
1823.Ve 2242.Ve
2243.SH "COMPLEXITIES"
2244.IX Header "COMPLEXITIES"
2245In this section the complexities of (many of) the algorithms used inside
2246libev will be explained. For complexity discussions about backends see the
2247documentation for \f(CW\*(C`ev_default_init\*(C'\fR.
2248.RS 4
2249.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4
2250.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)"
2251.PD 0
2252.IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4
2253.IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)"
2254.IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4
2255.IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)"
2256.IP "Stopping check/prepare/idle watchers: O(1)" 4
2257.IX Item "Stopping check/prepare/idle watchers: O(1)"
2258.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))" 4
2259.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))"
2260.IP "Finding the next timer per loop iteration: O(1)" 4
2261.IX Item "Finding the next timer per loop iteration: O(1)"
2262.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4
2263.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)"
2264.IP "Activating one watcher: O(1)" 4
2265.IX Item "Activating one watcher: O(1)"
2266.RE
2267.RS 4
2268.PD
1824.SH "AUTHOR" 2269.SH "AUTHOR"
1825.IX Header "AUTHOR" 2270.IX Header "AUTHOR"
1826Marc Lehmann <libev@schmorp.de>. 2271Marc Lehmann <libev@schmorp.de>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines