… | |
… | |
129 | . ds Ae AE |
129 | . ds Ae AE |
130 | .\} |
130 | .\} |
131 | .rm #[ #] #H #V #F C |
131 | .rm #[ #] #H #V #F C |
132 | .\" ======================================================================== |
132 | .\" ======================================================================== |
133 | .\" |
133 | .\" |
134 | .IX Title "EV 1" |
134 | .IX Title "LIBEV 3" |
135 | .TH EV 1 "2008-04-02" "perl v5.10.0" "User Contributed Perl Documentation" |
135 | .TH LIBEV 3 "2008-05-22" "libev-3.41" "libev - high perfromance full featured event loop" |
136 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
136 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
137 | .\" way too many mistakes in technical documents. |
137 | .\" way too many mistakes in technical documents. |
138 | .if n .ad l |
138 | .if n .ad l |
139 | .nh |
139 | .nh |
140 | .SH "NAME" |
140 | .SH "NAME" |
… | |
… | |
203 | .Ve |
203 | .Ve |
204 | .SH "DESCRIPTION" |
204 | .SH "DESCRIPTION" |
205 | .IX Header "DESCRIPTION" |
205 | .IX Header "DESCRIPTION" |
206 | The newest version of this document is also available as an html-formatted |
206 | The newest version of this document is also available as an html-formatted |
207 | web page you might find easier to navigate when reading it for the first |
207 | web page you might find easier to navigate when reading it for the first |
208 | time: <http://cvs.schmorp.de/libev/ev.html>. |
208 | time: <http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>. |
209 | .PP |
209 | .PP |
210 | Libev is an event loop: you register interest in certain events (such as a |
210 | Libev is an event loop: you register interest in certain events (such as a |
211 | file descriptor being readable or a timeout occurring), and it will manage |
211 | file descriptor being readable or a timeout occurring), and it will manage |
212 | these event sources and provide your program with events. |
212 | these event sources and provide your program with events. |
213 | .PP |
213 | .PP |
… | |
… | |
252 | called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually aliases |
252 | called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually aliases |
253 | to the \f(CW\*(C`double\*(C'\fR type in C, and when you need to do any calculations on |
253 | to the \f(CW\*(C`double\*(C'\fR type in C, and when you need to do any calculations on |
254 | it, you should treat it as some floatingpoint value. Unlike the name |
254 | it, you should treat it as some floatingpoint value. Unlike the name |
255 | component \f(CW\*(C`stamp\*(C'\fR might indicate, it is also used for time differences |
255 | component \f(CW\*(C`stamp\*(C'\fR might indicate, it is also used for time differences |
256 | throughout libev. |
256 | throughout libev. |
|
|
257 | .SH "ERROR HANDLING" |
|
|
258 | .IX Header "ERROR HANDLING" |
|
|
259 | Libev knows three classes of errors: operating system errors, usage errors |
|
|
260 | and internal errors (bugs). |
|
|
261 | .PP |
|
|
262 | When libev catches an operating system error it cannot handle (for example |
|
|
263 | a syscall indicating a condition libev cannot fix), it calls the callback |
|
|
264 | set via \f(CW\*(C`ev_set_syserr_cb\*(C'\fR, which is supposed to fix the problem or |
|
|
265 | abort. The default is to print a diagnostic message and to call \f(CW\*(C`abort |
|
|
266 | ()\*(C'\fR. |
|
|
267 | .PP |
|
|
268 | When libev detects a usage error such as a negative timer interval, then |
|
|
269 | it will print a diagnostic message and abort (via the \f(CW\*(C`assert\*(C'\fR mechanism, |
|
|
270 | so \f(CW\*(C`NDEBUG\*(C'\fR will disable this checking): these are programming errors in |
|
|
271 | the libev caller and need to be fixed there. |
|
|
272 | .PP |
|
|
273 | Libev also has a few internal error-checking \f(CW\*(C`assert\*(C'\fRions, and also has |
|
|
274 | extensive consistency checking code. These do not trigger under normal |
|
|
275 | circumstances, as they indicate either a bug in libev or worse. |
257 | .SH "GLOBAL FUNCTIONS" |
276 | .SH "GLOBAL FUNCTIONS" |
258 | .IX Header "GLOBAL FUNCTIONS" |
277 | .IX Header "GLOBAL FUNCTIONS" |
259 | These functions can be called anytime, even before initialising the |
278 | These functions can be called anytime, even before initialising the |
260 | library in any way. |
279 | library in any way. |
261 | .IP "ev_tstamp ev_time ()" 4 |
280 | .IP "ev_tstamp ev_time ()" 4 |
… | |
… | |
328 | .Sp |
347 | .Sp |
329 | See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. |
348 | See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. |
330 | .IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4 |
349 | .IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4 |
331 | .IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" |
350 | .IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" |
332 | Sets the allocation function to use (the prototype is similar \- the |
351 | Sets the allocation function to use (the prototype is similar \- the |
333 | semantics is identical \- to the realloc C function). It is used to |
352 | semantics are identical to the \f(CW\*(C`realloc\*(C'\fR C89/SuS/POSIX function). It is |
334 | allocate and free memory (no surprises here). If it returns zero when |
353 | used to allocate and free memory (no surprises here). If it returns zero |
335 | memory needs to be allocated, the library might abort or take some |
354 | when memory needs to be allocated (\f(CW\*(C`size != 0\*(C'\fR), the library might abort |
336 | potentially destructive action. The default is your system realloc |
355 | or take some potentially destructive action. |
337 | function. |
356 | .Sp |
|
|
357 | Since some systems (at least OpenBSD and Darwin) fail to implement |
|
|
358 | correct \f(CW\*(C`realloc\*(C'\fR semantics, libev will use a wrapper around the system |
|
|
359 | \&\f(CW\*(C`realloc\*(C'\fR and \f(CW\*(C`free\*(C'\fR functions by default. |
338 | .Sp |
360 | .Sp |
339 | You could override this function in high-availability programs to, say, |
361 | You could override this function in high-availability programs to, say, |
340 | free some memory if it cannot allocate memory, to use a special allocator, |
362 | free some memory if it cannot allocate memory, to use a special allocator, |
341 | or even to sleep a while and retry until some memory is available. |
363 | or even to sleep a while and retry until some memory is available. |
342 | .Sp |
364 | .Sp |
343 | Example: Replace the libev allocator with one that waits a bit and then |
365 | Example: Replace the libev allocator with one that waits a bit and then |
344 | retries). |
366 | retries (example requires a standards-compliant \f(CW\*(C`realloc\*(C'\fR). |
345 | .Sp |
367 | .Sp |
346 | .Vb 6 |
368 | .Vb 6 |
347 | \& static void * |
369 | \& static void * |
348 | \& persistent_realloc (void *ptr, size_t size) |
370 | \& persistent_realloc (void *ptr, size_t size) |
349 | \& { |
371 | \& { |
… | |
… | |
387 | .SH "FUNCTIONS CONTROLLING THE EVENT LOOP" |
409 | .SH "FUNCTIONS CONTROLLING THE EVENT LOOP" |
388 | .IX Header "FUNCTIONS CONTROLLING THE EVENT LOOP" |
410 | .IX Header "FUNCTIONS CONTROLLING THE EVENT LOOP" |
389 | An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR. The library knows two |
411 | An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR. The library knows two |
390 | types of such loops, the \fIdefault\fR loop, which supports signals and child |
412 | types of such loops, the \fIdefault\fR loop, which supports signals and child |
391 | events, and dynamically created loops which do not. |
413 | events, and dynamically created loops which do not. |
392 | .PP |
|
|
393 | If you use threads, a common model is to run the default event loop |
|
|
394 | in your main thread (or in a separate thread) and for each thread you |
|
|
395 | create, you also create another event loop. Libev itself does no locking |
|
|
396 | whatsoever, so if you mix calls to the same event loop in different |
|
|
397 | threads, make sure you lock (this is usually a bad idea, though, even if |
|
|
398 | done correctly, because it's hideous and inefficient). |
|
|
399 | .IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4 |
414 | .IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4 |
400 | .IX Item "struct ev_loop *ev_default_loop (unsigned int flags)" |
415 | .IX Item "struct ev_loop *ev_default_loop (unsigned int flags)" |
401 | This will initialise the default event loop if it hasn't been initialised |
416 | This will initialise the default event loop if it hasn't been initialised |
402 | yet and return it. If the default loop could not be initialised, returns |
417 | yet and return it. If the default loop could not be initialised, returns |
403 | false. If it already was initialised it simply returns it (and ignores the |
418 | false. If it already was initialised it simply returns it (and ignores the |
… | |
… | |
468 | To get good performance out of this backend you need a high amount of |
483 | To get good performance out of this backend you need a high amount of |
469 | parallelity (most of the file descriptors should be busy). If you are |
484 | parallelity (most of the file descriptors should be busy). If you are |
470 | writing a server, you should \f(CW\*(C`accept ()\*(C'\fR in a loop to accept as many |
485 | writing a server, you should \f(CW\*(C`accept ()\*(C'\fR in a loop to accept as many |
471 | connections as possible during one iteration. You might also want to have |
486 | connections as possible during one iteration. You might also want to have |
472 | a look at \f(CW\*(C`ev_set_io_collect_interval ()\*(C'\fR to increase the amount of |
487 | a look at \f(CW\*(C`ev_set_io_collect_interval ()\*(C'\fR to increase the amount of |
473 | readyness notifications you get per iteration. |
488 | readiness notifications you get per iteration. |
474 | .ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4 |
489 | .ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4 |
475 | .el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4 |
490 | .el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4 |
476 | .IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)" |
491 | .IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)" |
477 | And this is your standard \fIpoll\fR\|(2) backend. It's more complicated |
492 | And this is your standard \fIpoll\fR\|(2) backend. It's more complicated |
478 | than select, but handles sparse fds better and has no artificial |
493 | than select, but handles sparse fds better and has no artificial |
… | |
… | |
486 | For few fds, this backend is a bit little slower than poll and select, |
501 | For few fds, this backend is a bit little slower than poll and select, |
487 | but it scales phenomenally better. While poll and select usually scale |
502 | but it scales phenomenally better. While poll and select usually scale |
488 | like O(total_fds) where n is the total number of fds (or the highest fd), |
503 | like O(total_fds) where n is the total number of fds (or the highest fd), |
489 | epoll scales either O(1) or O(active_fds). The epoll design has a number |
504 | epoll scales either O(1) or O(active_fds). The epoll design has a number |
490 | of shortcomings, such as silently dropping events in some hard-to-detect |
505 | of shortcomings, such as silently dropping events in some hard-to-detect |
491 | cases and rewiring a syscall per fd change, no fork support and bad |
506 | cases and requiring a syscall per fd change, no fork support and bad |
492 | support for dup. |
507 | support for dup. |
493 | .Sp |
508 | .Sp |
494 | While stopping, setting and starting an I/O watcher in the same iteration |
509 | While stopping, setting and starting an I/O watcher in the same iteration |
495 | will result in some caching, there is still a syscall per such incident |
510 | will result in some caching, there is still a syscall per such incident |
496 | (because the fd could point to a different file description now), so its |
511 | (because the fd could point to a different file description now), so its |
… | |
… | |
557 | While this backend scales well, it requires one system call per active |
572 | While this backend scales well, it requires one system call per active |
558 | file descriptor per loop iteration. For small and medium numbers of file |
573 | file descriptor per loop iteration. For small and medium numbers of file |
559 | descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend |
574 | descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend |
560 | might perform better. |
575 | might perform better. |
561 | .Sp |
576 | .Sp |
562 | On the positive side, ignoring the spurious readyness notifications, this |
577 | On the positive side, ignoring the spurious readiness notifications, this |
563 | backend actually performed to specification in all tests and is fully |
578 | backend actually performed to specification in all tests and is fully |
564 | embeddable, which is a rare feat among the OS-specific backends. |
579 | embeddable, which is a rare feat among the OS-specific backends. |
565 | .ie n .IP """EVBACKEND_ALL""" 4 |
580 | .ie n .IP """EVBACKEND_ALL""" 4 |
566 | .el .IP "\f(CWEVBACKEND_ALL\fR" 4 |
581 | .el .IP "\f(CWEVBACKEND_ALL\fR" 4 |
567 | .IX Item "EVBACKEND_ALL" |
582 | .IX Item "EVBACKEND_ALL" |
… | |
… | |
830 | Many (busy) programs can usually benefit by setting the io collect |
845 | Many (busy) programs can usually benefit by setting the io collect |
831 | interval to a value near \f(CW0.1\fR or so, which is often enough for |
846 | interval to a value near \f(CW0.1\fR or so, which is often enough for |
832 | interactive servers (of course not for games), likewise for timeouts. It |
847 | interactive servers (of course not for games), likewise for timeouts. It |
833 | usually doesn't make much sense to set it to a lower value than \f(CW0.01\fR, |
848 | usually doesn't make much sense to set it to a lower value than \f(CW0.01\fR, |
834 | as this approsaches the timing granularity of most systems. |
849 | as this approsaches the timing granularity of most systems. |
|
|
850 | .IP "ev_loop_verify (loop)" 4 |
|
|
851 | .IX Item "ev_loop_verify (loop)" |
|
|
852 | This function only does something when \f(CW\*(C`EV_VERIFY\*(C'\fR support has been |
|
|
853 | compiled in. It tries to go through all internal structures and checks |
|
|
854 | them for validity. If anything is found to be inconsistent, it will print |
|
|
855 | an error message to standard error and call \f(CW\*(C`abort ()\*(C'\fR. |
|
|
856 | .Sp |
|
|
857 | This can be used to catch bugs inside libev itself: under normal |
|
|
858 | circumstances, this function will never abort as of course libev keeps its |
|
|
859 | data structures consistent. |
835 | .SH "ANATOMY OF A WATCHER" |
860 | .SH "ANATOMY OF A WATCHER" |
836 | .IX Header "ANATOMY OF A WATCHER" |
861 | .IX Header "ANATOMY OF A WATCHER" |
837 | A watcher is a structure that you create and register to record your |
862 | A watcher is a structure that you create and register to record your |
838 | interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to |
863 | interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to |
839 | become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher for that: |
864 | become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher for that: |
… | |
… | |
1167 | If you must do this, then force the use of a known-to-be-good backend |
1192 | If you must do this, then force the use of a known-to-be-good backend |
1168 | (at the time of this writing, this includes only \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and |
1193 | (at the time of this writing, this includes only \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and |
1169 | \&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR). |
1194 | \&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR). |
1170 | .PP |
1195 | .PP |
1171 | Another thing you have to watch out for is that it is quite easy to |
1196 | Another thing you have to watch out for is that it is quite easy to |
1172 | receive \*(L"spurious\*(R" readyness notifications, that is your callback might |
1197 | receive \*(L"spurious\*(R" readiness notifications, that is your callback might |
1173 | be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block |
1198 | be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block |
1174 | because there is no data. Not only are some backends known to create a |
1199 | because there is no data. Not only are some backends known to create a |
1175 | lot of those (for example solaris ports), it is very easy to get into |
1200 | lot of those (for example solaris ports), it is very easy to get into |
1176 | this situation even with a relatively standard program structure. Thus |
1201 | this situation even with a relatively standard program structure. Thus |
1177 | it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning |
1202 | it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning |
… | |
… | |
1287 | .IX Subsection "ev_timer - relative and optionally repeating timeouts" |
1312 | .IX Subsection "ev_timer - relative and optionally repeating timeouts" |
1288 | Timer watchers are simple relative timers that generate an event after a |
1313 | Timer watchers are simple relative timers that generate an event after a |
1289 | given time, and optionally repeating in regular intervals after that. |
1314 | given time, and optionally repeating in regular intervals after that. |
1290 | .PP |
1315 | .PP |
1291 | The timers are based on real time, that is, if you register an event that |
1316 | The timers are based on real time, that is, if you register an event that |
1292 | times out after an hour and you reset your system clock to last years |
1317 | times out after an hour and you reset your system clock to january last |
1293 | time, it will still time out after (roughly) and hour. \*(L"Roughly\*(R" because |
1318 | year, it will still time out after (roughly) and hour. \*(L"Roughly\*(R" because |
1294 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1319 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1295 | monotonic clock option helps a lot here). |
1320 | monotonic clock option helps a lot here). |
1296 | .PP |
1321 | .PP |
1297 | The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR |
1322 | The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR |
1298 | time. This is usually the right thing as this timestamp refers to the time |
1323 | time. This is usually the right thing as this timestamp refers to the time |
… | |
… | |
1302 | .PP |
1327 | .PP |
1303 | .Vb 1 |
1328 | .Vb 1 |
1304 | \& ev_timer_set (&timer, after + ev_now () \- ev_time (), 0.); |
1329 | \& ev_timer_set (&timer, after + ev_now () \- ev_time (), 0.); |
1305 | .Ve |
1330 | .Ve |
1306 | .PP |
1331 | .PP |
1307 | The callback is guarenteed to be invoked only when its timeout has passed, |
1332 | The callback is guarenteed to be invoked only after its timeout has passed, |
1308 | but if multiple timers become ready during the same loop iteration then |
1333 | but if multiple timers become ready during the same loop iteration then |
1309 | order of execution is undefined. |
1334 | order of execution is undefined. |
1310 | .PP |
1335 | .PP |
1311 | \fIWatcher-Specific Functions and Data Members\fR |
1336 | \fIWatcher-Specific Functions and Data Members\fR |
1312 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1337 | .IX Subsection "Watcher-Specific Functions and Data Members" |
… | |
… | |
1314 | .IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" |
1339 | .IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" |
1315 | .PD 0 |
1340 | .PD 0 |
1316 | .IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 |
1341 | .IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 |
1317 | .IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" |
1342 | .IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" |
1318 | .PD |
1343 | .PD |
1319 | Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds. If \f(CW\*(C`repeat\*(C'\fR is |
1344 | Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds. If \f(CW\*(C`repeat\*(C'\fR |
1320 | \&\f(CW0.\fR, then it will automatically be stopped. If it is positive, then the |
1345 | is \f(CW0.\fR, then it will automatically be stopped once the timeout is |
1321 | timer will automatically be configured to trigger again \f(CW\*(C`repeat\*(C'\fR seconds |
1346 | reached. If it is positive, then the timer will automatically be |
1322 | later, again, and again, until stopped manually. |
1347 | configured to trigger again \f(CW\*(C`repeat\*(C'\fR seconds later, again, and again, |
|
|
1348 | until stopped manually. |
1323 | .Sp |
1349 | .Sp |
1324 | The timer itself will do a best-effort at avoiding drift, that is, if you |
1350 | The timer itself will do a best-effort at avoiding drift, that is, if |
1325 | configure a timer to trigger every 10 seconds, then it will trigger at |
1351 | you configure a timer to trigger every 10 seconds, then it will normally |
1326 | exactly 10 second intervals. If, however, your program cannot keep up with |
1352 | trigger at exactly 10 second intervals. If, however, your program cannot |
1327 | the timer (because it takes longer than those 10 seconds to do stuff) the |
1353 | keep up with the timer (because it takes longer than those 10 seconds to |
1328 | timer will not fire more than once per event loop iteration. |
1354 | do stuff) the timer will not fire more than once per event loop iteration. |
1329 | .IP "ev_timer_again (loop, ev_timer *)" 4 |
1355 | .IP "ev_timer_again (loop, ev_timer *)" 4 |
1330 | .IX Item "ev_timer_again (loop, ev_timer *)" |
1356 | .IX Item "ev_timer_again (loop, ev_timer *)" |
1331 | This will act as if the timer timed out and restart it again if it is |
1357 | This will act as if the timer timed out and restart it again if it is |
1332 | repeating. The exact semantics are: |
1358 | repeating. The exact semantics are: |
1333 | .Sp |
1359 | .Sp |
… | |
… | |
1412 | Periodic watchers are also timers of a kind, but they are very versatile |
1438 | Periodic watchers are also timers of a kind, but they are very versatile |
1413 | (and unfortunately a bit complex). |
1439 | (and unfortunately a bit complex). |
1414 | .PP |
1440 | .PP |
1415 | Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time) |
1441 | Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time) |
1416 | but on wallclock time (absolute time). You can tell a periodic watcher |
1442 | but on wallclock time (absolute time). You can tell a periodic watcher |
1417 | to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a |
1443 | to trigger after some specific point in time. For example, if you tell a |
1418 | periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now () |
1444 | periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now () |
1419 | + 10.\*(C'\fR) and then reset your system clock to the last year, then it will |
1445 | + 10.\*(C'\fR, that is, an absolute time not a delay) and then reset your system |
|
|
1446 | clock to january of the previous year, then it will take more than year |
1420 | take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger |
1447 | to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would still trigger |
1421 | roughly 10 seconds later). |
1448 | roughly 10 seconds later as it uses a relative timeout). |
1422 | .PP |
1449 | .PP |
1423 | They can also be used to implement vastly more complex timers, such as |
1450 | \&\f(CW\*(C`ev_periodic\*(C'\fRs can also be used to implement vastly more complex timers, |
1424 | triggering an event on each midnight, local time or other, complicated, |
1451 | such as triggering an event on each \*(L"midnight, local time\*(R", or other |
1425 | rules. |
1452 | complicated, rules. |
1426 | .PP |
1453 | .PP |
1427 | As with timers, the callback is guarenteed to be invoked only when the |
1454 | As with timers, the callback is guarenteed to be invoked only when the |
1428 | time (\f(CW\*(C`at\*(C'\fR) has been passed, but if multiple periodic timers become ready |
1455 | time (\f(CW\*(C`at\*(C'\fR) has passed, but if multiple periodic timers become ready |
1429 | during the same loop iteration then order of execution is undefined. |
1456 | during the same loop iteration then order of execution is undefined. |
1430 | .PP |
1457 | .PP |
1431 | \fIWatcher-Specific Functions and Data Members\fR |
1458 | \fIWatcher-Specific Functions and Data Members\fR |
1432 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1459 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1433 | .IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 |
1460 | .IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 |
… | |
… | |
1440 | operation, and we will explain them from simplest to complex: |
1467 | operation, and we will explain them from simplest to complex: |
1441 | .RS 4 |
1468 | .RS 4 |
1442 | .IP "\(bu" 4 |
1469 | .IP "\(bu" 4 |
1443 | absolute timer (at = time, interval = reschedule_cb = 0) |
1470 | absolute timer (at = time, interval = reschedule_cb = 0) |
1444 | .Sp |
1471 | .Sp |
1445 | In this configuration the watcher triggers an event at the wallclock time |
1472 | In this configuration the watcher triggers an event after the wallclock |
1446 | \&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs, |
1473 | time \f(CW\*(C`at\*(C'\fR has passed and doesn't repeat. It will not adjust when a time |
1447 | that is, if it is to be run at January 1st 2011 then it will run when the |
1474 | jump occurs, that is, if it is to be run at January 1st 2011 then it will |
1448 | system time reaches or surpasses this time. |
1475 | run when the system time reaches or surpasses this time. |
1449 | .IP "\(bu" 4 |
1476 | .IP "\(bu" 4 |
1450 | repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) |
1477 | repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) |
1451 | .Sp |
1478 | .Sp |
1452 | In this mode the watcher will always be scheduled to time out at the next |
1479 | In this mode the watcher will always be scheduled to time out at the next |
1453 | \&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N, which can also be negative) |
1480 | \&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N, which can also be negative) |
1454 | and then repeat, regardless of any time jumps. |
1481 | and then repeat, regardless of any time jumps. |
1455 | .Sp |
1482 | .Sp |
1456 | This can be used to create timers that do not drift with respect to system |
1483 | This can be used to create timers that do not drift with respect to system |
1457 | time: |
1484 | time, for example, here is a \f(CW\*(C`ev_periodic\*(C'\fR that triggers each hour, on |
|
|
1485 | the hour: |
1458 | .Sp |
1486 | .Sp |
1459 | .Vb 1 |
1487 | .Vb 1 |
1460 | \& ev_periodic_set (&periodic, 0., 3600., 0); |
1488 | \& ev_periodic_set (&periodic, 0., 3600., 0); |
1461 | .Ve |
1489 | .Ve |
1462 | .Sp |
1490 | .Sp |
… | |
… | |
1469 | \&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible |
1497 | \&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible |
1470 | time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. |
1498 | time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. |
1471 | .Sp |
1499 | .Sp |
1472 | For numerical stability it is preferable that the \f(CW\*(C`at\*(C'\fR value is near |
1500 | For numerical stability it is preferable that the \f(CW\*(C`at\*(C'\fR value is near |
1473 | \&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for |
1501 | \&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for |
1474 | this value. |
1502 | this value, and in fact is often specified as zero. |
|
|
1503 | .Sp |
|
|
1504 | Note also that there is an upper limit to how often a timer can fire (cpu |
|
|
1505 | speed for example), so if \f(CW\*(C`interval\*(C'\fR is very small then timing stability |
|
|
1506 | will of course detoriate. Libev itself tries to be exact to be about one |
|
|
1507 | millisecond (if the \s-1OS\s0 supports it and the machine is fast enough). |
1475 | .IP "\(bu" 4 |
1508 | .IP "\(bu" 4 |
1476 | manual reschedule mode (at and interval ignored, reschedule_cb = callback) |
1509 | manual reschedule mode (at and interval ignored, reschedule_cb = callback) |
1477 | .Sp |
1510 | .Sp |
1478 | In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being |
1511 | In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being |
1479 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1512 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1480 | reschedule callback will be called with the watcher as first, and the |
1513 | reschedule callback will be called with the watcher as first, and the |
1481 | current time as second argument. |
1514 | current time as second argument. |
1482 | .Sp |
1515 | .Sp |
1483 | \&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, |
1516 | \&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, |
1484 | ever, or make any event loop modifications\fR. If you need to stop it, |
1517 | ever, or make \s-1ANY\s0 event loop modifications whatsoever\fR. |
1485 | return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop it afterwards (e.g. by |
1518 | .Sp |
|
|
1519 | If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop |
1486 | starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is legal). |
1520 | it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the |
|
|
1521 | only event loop modification you are allowed to do). |
1487 | .Sp |
1522 | .Sp |
1488 | Its prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
1523 | The callback prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic |
1489 | ev_tstamp now)\*(C'\fR, e.g.: |
1524 | *w, ev_tstamp now)\*(C'\fR, e.g.: |
1490 | .Sp |
1525 | .Sp |
1491 | .Vb 4 |
1526 | .Vb 4 |
1492 | \& static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) |
1527 | \& static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) |
1493 | \& { |
1528 | \& { |
1494 | \& return now + 60.; |
1529 | \& return now + 60.; |
… | |
… | |
1498 | It must return the next time to trigger, based on the passed time value |
1533 | It must return the next time to trigger, based on the passed time value |
1499 | (that is, the lowest time value larger than to the second argument). It |
1534 | (that is, the lowest time value larger than to the second argument). It |
1500 | will usually be called just before the callback will be triggered, but |
1535 | will usually be called just before the callback will be triggered, but |
1501 | might be called at other times, too. |
1536 | might be called at other times, too. |
1502 | .Sp |
1537 | .Sp |
1503 | \&\s-1NOTE:\s0 \fIThis callback must always return a time that is later than the |
1538 | \&\s-1NOTE:\s0 \fIThis callback must always return a time that is higher than or |
1504 | passed \f(CI\*(C`now\*(C'\fI value\fR. Not even \f(CW\*(C`now\*(C'\fR itself will do, it \fImust\fR be larger. |
1539 | equal to the passed \f(CI\*(C`now\*(C'\fI value\fR. |
1505 | .Sp |
1540 | .Sp |
1506 | This can be used to create very complex timers, such as a timer that |
1541 | This can be used to create very complex timers, such as a timer that |
1507 | triggers on each midnight, local time. To do this, you would calculate the |
1542 | triggers on \*(L"next midnight, local time\*(R". To do this, you would calculate the |
1508 | next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for this. How |
1543 | next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for this. How |
1509 | you do this is, again, up to you (but it is not trivial, which is the main |
1544 | you do this is, again, up to you (but it is not trivial, which is the main |
1510 | reason I omitted it as an example). |
1545 | reason I omitted it as an example). |
1511 | .RE |
1546 | .RE |
1512 | .RS 4 |
1547 | .RS 4 |
… | |
… | |
1515 | .IX Item "ev_periodic_again (loop, ev_periodic *)" |
1550 | .IX Item "ev_periodic_again (loop, ev_periodic *)" |
1516 | Simply stops and restarts the periodic watcher again. This is only useful |
1551 | Simply stops and restarts the periodic watcher again. This is only useful |
1517 | when you changed some parameters or the reschedule callback would return |
1552 | when you changed some parameters or the reschedule callback would return |
1518 | a different time than the last time it was called (e.g. in a crond like |
1553 | a different time than the last time it was called (e.g. in a crond like |
1519 | program when the crontabs have changed). |
1554 | program when the crontabs have changed). |
|
|
1555 | .IP "ev_tstamp ev_periodic_at (ev_periodic *)" 4 |
|
|
1556 | .IX Item "ev_tstamp ev_periodic_at (ev_periodic *)" |
|
|
1557 | When active, returns the absolute time that the watcher is supposed to |
|
|
1558 | trigger next. |
1520 | .IP "ev_tstamp offset [read\-write]" 4 |
1559 | .IP "ev_tstamp offset [read\-write]" 4 |
1521 | .IX Item "ev_tstamp offset [read-write]" |
1560 | .IX Item "ev_tstamp offset [read-write]" |
1522 | When repeating, this contains the offset value, otherwise this is the |
1561 | When repeating, this contains the offset value, otherwise this is the |
1523 | absolute point in time (the \f(CW\*(C`at\*(C'\fR value passed to \f(CW\*(C`ev_periodic_set\*(C'\fR). |
1562 | absolute point in time (the \f(CW\*(C`at\*(C'\fR value passed to \f(CW\*(C`ev_periodic_set\*(C'\fR). |
1524 | .Sp |
1563 | .Sp |
… | |
… | |
1532 | .IP "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read\-write]" 4 |
1571 | .IP "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read\-write]" 4 |
1533 | .IX Item "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]" |
1572 | .IX Item "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]" |
1534 | The current reschedule callback, or \f(CW0\fR, if this functionality is |
1573 | The current reschedule callback, or \f(CW0\fR, if this functionality is |
1535 | switched off. Can be changed any time, but changes only take effect when |
1574 | switched off. Can be changed any time, but changes only take effect when |
1536 | the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. |
1575 | the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. |
1537 | .IP "ev_tstamp at [read\-only]" 4 |
|
|
1538 | .IX Item "ev_tstamp at [read-only]" |
|
|
1539 | When active, contains the absolute time that the watcher is supposed to |
|
|
1540 | trigger next. |
|
|
1541 | .PP |
1576 | .PP |
1542 | \fIExamples\fR |
1577 | \fIExamples\fR |
1543 | .IX Subsection "Examples" |
1578 | .IX Subsection "Examples" |
1544 | .PP |
1579 | .PP |
1545 | Example: Call a callback every hour, or, more precisely, whenever the |
1580 | Example: Call a callback every hour, or, more precisely, whenever the |
… | |
… | |
1751 | as even with OS-supported change notifications, this can be |
1786 | as even with OS-supported change notifications, this can be |
1752 | resource-intensive. |
1787 | resource-intensive. |
1753 | .PP |
1788 | .PP |
1754 | At the time of this writing, only the Linux inotify interface is |
1789 | At the time of this writing, only the Linux inotify interface is |
1755 | implemented (implementing kqueue support is left as an exercise for the |
1790 | implemented (implementing kqueue support is left as an exercise for the |
|
|
1791 | reader, note, however, that the author sees no way of implementing ev_stat |
1756 | reader). Inotify will be used to give hints only and should not change the |
1792 | semantics with kqueue). Inotify will be used to give hints only and should |
1757 | semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs |
1793 | not change the semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev |
1758 | to fall back to regular polling again even with inotify, but changes are |
1794 | sometimes needs to fall back to regular polling again even with inotify, |
1759 | usually detected immediately, and if the file exists there will be no |
1795 | but changes are usually detected immediately, and if the file exists there |
1760 | polling. |
1796 | will be no polling. |
1761 | .PP |
1797 | .PP |
1762 | \fI\s-1ABI\s0 Issues (Largefile Support)\fR |
1798 | \fI\s-1ABI\s0 Issues (Largefile Support)\fR |
1763 | .IX Subsection "ABI Issues (Largefile Support)" |
1799 | .IX Subsection "ABI Issues (Largefile Support)" |
1764 | .PP |
1800 | .PP |
1765 | Libev by default (unless the user overrides this) uses the default |
1801 | Libev by default (unless the user overrides this) uses the default |
… | |
… | |
1777 | When \f(CW\*(C`inotify (7)\*(C'\fR support has been compiled into libev (generally only |
1813 | When \f(CW\*(C`inotify (7)\*(C'\fR support has been compiled into libev (generally only |
1778 | available on Linux) and present at runtime, it will be used to speed up |
1814 | available on Linux) and present at runtime, it will be used to speed up |
1779 | change detection where possible. The inotify descriptor will be created lazily |
1815 | change detection where possible. The inotify descriptor will be created lazily |
1780 | when the first \f(CW\*(C`ev_stat\*(C'\fR watcher is being started. |
1816 | when the first \f(CW\*(C`ev_stat\*(C'\fR watcher is being started. |
1781 | .PP |
1817 | .PP |
1782 | Inotify presense does not change the semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers |
1818 | Inotify presence does not change the semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers |
1783 | except that changes might be detected earlier, and in some cases, to avoid |
1819 | except that changes might be detected earlier, and in some cases, to avoid |
1784 | making regular \f(CW\*(C`stat\*(C'\fR calls. Even in the presense of inotify support |
1820 | making regular \f(CW\*(C`stat\*(C'\fR calls. Even in the presence of inotify support |
1785 | there are many cases where libev has to resort to regular \f(CW\*(C`stat\*(C'\fR polling. |
1821 | there are many cases where libev has to resort to regular \f(CW\*(C`stat\*(C'\fR polling. |
1786 | .PP |
1822 | .PP |
1787 | (There is no support for kqueue, as apparently it cannot be used to |
1823 | (There is no support for kqueue, as apparently it cannot be used to |
1788 | implement this functionality, due to the requirement of having a file |
1824 | implement this functionality, due to the requirement of having a file |
1789 | descriptor open on the object at all times). |
1825 | descriptor open on the object at all times). |
… | |
… | |
1793 | .PP |
1829 | .PP |
1794 | The \f(CW\*(C`stat ()\*(C'\fR syscall only supports full-second resolution portably, and |
1830 | The \f(CW\*(C`stat ()\*(C'\fR syscall only supports full-second resolution portably, and |
1795 | even on systems where the resolution is higher, many filesystems still |
1831 | even on systems where the resolution is higher, many filesystems still |
1796 | only support whole seconds. |
1832 | only support whole seconds. |
1797 | .PP |
1833 | .PP |
1798 | That means that, if the time is the only thing that changes, you might |
1834 | That means that, if the time is the only thing that changes, you can |
1799 | miss updates: on the first update, \f(CW\*(C`ev_stat\*(C'\fR detects a change and calls |
1835 | easily miss updates: on the first update, \f(CW\*(C`ev_stat\*(C'\fR detects a change and |
1800 | your callback, which does something. When there is another update within |
1836 | calls your callback, which does something. When there is another update |
1801 | the same second, \f(CW\*(C`ev_stat\*(C'\fR will be unable to detect it. |
1837 | within the same second, \f(CW\*(C`ev_stat\*(C'\fR will be unable to detect it as the stat |
|
|
1838 | data does not change. |
1802 | .PP |
1839 | .PP |
1803 | The solution to this is to delay acting on a change for a second (or till |
1840 | The solution to this is to delay acting on a change for slightly more |
1804 | the next second boundary), using a roughly one-second delay \f(CW\*(C`ev_timer\*(C'\fR |
1841 | than a second (or till slightly after the next full second boundary), using |
1805 | (\f(CW\*(C`ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)\*(C'\fR). The \f(CW.01\fR |
1842 | a roughly one-second-delay \f(CW\*(C`ev_timer\*(C'\fR (e.g. \f(CW\*(C`ev_timer_set (w, 0., 1.02); |
1806 | is added to work around small timing inconsistencies of some operating |
1843 | ev_timer_again (loop, w)\*(C'\fR). |
1807 | systems. |
1844 | .PP |
|
|
1845 | The \f(CW.02\fR offset is added to work around small timing inconsistencies |
|
|
1846 | of some operating systems (where the second counter of the current time |
|
|
1847 | might be be delayed. One such system is the Linux kernel, where a call to |
|
|
1848 | \&\f(CW\*(C`gettimeofday\*(C'\fR might return a timestamp with a full second later than |
|
|
1849 | a subsequent \f(CW\*(C`time\*(C'\fR call \- if the equivalent of \f(CW\*(C`time ()\*(C'\fR is used to |
|
|
1850 | update file times then there will be a small window where the kernel uses |
|
|
1851 | the previous second to update file times but libev might already execute |
|
|
1852 | the timer callback). |
1808 | .PP |
1853 | .PP |
1809 | \fIWatcher-Specific Functions and Data Members\fR |
1854 | \fIWatcher-Specific Functions and Data Members\fR |
1810 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1855 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1811 | .IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 |
1856 | .IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 |
1812 | .IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" |
1857 | .IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" |
… | |
… | |
1818 | \&\f(CW\*(C`path\*(C'\fR. The \f(CW\*(C`interval\*(C'\fR is a hint on how quickly a change is expected to |
1863 | \&\f(CW\*(C`path\*(C'\fR. The \f(CW\*(C`interval\*(C'\fR is a hint on how quickly a change is expected to |
1819 | be detected and should normally be specified as \f(CW0\fR to let libev choose |
1864 | be detected and should normally be specified as \f(CW0\fR to let libev choose |
1820 | a suitable value. The memory pointed to by \f(CW\*(C`path\*(C'\fR must point to the same |
1865 | a suitable value. The memory pointed to by \f(CW\*(C`path\*(C'\fR must point to the same |
1821 | path for as long as the watcher is active. |
1866 | path for as long as the watcher is active. |
1822 | .Sp |
1867 | .Sp |
1823 | The callback will be receive \f(CW\*(C`EV_STAT\*(C'\fR when a change was detected, |
1868 | The callback will receive \f(CW\*(C`EV_STAT\*(C'\fR when a change was detected, relative |
1824 | relative to the attributes at the time the watcher was started (or the |
1869 | to the attributes at the time the watcher was started (or the last change |
1825 | last change was detected). |
1870 | was detected). |
1826 | .IP "ev_stat_stat (loop, ev_stat *)" 4 |
1871 | .IP "ev_stat_stat (loop, ev_stat *)" 4 |
1827 | .IX Item "ev_stat_stat (loop, ev_stat *)" |
1872 | .IX Item "ev_stat_stat (loop, ev_stat *)" |
1828 | Updates the stat buffer immediately with new values. If you change the |
1873 | Updates the stat buffer immediately with new values. If you change the |
1829 | watched path in your callback, you could call this fucntion to avoid |
1874 | watched path in your callback, you could call this function to avoid |
1830 | detecting this change (while introducing a race condition). Can also be |
1875 | detecting this change (while introducing a race condition if you are not |
1831 | useful simply to find out the new values. |
1876 | the only one changing the path). Can also be useful simply to find out the |
|
|
1877 | new values. |
1832 | .IP "ev_statdata attr [read\-only]" 4 |
1878 | .IP "ev_statdata attr [read\-only]" 4 |
1833 | .IX Item "ev_statdata attr [read-only]" |
1879 | .IX Item "ev_statdata attr [read-only]" |
1834 | The most-recently detected attributes of the file. Although the type is of |
1880 | The most-recently detected attributes of the file. Although the type is |
1835 | \&\f(CW\*(C`ev_statdata\*(C'\fR, this is usually the (or one of the) \f(CW\*(C`struct stat\*(C'\fR types |
1881 | \&\f(CW\*(C`ev_statdata\*(C'\fR, this is usually the (or one of the) \f(CW\*(C`struct stat\*(C'\fR types |
|
|
1882 | suitable for your system, but you can only rely on the POSIX-standardised |
1836 | suitable for your system. If the \f(CW\*(C`st_nlink\*(C'\fR member is \f(CW0\fR, then there |
1883 | members to be present. If the \f(CW\*(C`st_nlink\*(C'\fR member is \f(CW0\fR, then there was |
1837 | was some error while \f(CW\*(C`stat\*(C'\fRing the file. |
1884 | some error while \f(CW\*(C`stat\*(C'\fRing the file. |
1838 | .IP "ev_statdata prev [read\-only]" 4 |
1885 | .IP "ev_statdata prev [read\-only]" 4 |
1839 | .IX Item "ev_statdata prev [read-only]" |
1886 | .IX Item "ev_statdata prev [read-only]" |
1840 | The previous attributes of the file. The callback gets invoked whenever |
1887 | The previous attributes of the file. The callback gets invoked whenever |
1841 | \&\f(CW\*(C`prev\*(C'\fR != \f(CW\*(C`attr\*(C'\fR. |
1888 | \&\f(CW\*(C`prev\*(C'\fR != \f(CW\*(C`attr\*(C'\fR, or, more precisely, one or more of these members |
|
|
1889 | differ: \f(CW\*(C`st_dev\*(C'\fR, \f(CW\*(C`st_ino\*(C'\fR, \f(CW\*(C`st_mode\*(C'\fR, \f(CW\*(C`st_nlink\*(C'\fR, \f(CW\*(C`st_uid\*(C'\fR, |
|
|
1890 | \&\f(CW\*(C`st_gid\*(C'\fR, \f(CW\*(C`st_rdev\*(C'\fR, \f(CW\*(C`st_size\*(C'\fR, \f(CW\*(C`st_atime\*(C'\fR, \f(CW\*(C`st_mtime\*(C'\fR, \f(CW\*(C`st_ctime\*(C'\fR. |
1842 | .IP "ev_tstamp interval [read\-only]" 4 |
1891 | .IP "ev_tstamp interval [read\-only]" 4 |
1843 | .IX Item "ev_tstamp interval [read-only]" |
1892 | .IX Item "ev_tstamp interval [read-only]" |
1844 | The specified interval. |
1893 | The specified interval. |
1845 | .IP "const char *path [read\-only]" 4 |
1894 | .IP "const char *path [read\-only]" 4 |
1846 | .IX Item "const char *path [read-only]" |
1895 | .IX Item "const char *path [read-only]" |
… | |
… | |
1900 | \& } |
1949 | \& } |
1901 | \& |
1950 | \& |
1902 | \& ... |
1951 | \& ... |
1903 | \& ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.); |
1952 | \& ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.); |
1904 | \& ev_stat_start (loop, &passwd); |
1953 | \& ev_stat_start (loop, &passwd); |
1905 | \& ev_timer_init (&timer, timer_cb, 0., 1.01); |
1954 | \& ev_timer_init (&timer, timer_cb, 0., 1.02); |
1906 | .Ve |
1955 | .Ve |
1907 | .ie n .Sh """ev_idle"" \- when you've got nothing better to do..." |
1956 | .ie n .Sh """ev_idle"" \- when you've got nothing better to do..." |
1908 | .el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." |
1957 | .el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." |
1909 | .IX Subsection "ev_idle - when you've got nothing better to do..." |
1958 | .IX Subsection "ev_idle - when you've got nothing better to do..." |
1910 | Idle watchers trigger events when no other events of the same or higher |
1959 | Idle watchers trigger events when no other events of the same or higher |
… | |
… | |
1996 | .PP |
2045 | .PP |
1997 | It is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) |
2046 | It is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) |
1998 | priority, to ensure that they are being run before any other watchers |
2047 | priority, to ensure that they are being run before any other watchers |
1999 | after the poll. Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, |
2048 | after the poll. Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, |
2000 | too) should not activate (\*(L"feed\*(R") events into libev. While libev fully |
2049 | too) should not activate (\*(L"feed\*(R") events into libev. While libev fully |
2001 | supports this, they will be called before other \f(CW\*(C`ev_check\*(C'\fR watchers |
2050 | supports this, they might get executed before other \f(CW\*(C`ev_check\*(C'\fR watchers |
2002 | did their job. As \f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other |
2051 | did their job. As \f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other |
2003 | (non-libev) event loops those other event loops might be in an unusable |
2052 | (non-libev) event loops those other event loops might be in an unusable |
2004 | state until their \f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to |
2053 | state until their \f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to |
2005 | coexist peacefully with others). |
2054 | coexist peacefully with others). |
2006 | .PP |
2055 | .PP |
… | |
… | |
2020 | .IX Subsection "Examples" |
2069 | .IX Subsection "Examples" |
2021 | .PP |
2070 | .PP |
2022 | There are a number of principal ways to embed other event loops or modules |
2071 | There are a number of principal ways to embed other event loops or modules |
2023 | into libev. Here are some ideas on how to include libadns into libev |
2072 | into libev. Here are some ideas on how to include libadns into libev |
2024 | (there is a Perl module named \f(CW\*(C`EV::ADNS\*(C'\fR that does this, which you could |
2073 | (there is a Perl module named \f(CW\*(C`EV::ADNS\*(C'\fR that does this, which you could |
2025 | use for an actually working example. Another Perl module named \f(CW\*(C`EV::Glib\*(C'\fR |
2074 | use as a working example. Another Perl module named \f(CW\*(C`EV::Glib\*(C'\fR embeds a |
2026 | embeds a Glib main context into libev, and finally, \f(CW\*(C`Glib::EV\*(C'\fR embeds \s-1EV\s0 |
2075 | Glib main context into libev, and finally, \f(CW\*(C`Glib::EV\*(C'\fR embeds \s-1EV\s0 into the |
2027 | into the Glib event loop). |
2076 | Glib event loop). |
2028 | .PP |
2077 | .PP |
2029 | Method 1: Add \s-1IO\s0 watchers and a timeout watcher in a prepare handler, |
2078 | Method 1: Add \s-1IO\s0 watchers and a timeout watcher in a prepare handler, |
2030 | and in a check watcher, destroy them and call into libadns. What follows |
2079 | and in a check watcher, destroy them and call into libadns. What follows |
2031 | is pseudo-code only of course. This requires you to either use a low |
2080 | is pseudo-code only of course. This requires you to either use a low |
2032 | priority for the check watcher or use \f(CW\*(C`ev_clear_pending\*(C'\fR explicitly, as |
2081 | priority for the check watcher or use \f(CW\*(C`ev_clear_pending\*(C'\fR explicitly, as |
… | |
… | |
2495 | it a private \s-1API\s0). |
2544 | it a private \s-1API\s0). |
2496 | .IP "\(bu" 4 |
2545 | .IP "\(bu" 4 |
2497 | Priorities are not currently supported. Initialising priorities |
2546 | Priorities are not currently supported. Initialising priorities |
2498 | will fail and all watchers will have the same priority, even though there |
2547 | will fail and all watchers will have the same priority, even though there |
2499 | is an ev_pri field. |
2548 | is an ev_pri field. |
|
|
2549 | .IP "\(bu" 4 |
|
|
2550 | In libevent, the last base created gets the signals, in libev, the |
|
|
2551 | first base created (== the default loop) gets the signals. |
2500 | .IP "\(bu" 4 |
2552 | .IP "\(bu" 4 |
2501 | Other members are not supported. |
2553 | Other members are not supported. |
2502 | .IP "\(bu" 4 |
2554 | .IP "\(bu" 4 |
2503 | The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need |
2555 | The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need |
2504 | to use the libev header file and library. |
2556 | to use the libev header file and library. |
… | |
… | |
2733 | .ie n .IP """EV_DEFAULT""\fR, \f(CW""EV_DEFAULT_""" 4 |
2785 | .ie n .IP """EV_DEFAULT""\fR, \f(CW""EV_DEFAULT_""" 4 |
2734 | .el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 |
2786 | .el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 |
2735 | .IX Item "EV_DEFAULT, EV_DEFAULT_" |
2787 | .IX Item "EV_DEFAULT, EV_DEFAULT_" |
2736 | Similar to the other two macros, this gives you the value of the default |
2788 | Similar to the other two macros, this gives you the value of the default |
2737 | loop, if multiple loops are supported (\*(L"ev loop default\*(R"). |
2789 | loop, if multiple loops are supported (\*(L"ev loop default\*(R"). |
|
|
2790 | .ie n .IP """EV_DEFAULT_UC""\fR, \f(CW""EV_DEFAULT_UC_""" 4 |
|
|
2791 | .el .IP "\f(CWEV_DEFAULT_UC\fR, \f(CWEV_DEFAULT_UC_\fR" 4 |
|
|
2792 | .IX Item "EV_DEFAULT_UC, EV_DEFAULT_UC_" |
|
|
2793 | Usage identical to \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR, but requires that the |
|
|
2794 | default loop has been initialised (\f(CW\*(C`UC\*(C'\fR == unchecked). Their behaviour |
|
|
2795 | is undefined when the default loop has not been initialised by a previous |
|
|
2796 | execution of \f(CW\*(C`EV_DEFAULT\*(C'\fR, \f(CW\*(C`EV_DEFAULT_\*(C'\fR or \f(CW\*(C`ev_default_init (...)\*(C'\fR. |
|
|
2797 | .Sp |
|
|
2798 | It is often prudent to use \f(CW\*(C`EV_DEFAULT\*(C'\fR when initialising the first |
|
|
2799 | watcher in a function but use \f(CW\*(C`EV_DEFAULT_UC\*(C'\fR afterwards. |
2738 | .PP |
2800 | .PP |
2739 | Example: Declare and initialise a check watcher, utilising the above |
2801 | Example: Declare and initialise a check watcher, utilising the above |
2740 | macros so it will work regardless of whether multiple loops are supported |
2802 | macros so it will work regardless of whether multiple loops are supported |
2741 | or not. |
2803 | or not. |
2742 | .PP |
2804 | .PP |
… | |
… | |
2852 | .Vb 1 |
2914 | .Vb 1 |
2853 | \& libev.m4 |
2915 | \& libev.m4 |
2854 | .Ve |
2916 | .Ve |
2855 | .Sh "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" |
2917 | .Sh "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" |
2856 | .IX Subsection "PREPROCESSOR SYMBOLS/MACROS" |
2918 | .IX Subsection "PREPROCESSOR SYMBOLS/MACROS" |
2857 | Libev can be configured via a variety of preprocessor symbols you have to define |
2919 | Libev can be configured via a variety of preprocessor symbols you have to |
2858 | before including any of its files. The default is not to build for multiplicity |
2920 | define before including any of its files. The default in the absense of |
2859 | and only include the select backend. |
2921 | autoconf is noted for every option. |
2860 | .IP "\s-1EV_STANDALONE\s0" 4 |
2922 | .IP "\s-1EV_STANDALONE\s0" 4 |
2861 | .IX Item "EV_STANDALONE" |
2923 | .IX Item "EV_STANDALONE" |
2862 | Must always be \f(CW1\fR if you do not use autoconf configuration, which |
2924 | Must always be \f(CW1\fR if you do not use autoconf configuration, which |
2863 | keeps libev from including \fIconfig.h\fR, and it also defines dummy |
2925 | keeps libev from including \fIconfig.h\fR, and it also defines dummy |
2864 | implementations for some libevent functions (such as logging, which is not |
2926 | implementations for some libevent functions (such as logging, which is not |
… | |
… | |
2883 | note about libraries in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. |
2945 | note about libraries in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. |
2884 | .IP "\s-1EV_USE_NANOSLEEP\s0" 4 |
2946 | .IP "\s-1EV_USE_NANOSLEEP\s0" 4 |
2885 | .IX Item "EV_USE_NANOSLEEP" |
2947 | .IX Item "EV_USE_NANOSLEEP" |
2886 | If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available |
2948 | If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available |
2887 | and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR. |
2949 | and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR. |
|
|
2950 | .IP "\s-1EV_USE_EVENTFD\s0" 4 |
|
|
2951 | .IX Item "EV_USE_EVENTFD" |
|
|
2952 | If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is |
|
|
2953 | available and will probe for kernel support at runtime. This will improve |
|
|
2954 | \&\f(CW\*(C`ev_signal\*(C'\fR and \f(CW\*(C`ev_async\*(C'\fR performance and reduce resource consumption. |
|
|
2955 | If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc |
|
|
2956 | 2.7 or newer, otherwise disabled. |
2888 | .IP "\s-1EV_USE_SELECT\s0" 4 |
2957 | .IP "\s-1EV_USE_SELECT\s0" 4 |
2889 | .IX Item "EV_USE_SELECT" |
2958 | .IX Item "EV_USE_SELECT" |
2890 | If undefined or defined to be \f(CW1\fR, libev will compile in support for the |
2959 | If undefined or defined to be \f(CW1\fR, libev will compile in support for the |
2891 | \&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at autodetection will be done: if no |
2960 | \&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at autodetection will be done: if no |
2892 | other method takes over, select will be it. Otherwise the select backend |
2961 | other method takes over, select will be it. Otherwise the select backend |
… | |
… | |
2923 | takes precedence over select. |
2992 | takes precedence over select. |
2924 | .IP "\s-1EV_USE_EPOLL\s0" 4 |
2993 | .IP "\s-1EV_USE_EPOLL\s0" 4 |
2925 | .IX Item "EV_USE_EPOLL" |
2994 | .IX Item "EV_USE_EPOLL" |
2926 | If defined to be \f(CW1\fR, libev will compile in support for the Linux |
2995 | If defined to be \f(CW1\fR, libev will compile in support for the Linux |
2927 | \&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime, |
2996 | \&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime, |
2928 | otherwise another method will be used as fallback. This is the |
2997 | otherwise another method will be used as fallback. This is the preferred |
2929 | preferred backend for GNU/Linux systems. |
2998 | backend for GNU/Linux systems. If undefined, it will be enabled if the |
|
|
2999 | headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
2930 | .IP "\s-1EV_USE_KQUEUE\s0" 4 |
3000 | .IP "\s-1EV_USE_KQUEUE\s0" 4 |
2931 | .IX Item "EV_USE_KQUEUE" |
3001 | .IX Item "EV_USE_KQUEUE" |
2932 | If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style |
3002 | If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style |
2933 | \&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime, |
3003 | \&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime, |
2934 | otherwise another method will be used as fallback. This is the preferred |
3004 | otherwise another method will be used as fallback. This is the preferred |
… | |
… | |
2949 | reserved for future expansion, works like the \s-1USE\s0 symbols above. |
3019 | reserved for future expansion, works like the \s-1USE\s0 symbols above. |
2950 | .IP "\s-1EV_USE_INOTIFY\s0" 4 |
3020 | .IP "\s-1EV_USE_INOTIFY\s0" 4 |
2951 | .IX Item "EV_USE_INOTIFY" |
3021 | .IX Item "EV_USE_INOTIFY" |
2952 | If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify |
3022 | If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify |
2953 | interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will |
3023 | interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will |
2954 | be detected at runtime. |
3024 | be detected at runtime. If undefined, it will be enabled if the headers |
|
|
3025 | indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
2955 | .IP "\s-1EV_ATOMIC_T\s0" 4 |
3026 | .IP "\s-1EV_ATOMIC_T\s0" 4 |
2956 | .IX Item "EV_ATOMIC_T" |
3027 | .IX Item "EV_ATOMIC_T" |
2957 | Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose |
3028 | Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose |
2958 | access is atomic with respect to other threads or signal contexts. No such |
3029 | access is atomic with respect to other threads or signal contexts. No such |
2959 | type is easily found in the C language, so you can provide your own type |
3030 | type is easily found in the C language, so you can provide your own type |
… | |
… | |
3034 | If undefined or defined to be \f(CW1\fR, then async watchers are supported. If |
3105 | If undefined or defined to be \f(CW1\fR, then async watchers are supported. If |
3035 | defined to be \f(CW0\fR, then they are not. |
3106 | defined to be \f(CW0\fR, then they are not. |
3036 | .IP "\s-1EV_MINIMAL\s0" 4 |
3107 | .IP "\s-1EV_MINIMAL\s0" 4 |
3037 | .IX Item "EV_MINIMAL" |
3108 | .IX Item "EV_MINIMAL" |
3038 | If you need to shave off some kilobytes of code at the expense of some |
3109 | If you need to shave off some kilobytes of code at the expense of some |
3039 | speed, define this symbol to \f(CW1\fR. Currently only used for gcc to override |
3110 | speed, define this symbol to \f(CW1\fR. Currently this is used to override some |
3040 | some inlining decisions, saves roughly 30% codesize of amd64. |
3111 | inlining decisions, saves roughly 30% codesize of amd64. It also selects a |
|
|
3112 | much smaller 2\-heap for timer management over the default 4\-heap. |
3041 | .IP "\s-1EV_PID_HASHSIZE\s0" 4 |
3113 | .IP "\s-1EV_PID_HASHSIZE\s0" 4 |
3042 | .IX Item "EV_PID_HASHSIZE" |
3114 | .IX Item "EV_PID_HASHSIZE" |
3043 | \&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by |
3115 | \&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by |
3044 | pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more |
3116 | pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more |
3045 | than enough. If you need to manage thousands of children you might want to |
3117 | than enough. If you need to manage thousands of children you might want to |
… | |
… | |
3049 | \&\f(CW\*(C`ev_stat\*(C'\fR watchers use a small hash table to distribute workload by |
3121 | \&\f(CW\*(C`ev_stat\*(C'\fR watchers use a small hash table to distribute workload by |
3050 | inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), |
3122 | inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), |
3051 | usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR |
3123 | usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR |
3052 | watchers you might want to increase this value (\fImust\fR be a power of |
3124 | watchers you might want to increase this value (\fImust\fR be a power of |
3053 | two). |
3125 | two). |
|
|
3126 | .IP "\s-1EV_USE_4HEAP\s0" 4 |
|
|
3127 | .IX Item "EV_USE_4HEAP" |
|
|
3128 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
|
|
3129 | timer and periodics heap, libev uses a 4\-heap when this symbol is defined |
|
|
3130 | to \f(CW1\fR. The 4\-heap uses more complicated (longer) code but has |
|
|
3131 | noticably faster performance with many (thousands) of watchers. |
|
|
3132 | .Sp |
|
|
3133 | The default is \f(CW1\fR unless \f(CW\*(C`EV_MINIMAL\*(C'\fR is set in which case it is \f(CW0\fR |
|
|
3134 | (disabled). |
|
|
3135 | .IP "\s-1EV_HEAP_CACHE_AT\s0" 4 |
|
|
3136 | .IX Item "EV_HEAP_CACHE_AT" |
|
|
3137 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
|
|
3138 | timer and periodics heap, libev can cache the timestamp (\fIat\fR) within |
|
|
3139 | the heap structure (selected by defining \f(CW\*(C`EV_HEAP_CACHE_AT\*(C'\fR to \f(CW1\fR), |
|
|
3140 | which uses 8\-12 bytes more per watcher and a few hundred bytes more code, |
|
|
3141 | but avoids random read accesses on heap changes. This improves performance |
|
|
3142 | noticably with with many (hundreds) of watchers. |
|
|
3143 | .Sp |
|
|
3144 | The default is \f(CW1\fR unless \f(CW\*(C`EV_MINIMAL\*(C'\fR is set in which case it is \f(CW0\fR |
|
|
3145 | (disabled). |
|
|
3146 | .IP "\s-1EV_VERIFY\s0" 4 |
|
|
3147 | .IX Item "EV_VERIFY" |
|
|
3148 | Controls how much internal verification (see \f(CW\*(C`ev_loop_verify ()\*(C'\fR) will |
|
|
3149 | be done: If set to \f(CW0\fR, no internal verification code will be compiled |
|
|
3150 | in. If set to \f(CW1\fR, then verification code will be compiled in, but not |
|
|
3151 | called. If set to \f(CW2\fR, then the internal verification code will be |
|
|
3152 | called once per loop, which can slow down libev. If set to \f(CW3\fR, then the |
|
|
3153 | verification code will be called very frequently, which will slow down |
|
|
3154 | libev considerably. |
|
|
3155 | .Sp |
|
|
3156 | The default is \f(CW1\fR, unless \f(CW\*(C`EV_MINIMAL\*(C'\fR is set, in which case it will be |
|
|
3157 | \&\f(CW0.\fR |
3054 | .IP "\s-1EV_COMMON\s0" 4 |
3158 | .IP "\s-1EV_COMMON\s0" 4 |
3055 | .IX Item "EV_COMMON" |
3159 | .IX Item "EV_COMMON" |
3056 | By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining |
3160 | By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining |
3057 | this macro to a something else you can include more and other types of |
3161 | this macro to a something else you can include more and other types of |
3058 | members. You have to define it each time you include one of the files, |
3162 | members. You have to define it each time you include one of the files, |
… | |
… | |
3140 | .PP |
3244 | .PP |
3141 | .Vb 2 |
3245 | .Vb 2 |
3142 | \& #include "ev_cpp.h" |
3246 | \& #include "ev_cpp.h" |
3143 | \& #include "ev.c" |
3247 | \& #include "ev.c" |
3144 | .Ve |
3248 | .Ve |
|
|
3249 | .SH "THREADS AND COROUTINES" |
|
|
3250 | .IX Header "THREADS AND COROUTINES" |
|
|
3251 | .Sh "\s-1THREADS\s0" |
|
|
3252 | .IX Subsection "THREADS" |
|
|
3253 | Libev itself is completely threadsafe, but it uses no locking. This |
|
|
3254 | means that you can use as many loops as you want in parallel, as long as |
|
|
3255 | only one thread ever calls into one libev function with the same loop |
|
|
3256 | parameter. |
|
|
3257 | .PP |
|
|
3258 | Or put differently: calls with different loop parameters can be done in |
|
|
3259 | parallel from multiple threads, calls with the same loop parameter must be |
|
|
3260 | done serially (but can be done from different threads, as long as only one |
|
|
3261 | thread ever is inside a call at any point in time, e.g. by using a mutex |
|
|
3262 | per loop). |
|
|
3263 | .PP |
|
|
3264 | If you want to know which design is best for your problem, then I cannot |
|
|
3265 | help you but by giving some generic advice: |
|
|
3266 | .IP "\(bu" 4 |
|
|
3267 | most applications have a main thread: use the default libev loop |
|
|
3268 | in that thread, or create a seperate thread running only the default loop. |
|
|
3269 | .Sp |
|
|
3270 | This helps integrating other libraries or software modules that use libev |
|
|
3271 | themselves and don't care/know about threading. |
|
|
3272 | .IP "\(bu" 4 |
|
|
3273 | one loop per thread is usually a good model. |
|
|
3274 | .Sp |
|
|
3275 | Doing this is almost never wrong, sometimes a better-performance model |
|
|
3276 | exists, but it is always a good start. |
|
|
3277 | .IP "\(bu" 4 |
|
|
3278 | other models exist, such as the leader/follower pattern, where one |
|
|
3279 | loop is handed through multiple threads in a kind of round-robbin fashion. |
|
|
3280 | .Sp |
|
|
3281 | Chosing a model is hard \- look around, learn, know that usually you cna do |
|
|
3282 | better than you currently do :\-) |
|
|
3283 | .IP "\(bu" 4 |
|
|
3284 | often you need to talk to some other thread which blocks in the |
|
|
3285 | event loop \- \f(CW\*(C`ev_async\*(C'\fR watchers can be used to wake them up from other |
|
|
3286 | threads safely (or from signal contexts...). |
|
|
3287 | .Sh "\s-1COROUTINES\s0" |
|
|
3288 | .IX Subsection "COROUTINES" |
|
|
3289 | Libev is much more accomodating to coroutines (\*(L"cooperative threads\*(R"): |
|
|
3290 | libev fully supports nesting calls to it's functions from different |
|
|
3291 | coroutines (e.g. you can call \f(CW\*(C`ev_loop\*(C'\fR on the same loop from two |
|
|
3292 | different coroutines and switch freely between both coroutines running the |
|
|
3293 | loop, as long as you don't confuse yourself). The only exception is that |
|
|
3294 | you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks. |
|
|
3295 | .PP |
|
|
3296 | Care has been invested into making sure that libev does not keep local |
|
|
3297 | state inside \f(CW\*(C`ev_loop\*(C'\fR, and other calls do not usually allow coroutine |
|
|
3298 | switches. |
3145 | .SH "COMPLEXITIES" |
3299 | .SH "COMPLEXITIES" |
3146 | .IX Header "COMPLEXITIES" |
3300 | .IX Header "COMPLEXITIES" |
3147 | In this section the complexities of (many of) the algorithms used inside |
3301 | In this section the complexities of (many of) the algorithms used inside |
3148 | libev will be explained. For complexity discussions about backends see the |
3302 | libev will be explained. For complexity discussions about backends see the |
3149 | documentation for \f(CW\*(C`ev_default_init\*(C'\fR. |
3303 | documentation for \f(CW\*(C`ev_default_init\*(C'\fR. |
… | |
… | |
3174 | These watchers are stored in lists then need to be walked to find the |
3328 | These watchers are stored in lists then need to be walked to find the |
3175 | correct watcher to remove. The lists are usually short (you don't usually |
3329 | correct watcher to remove. The lists are usually short (you don't usually |
3176 | have many watchers waiting for the same fd or signal). |
3330 | have many watchers waiting for the same fd or signal). |
3177 | .IP "Finding the next timer in each loop iteration: O(1)" 4 |
3331 | .IP "Finding the next timer in each loop iteration: O(1)" 4 |
3178 | .IX Item "Finding the next timer in each loop iteration: O(1)" |
3332 | .IX Item "Finding the next timer in each loop iteration: O(1)" |
3179 | By virtue of using a binary heap, the next timer is always found at the |
3333 | By virtue of using a binary or 4\-heap, the next timer is always found at a |
3180 | beginning of the storage array. |
3334 | fixed position in the storage array. |
3181 | .IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 |
3335 | .IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 |
3182 | .IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" |
3336 | .IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" |
3183 | A change means an I/O watcher gets started or stopped, which requires |
3337 | A change means an I/O watcher gets started or stopped, which requires |
3184 | libev to recalculate its status (and possibly tell the kernel, depending |
3338 | libev to recalculate its status (and possibly tell the kernel, depending |
3185 | on backend and wether \f(CW\*(C`ev_io_set\*(C'\fR was used). |
3339 | on backend and wether \f(CW\*(C`ev_io_set\*(C'\fR was used). |
… | |
… | |
3211 | model. Libev still offers limited functionality on this platform in |
3365 | model. Libev still offers limited functionality on this platform in |
3212 | the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket |
3366 | the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket |
3213 | descriptors. This only applies when using Win32 natively, not when using |
3367 | descriptors. This only applies when using Win32 natively, not when using |
3214 | e.g. cygwin. |
3368 | e.g. cygwin. |
3215 | .PP |
3369 | .PP |
|
|
3370 | Lifting these limitations would basically require the full |
|
|
3371 | re-implementation of the I/O system. If you are into these kinds of |
|
|
3372 | things, then note that glib does exactly that for you in a very portable |
|
|
3373 | way (note also that glib is the slowest event library known to man). |
|
|
3374 | .PP |
3216 | There is no supported compilation method available on windows except |
3375 | There is no supported compilation method available on windows except |
3217 | embedding it into other applications. |
3376 | embedding it into other applications. |
3218 | .PP |
3377 | .PP |
3219 | Due to the many, low, and arbitrary limits on the win32 platform and the |
3378 | Due to the many, low, and arbitrary limits on the win32 platform and |
3220 | abysmal performance of winsockets, using a large number of sockets is not |
3379 | the abysmal performance of winsockets, using a large number of sockets |
3221 | recommended (and not reasonable). If your program needs to use more than |
3380 | is not recommended (and not reasonable). If your program needs to use |
3222 | a hundred or so sockets, then likely it needs to use a totally different |
3381 | more than a hundred or so sockets, then likely it needs to use a totally |
3223 | implementation for windows, as libev offers the \s-1POSIX\s0 model, which cannot |
3382 | different implementation for windows, as libev offers the \s-1POSIX\s0 readiness |
3224 | be implemented efficiently on windows (microsoft monopoly games). |
3383 | notification model, which cannot be implemented efficiently on windows |
|
|
3384 | (microsoft monopoly games). |
3225 | .IP "The winsocket select function" 4 |
3385 | .IP "The winsocket select function" 4 |
3226 | .IX Item "The winsocket select function" |
3386 | .IX Item "The winsocket select function" |
3227 | The winsocket \f(CW\*(C`select\*(C'\fR function doesn't follow \s-1POSIX\s0 in that it requires |
3387 | The winsocket \f(CW\*(C`select\*(C'\fR function doesn't follow \s-1POSIX\s0 in that it |
3228 | socket \fIhandles\fR and not socket \fIfile descriptors\fR. This makes select |
3388 | requires socket \fIhandles\fR and not socket \fIfile descriptors\fR (it is |
3229 | very inefficient, and also requires a mapping from file descriptors |
3389 | also extremely buggy). This makes select very inefficient, and also |
3230 | to socket handles. See the discussion of the \f(CW\*(C`EV_SELECT_USE_FD_SET\*(C'\fR, |
3390 | requires a mapping from file descriptors to socket handles. See the |
3231 | \&\f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR and \f(CW\*(C`EV_FD_TO_WIN32_HANDLE\*(C'\fR preprocessor |
3391 | discussion of the \f(CW\*(C`EV_SELECT_USE_FD_SET\*(C'\fR, \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR and |
3232 | symbols for more info. |
3392 | \&\f(CW\*(C`EV_FD_TO_WIN32_HANDLE\*(C'\fR preprocessor symbols for more info. |
3233 | .Sp |
3393 | .Sp |
3234 | The configuration for a \*(L"naked\*(R" win32 using the microsoft runtime |
3394 | The configuration for a \*(L"naked\*(R" win32 using the microsoft runtime |
3235 | libraries and raw winsocket select is: |
3395 | libraries and raw winsocket select is: |
3236 | .Sp |
3396 | .Sp |
3237 | .Vb 2 |
3397 | .Vb 2 |
… | |
… | |
3241 | .Sp |
3401 | .Sp |
3242 | Note that winsockets handling of fd sets is O(n), so you can easily get a |
3402 | Note that winsockets handling of fd sets is O(n), so you can easily get a |
3243 | complexity in the O(nA\*^X) range when using win32. |
3403 | complexity in the O(nA\*^X) range when using win32. |
3244 | .IP "Limited number of file descriptors" 4 |
3404 | .IP "Limited number of file descriptors" 4 |
3245 | .IX Item "Limited number of file descriptors" |
3405 | .IX Item "Limited number of file descriptors" |
3246 | Windows has numerous arbitrary (and low) limits on things. Early versions |
3406 | Windows has numerous arbitrary (and low) limits on things. |
3247 | of winsocket's select only supported waiting for a max. of \f(CW64\fR handles |
3407 | .Sp |
3248 | (probably owning to the fact that all windows kernels can only wait for |
3408 | Early versions of winsocket's select only supported waiting for a maximum |
3249 | \&\f(CW64\fR things at the same time internally; microsoft recommends spawning a |
3409 | of \f(CW64\fR handles (probably owning to the fact that all windows kernels |
3250 | chain of threads and wait for 63 handles and the previous thread in each). |
3410 | can only wait for \f(CW64\fR things at the same time internally; microsoft |
|
|
3411 | recommends spawning a chain of threads and wait for 63 handles and the |
|
|
3412 | previous thread in each. Great). |
3251 | .Sp |
3413 | .Sp |
3252 | Newer versions support more handles, but you need to define \f(CW\*(C`FD_SETSIZE\*(C'\fR |
3414 | Newer versions support more handles, but you need to define \f(CW\*(C`FD_SETSIZE\*(C'\fR |
3253 | to some high number (e.g. \f(CW2048\fR) before compiling the winsocket select |
3415 | to some high number (e.g. \f(CW2048\fR) before compiling the winsocket select |
3254 | call (which might be in libev or elsewhere, for example, perl does its own |
3416 | call (which might be in libev or elsewhere, for example, perl does its own |
3255 | select emulation on windows). |
3417 | select emulation on windows). |
… | |
… | |
3263 | .Sp |
3425 | .Sp |
3264 | This might get you to about \f(CW512\fR or \f(CW2048\fR sockets (depending on |
3426 | This might get you to about \f(CW512\fR or \f(CW2048\fR sockets (depending on |
3265 | windows version and/or the phase of the moon). To get more, you need to |
3427 | windows version and/or the phase of the moon). To get more, you need to |
3266 | wrap all I/O functions and provide your own fd management, but the cost of |
3428 | wrap all I/O functions and provide your own fd management, but the cost of |
3267 | calling select (O(nA\*^X)) will likely make this unworkable. |
3429 | calling select (O(nA\*^X)) will likely make this unworkable. |
|
|
3430 | .SH "PORTABILITY REQUIREMENTS" |
|
|
3431 | .IX Header "PORTABILITY REQUIREMENTS" |
|
|
3432 | In addition to a working ISO-C implementation, libev relies on a few |
|
|
3433 | additional extensions: |
|
|
3434 | .ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4 |
|
|
3435 | .el .IP "\f(CWsig_atomic_t volatile\fR must be thread-atomic as well" 4 |
|
|
3436 | .IX Item "sig_atomic_t volatile must be thread-atomic as well" |
|
|
3437 | The type \f(CW\*(C`sig_atomic_t volatile\*(C'\fR (or whatever is defined as |
|
|
3438 | \&\f(CW\*(C`EV_ATOMIC_T\*(C'\fR) must be atomic w.r.t. accesses from different |
|
|
3439 | threads. This is not part of the specification for \f(CW\*(C`sig_atomic_t\*(C'\fR, but is |
|
|
3440 | believed to be sufficiently portable. |
|
|
3441 | .ie n .IP """sigprocmask"" must work in a threaded environment" 4 |
|
|
3442 | .el .IP "\f(CWsigprocmask\fR must work in a threaded environment" 4 |
|
|
3443 | .IX Item "sigprocmask must work in a threaded environment" |
|
|
3444 | Libev uses \f(CW\*(C`sigprocmask\*(C'\fR to temporarily block signals. This is not |
|
|
3445 | allowed in a threaded program (\f(CW\*(C`pthread_sigmask\*(C'\fR has to be used). Typical |
|
|
3446 | pthread implementations will either allow \f(CW\*(C`sigprocmask\*(C'\fR in the \*(L"main |
|
|
3447 | thread\*(R" or will block signals process-wide, both behaviours would |
|
|
3448 | be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and |
|
|
3449 | \&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however. |
|
|
3450 | .Sp |
|
|
3451 | The most portable way to handle signals is to block signals in all threads |
|
|
3452 | except the initial one, and run the default loop in the initial thread as |
|
|
3453 | well. |
|
|
3454 | .ie n .IP """long"" must be large enough for common memory allocation sizes" 4 |
|
|
3455 | .el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4 |
|
|
3456 | .IX Item "long must be large enough for common memory allocation sizes" |
|
|
3457 | To improve portability and simplify using libev, libev uses \f(CW\*(C`long\*(C'\fR |
|
|
3458 | internally instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On |
|
|
3459 | non-POSIX systems (Microsoft...) this might be unexpectedly low, but |
|
|
3460 | is still at least 31 bits everywhere, which is enough for hundreds of |
|
|
3461 | millions of watchers. |
|
|
3462 | .ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4 |
|
|
3463 | .el .IP "\f(CWdouble\fR must hold a time value in seconds with enough accuracy" 4 |
|
|
3464 | .IX Item "double must hold a time value in seconds with enough accuracy" |
|
|
3465 | The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to |
|
|
3466 | have at least 51 bits of mantissa (and 9 bits of exponent), which is good |
|
|
3467 | enough for at least into the year 4000. This requirement is fulfilled by |
|
|
3468 | implementations implementing \s-1IEEE\s0 754 (basically all existing ones). |
|
|
3469 | .PP |
|
|
3470 | If you know of other additional requirements drop me a note. |
|
|
3471 | .SH "COMPILER WARNINGS" |
|
|
3472 | .IX Header "COMPILER WARNINGS" |
|
|
3473 | Depending on your compiler and compiler settings, you might get no or a |
|
|
3474 | lot of warnings when compiling libev code. Some people are apparently |
|
|
3475 | scared by this. |
|
|
3476 | .PP |
|
|
3477 | However, these are unavoidable for many reasons. For one, each compiler |
|
|
3478 | has different warnings, and each user has different tastes regarding |
|
|
3479 | warning options. \*(L"Warn-free\*(R" code therefore cannot be a goal except when |
|
|
3480 | targetting a specific compiler and compiler-version. |
|
|
3481 | .PP |
|
|
3482 | Another reason is that some compiler warnings require elaborate |
|
|
3483 | workarounds, or other changes to the code that make it less clear and less |
|
|
3484 | maintainable. |
|
|
3485 | .PP |
|
|
3486 | And of course, some compiler warnings are just plain stupid, or simply |
|
|
3487 | wrong (because they don't actually warn about the cindition their message |
|
|
3488 | seems to warn about). |
|
|
3489 | .PP |
|
|
3490 | While libev is written to generate as few warnings as possible, |
|
|
3491 | \&\*(L"warn-free\*(R" code is not a goal, and it is recommended not to build libev |
|
|
3492 | with any compiler warnings enabled unless you are prepared to cope with |
|
|
3493 | them (e.g. by ignoring them). Remember that warnings are just that: |
|
|
3494 | warnings, not errors, or proof of bugs. |
|
|
3495 | .SH "VALGRIND" |
|
|
3496 | .IX Header "VALGRIND" |
|
|
3497 | Valgrind has a special section here because it is a popular tool that is |
|
|
3498 | highly useful, but valgrind reports are very hard to interpret. |
|
|
3499 | .PP |
|
|
3500 | If you think you found a bug (memory leak, uninitialised data access etc.) |
|
|
3501 | in libev, then check twice: If valgrind reports something like: |
|
|
3502 | .PP |
|
|
3503 | .Vb 3 |
|
|
3504 | \& ==2274== definitely lost: 0 bytes in 0 blocks. |
|
|
3505 | \& ==2274== possibly lost: 0 bytes in 0 blocks. |
|
|
3506 | \& ==2274== still reachable: 256 bytes in 1 blocks. |
|
|
3507 | .Ve |
|
|
3508 | .PP |
|
|
3509 | then there is no memory leak. Similarly, under some circumstances, |
|
|
3510 | valgrind might report kernel bugs as if it were a bug in libev, or it |
|
|
3511 | might be confused (it is a very good tool, but only a tool). |
|
|
3512 | .PP |
|
|
3513 | If you are unsure about something, feel free to contact the mailing list |
|
|
3514 | with the full valgrind report and an explanation on why you think this is |
|
|
3515 | a bug in libev. However, don't be annoyed when you get a brisk \*(L"this is |
|
|
3516 | no bug\*(R" answer and take the chance of learning how to interpret valgrind |
|
|
3517 | properly. |
|
|
3518 | .PP |
|
|
3519 | If you need, for some reason, empty reports from valgrind for your project |
|
|
3520 | I suggest using suppression lists. |
3268 | .SH "AUTHOR" |
3521 | .SH "AUTHOR" |
3269 | .IX Header "AUTHOR" |
3522 | .IX Header "AUTHOR" |
3270 | Marc Lehmann <libev@schmorp.de>. |
3523 | Marc Lehmann <libev@schmorp.de>. |
3271 | .SH "POD ERRORS" |
3524 | .SH "POD ERRORS" |
3272 | .IX Header "POD ERRORS" |
3525 | .IX Header "POD ERRORS" |
3273 | Hey! \fBThe above document had some coding errors, which are explained below:\fR |
3526 | Hey! \fBThe above document had some coding errors, which are explained below:\fR |
3274 | .IP "Around line 2996:" 4 |
3527 | .IP "Around line 3107:" 4 |
3275 | .IX Item "Around line 2996:" |
3528 | .IX Item "Around line 3107:" |
3276 | You forgot a '=back' before '=head2' |
3529 | You forgot a '=back' before '=head2' |