… | |
… | |
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-28" "perl v5.8.8" "User Contributed Perl Documentation" |
132 | .TH "<STANDARD INPUT>" 1 "2007-12-07" "perl v5.8.8" "User Contributed Perl Documentation" |
133 | .SH "NAME" |
133 | .SH "NAME" |
134 | libev \- a high performance full\-featured event loop written in C |
134 | libev \- a high performance full\-featured event loop written in C |
135 | .SH "SYNOPSIS" |
135 | .SH "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
137 | .Vb 1 |
137 | .Vb 1 |
… | |
… | |
196 | \& return 0; |
196 | \& return 0; |
197 | \& } |
197 | \& } |
198 | .Ve |
198 | .Ve |
199 | .SH "DESCRIPTION" |
199 | .SH "DESCRIPTION" |
200 | .IX Header "DESCRIPTION" |
200 | .IX Header "DESCRIPTION" |
|
|
201 | The newest version of this document is also available as a html-formatted |
|
|
202 | web page you might find easier to navigate when reading it for the first |
|
|
203 | time: <http://cvs.schmorp.de/libev/ev.html>. |
|
|
204 | .PP |
201 | Libev is an event loop: you register interest in certain events (such as a |
205 | Libev is an event loop: you register interest in certain events (such as a |
202 | file descriptor being readable or a timeout occuring), and it will manage |
206 | file descriptor being readable or a timeout occuring), and it will manage |
203 | these event sources and provide your program with events. |
207 | these event sources and provide your program with events. |
204 | .PP |
208 | .PP |
205 | To do this, it must take more or less complete control over your process |
209 | To do this, it must take more or less complete control over your process |
… | |
… | |
305 | might be supported on the current system, you would need to look at |
309 | might be supported on the current system, you would need to look at |
306 | \&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for |
310 | \&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for |
307 | recommended ones. |
311 | recommended ones. |
308 | .Sp |
312 | .Sp |
309 | See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. |
313 | See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. |
310 | .IP "ev_set_allocator (void *(*cb)(void *ptr, size_t size))" 4 |
314 | .IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4 |
311 | .IX Item "ev_set_allocator (void *(*cb)(void *ptr, size_t size))" |
315 | .IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" |
312 | Sets the allocation function to use (the prototype and semantics are |
316 | Sets the allocation function to use (the prototype is similar \- the |
313 | identical to the realloc C function). It is used to allocate and free |
317 | semantics is identical \- to the realloc C function). It is used to |
314 | memory (no surprises here). If it returns zero when memory needs to be |
318 | allocate and free memory (no surprises here). If it returns zero when |
315 | allocated, the library might abort or take some potentially destructive |
319 | memory needs to be allocated, the library might abort or take some |
316 | action. The default is your system realloc function. |
320 | potentially destructive action. The default is your system realloc |
|
|
321 | function. |
317 | .Sp |
322 | .Sp |
318 | You could override this function in high-availability programs to, say, |
323 | You could override this function in high-availability programs to, say, |
319 | free some memory if it cannot allocate memory, to use a special allocator, |
324 | free some memory if it cannot allocate memory, to use a special allocator, |
320 | or even to sleep a while and retry until some memory is available. |
325 | or even to sleep a while and retry until some memory is available. |
321 | .Sp |
326 | .Sp |
… | |
… | |
410 | or setgid) then libev will \fInot\fR look at the environment variable |
415 | or setgid) then libev will \fInot\fR look at the environment variable |
411 | \&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will |
416 | \&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will |
412 | override the flags completely if it is found in the environment. This is |
417 | override the flags completely if it is found in the environment. This is |
413 | useful to try out specific backends to test their performance, or to work |
418 | useful to try out specific backends to test their performance, or to work |
414 | around bugs. |
419 | around bugs. |
|
|
420 | .ie n .IP """EVFLAG_FORKCHECK""" 4 |
|
|
421 | .el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4 |
|
|
422 | .IX Item "EVFLAG_FORKCHECK" |
|
|
423 | Instead of calling \f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR manually after |
|
|
424 | a fork, you can also make libev check for a fork in each iteration by |
|
|
425 | enabling this flag. |
|
|
426 | .Sp |
|
|
427 | This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, |
|
|
428 | and thus this might slow down your event loop if you do a lot of loop |
|
|
429 | iterations and little real work, but is usually not noticeable (on my |
|
|
430 | Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence |
|
|
431 | without a syscall and thus \fIvery\fR fast, but my Linux system also has |
|
|
432 | \&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). |
|
|
433 | .Sp |
|
|
434 | The big advantage of this flag is that you can forget about fork (and |
|
|
435 | forget about forgetting to tell libev about forking) when you use this |
|
|
436 | flag. |
|
|
437 | .Sp |
|
|
438 | This flag setting cannot be overriden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR |
|
|
439 | environment variable. |
415 | .ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 |
440 | .ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 |
416 | .el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 |
441 | .el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 |
417 | .IX Item "EVBACKEND_SELECT (value 1, portable select backend)" |
442 | .IX Item "EVBACKEND_SELECT (value 1, portable select backend)" |
418 | This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as |
443 | This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as |
419 | libev tries to roll its own fd_set with no limits on the number of fds, |
444 | libev tries to roll its own fd_set with no limits on the number of fds, |
… | |
… | |
560 | .IP "ev_loop_fork (loop)" 4 |
585 | .IP "ev_loop_fork (loop)" 4 |
561 | .IX Item "ev_loop_fork (loop)" |
586 | .IX Item "ev_loop_fork (loop)" |
562 | Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by |
587 | Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by |
563 | \&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop |
588 | \&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop |
564 | after fork, and how you do this is entirely your own problem. |
589 | after fork, and how you do this is entirely your own problem. |
|
|
590 | .IP "unsigned int ev_loop_count (loop)" 4 |
|
|
591 | .IX Item "unsigned int ev_loop_count (loop)" |
|
|
592 | Returns the count of loop iterations for the loop, which is identical to |
|
|
593 | the number of times libev did poll for new events. It starts at \f(CW0\fR and |
|
|
594 | happily wraps around with enough iterations. |
|
|
595 | .Sp |
|
|
596 | This value can sometimes be useful as a generation counter of sorts (it |
|
|
597 | \&\*(L"ticks\*(R" the number of loop iterations), as it roughly corresponds with |
|
|
598 | \&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls. |
565 | .IP "unsigned int ev_backend (loop)" 4 |
599 | .IP "unsigned int ev_backend (loop)" 4 |
566 | .IX Item "unsigned int ev_backend (loop)" |
600 | .IX Item "unsigned int ev_backend (loop)" |
567 | Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in |
601 | Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in |
568 | use. |
602 | use. |
569 | .IP "ev_tstamp ev_now (loop)" 4 |
603 | .IP "ev_tstamp ev_now (loop)" 4 |
… | |
… | |
864 | Returns the callback currently set on the watcher. |
898 | Returns the callback currently set on the watcher. |
865 | .IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 |
899 | .IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 |
866 | .IX Item "ev_cb_set (ev_TYPE *watcher, callback)" |
900 | .IX Item "ev_cb_set (ev_TYPE *watcher, callback)" |
867 | Change the callback. You can change the callback at virtually any time |
901 | Change the callback. You can change the callback at virtually any time |
868 | (modulo threads). |
902 | (modulo threads). |
|
|
903 | .IP "ev_set_priority (ev_TYPE *watcher, priority)" 4 |
|
|
904 | .IX Item "ev_set_priority (ev_TYPE *watcher, priority)" |
|
|
905 | .PD 0 |
|
|
906 | .IP "int ev_priority (ev_TYPE *watcher)" 4 |
|
|
907 | .IX Item "int ev_priority (ev_TYPE *watcher)" |
|
|
908 | .PD |
|
|
909 | Set and query the priority of the watcher. The priority is a small |
|
|
910 | integer between \f(CW\*(C`EV_MAXPRI\*(C'\fR (default: \f(CW2\fR) and \f(CW\*(C`EV_MINPRI\*(C'\fR |
|
|
911 | (default: \f(CW\*(C`\-2\*(C'\fR). Pending watchers with higher priority will be invoked |
|
|
912 | before watchers with lower priority, but priority will not keep watchers |
|
|
913 | from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers). |
|
|
914 | .Sp |
|
|
915 | This means that priorities are \fIonly\fR used for ordering callback |
|
|
916 | invocation after new events have been received. This is useful, for |
|
|
917 | example, to reduce latency after idling, or more often, to bind two |
|
|
918 | watchers on the same event and make sure one is called first. |
|
|
919 | .Sp |
|
|
920 | If you need to suppress invocation when higher priority events are pending |
|
|
921 | you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality. |
|
|
922 | .Sp |
|
|
923 | The default priority used by watchers when no priority has been set is |
|
|
924 | always \f(CW0\fR, which is supposed to not be too high and not be too low :). |
|
|
925 | .Sp |
|
|
926 | Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is |
|
|
927 | fine, as long as you do not mind that the priority value you query might |
|
|
928 | or might not have been adjusted to be within valid range. |
869 | .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" |
929 | .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" |
870 | .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" |
930 | .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" |
871 | Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change |
931 | Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change |
872 | and read at any time, libev will completely ignore it. This can be used |
932 | and read at any time, libev will completely ignore it. This can be used |
873 | to associate arbitrary data with your watcher. If you need more data and |
933 | to associate arbitrary data with your watcher. If you need more data and |
… | |
… | |
984 | it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning |
1044 | it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning |
985 | \&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives. |
1045 | \&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives. |
986 | .PP |
1046 | .PP |
987 | If you cannot run the fd in non-blocking mode (for example you should not |
1047 | If you cannot run the fd in non-blocking mode (for example you should not |
988 | play around with an Xlib connection), then you have to seperately re-test |
1048 | play around with an Xlib connection), then you have to seperately re-test |
989 | wether a file descriptor is really ready with a known-to-be good interface |
1049 | whether a file descriptor is really ready with a known-to-be good interface |
990 | such as poll (fortunately in our Xlib example, Xlib already does this on |
1050 | such as poll (fortunately in our Xlib example, Xlib already does this on |
991 | its own, so its quite safe to use). |
1051 | its own, so its quite safe to use). |
992 | .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 |
1052 | .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 |
993 | .IX Item "ev_io_init (ev_io *, callback, int fd, int events)" |
1053 | .IX Item "ev_io_init (ev_io *, callback, int fd, int events)" |
994 | .PD 0 |
1054 | .PD 0 |
… | |
… | |
1070 | .IP "ev_timer_again (loop)" 4 |
1130 | .IP "ev_timer_again (loop)" 4 |
1071 | .IX Item "ev_timer_again (loop)" |
1131 | .IX Item "ev_timer_again (loop)" |
1072 | This will act as if the timer timed out and restart it again if it is |
1132 | This will act as if the timer timed out and restart it again if it is |
1073 | repeating. The exact semantics are: |
1133 | repeating. The exact semantics are: |
1074 | .Sp |
1134 | .Sp |
|
|
1135 | If the timer is pending, its pending status is cleared. |
|
|
1136 | .Sp |
1075 | If the timer is started but nonrepeating, stop it. |
1137 | If the timer is started but nonrepeating, stop it (as if it timed out). |
1076 | .Sp |
1138 | .Sp |
1077 | If the timer is repeating, either start it if necessary (with the repeat |
1139 | If the timer is repeating, either start it if necessary (with the |
1078 | value), or reset the running timer to the repeat value. |
1140 | \&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value. |
1079 | .Sp |
1141 | .Sp |
1080 | This sounds a bit complicated, but here is a useful and typical |
1142 | This sounds a bit complicated, but here is a useful and typical |
1081 | example: Imagine you have a tcp connection and you want a so-called |
1143 | example: Imagine you have a tcp connection and you want a so-called idle |
1082 | idle timeout, that is, you want to be called when there have been, |
1144 | timeout, that is, you want to be called when there have been, say, 60 |
1083 | say, 60 seconds of inactivity on the socket. The easiest way to do |
1145 | seconds of inactivity on the socket. The easiest way to do this is to |
1084 | this 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 |
1146 | configure an \f(CW\*(C`ev_timer\*(C'\fR with a \f(CW\*(C`repeat\*(C'\fR value of \f(CW60\fR and then call |
1085 | \&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If |
1147 | \&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If |
1086 | you go into an idle state where you do not expect data to travel on the |
1148 | you go into an idle state where you do not expect data to travel on the |
1087 | socket, you can stop the timer, and again will automatically restart it if |
1149 | socket, you can \f(CW\*(C`ev_timer_stop\*(C'\fR the timer, and \f(CW\*(C`ev_timer_again\*(C'\fR will |
1088 | need be. |
1150 | automatically restart it if need be. |
1089 | .Sp |
1151 | .Sp |
1090 | You can also ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR altogether |
1152 | That means you can ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR |
1091 | and only ever use the \f(CW\*(C`repeat\*(C'\fR value: |
1153 | altogether and only ever use the \f(CW\*(C`repeat\*(C'\fR value and \f(CW\*(C`ev_timer_again\*(C'\fR: |
1092 | .Sp |
1154 | .Sp |
1093 | .Vb 8 |
1155 | .Vb 8 |
1094 | \& ev_timer_init (timer, callback, 0., 5.); |
1156 | \& ev_timer_init (timer, callback, 0., 5.); |
1095 | \& ev_timer_again (loop, timer); |
1157 | \& ev_timer_again (loop, timer); |
1096 | \& ... |
1158 | \& ... |
… | |
… | |
1099 | \& ... |
1161 | \& ... |
1100 | \& timer->again = 10.; |
1162 | \& timer->again = 10.; |
1101 | \& ev_timer_again (loop, timer); |
1163 | \& ev_timer_again (loop, timer); |
1102 | .Ve |
1164 | .Ve |
1103 | .Sp |
1165 | .Sp |
1104 | This is more efficient then stopping/starting the timer eahc time you want |
1166 | This is more slightly efficient then stopping/starting the timer each time |
1105 | to modify its timeout value. |
1167 | you want to modify its timeout value. |
1106 | .IP "ev_tstamp repeat [read\-write]" 4 |
1168 | .IP "ev_tstamp repeat [read\-write]" 4 |
1107 | .IX Item "ev_tstamp repeat [read-write]" |
1169 | .IX Item "ev_tstamp repeat [read-write]" |
1108 | The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out |
1170 | The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out |
1109 | or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any), |
1171 | or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any), |
1110 | which is also when any modifications are taken into account. |
1172 | which is also when any modifications are taken into account. |
… | |
… | |
1383 | not exist\*(R" is a status change like any other. The condition \*(L"path does |
1445 | not exist\*(R" is a status change like any other. The condition \*(L"path does |
1384 | not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is |
1446 | not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is |
1385 | otherwise always forced to be at least one) and all the other fields of |
1447 | otherwise always forced to be at least one) and all the other fields of |
1386 | the stat buffer having unspecified contents. |
1448 | the stat buffer having unspecified contents. |
1387 | .PP |
1449 | .PP |
|
|
1450 | The path \fIshould\fR be absolute and \fImust not\fR end in a slash. If it is |
|
|
1451 | relative and your working directory changes, the behaviour is undefined. |
|
|
1452 | .PP |
1388 | Since there is no standard to do this, the portable implementation simply |
1453 | Since there is no standard to do this, the portable implementation simply |
1389 | calls \f(CW\*(C`stat (2)\*(C'\fR regularly on the path to see if it changed somehow. You |
1454 | calls \f(CW\*(C`stat (2)\*(C'\fR regularly on the path to see if it changed somehow. You |
1390 | can specify a recommended polling interval for this case. If you specify |
1455 | can specify a recommended polling interval for this case. If you specify |
1391 | a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable, |
1456 | a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable, |
1392 | unspecified default\fR value will be used (which you can expect to be around |
1457 | unspecified default\fR value will be used (which you can expect to be around |
… | |
… | |
1473 | \& ev_stat_start (loop, &passwd); |
1538 | \& ev_stat_start (loop, &passwd); |
1474 | .Ve |
1539 | .Ve |
1475 | .ie n .Sh """ev_idle"" \- when you've got nothing better to do..." |
1540 | .ie n .Sh """ev_idle"" \- when you've got nothing better to do..." |
1476 | .el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." |
1541 | .el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." |
1477 | .IX Subsection "ev_idle - when you've got nothing better to do..." |
1542 | .IX Subsection "ev_idle - when you've got nothing better to do..." |
1478 | Idle watchers trigger events when there are no other events are pending |
1543 | Idle watchers trigger events when no other events of the same or higher |
1479 | (prepare, check and other idle watchers do not count). That is, as long |
1544 | priority are pending (prepare, check and other idle watchers do not |
1480 | as your process is busy handling sockets or timeouts (or even signals, |
1545 | count). |
1481 | imagine) it will not be triggered. But when your process is idle all idle |
1546 | .PP |
1482 | watchers are being called again and again, once per event loop iteration \- |
1547 | That is, as long as your process is busy handling sockets or timeouts |
|
|
1548 | (or even signals, imagine) of the same or higher priority it will not be |
|
|
1549 | triggered. But when your process is idle (or only lower-priority watchers |
|
|
1550 | are pending), the idle watchers are being called once per event loop |
1483 | until stopped, that is, or your process receives more events and becomes |
1551 | iteration \- until stopped, that is, or your process receives more events |
1484 | busy. |
1552 | and becomes busy again with higher priority stuff. |
1485 | .PP |
1553 | .PP |
1486 | The most noteworthy effect is that as long as any idle watchers are |
1554 | The most noteworthy effect is that as long as any idle watchers are |
1487 | active, the process will not block when waiting for new events. |
1555 | active, the process will not block when waiting for new events. |
1488 | .PP |
1556 | .PP |
1489 | Apart from keeping your process non-blocking (which is a useful |
1557 | Apart from keeping your process non-blocking (which is a useful |
… | |
… | |
1584 | \& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
1652 | \& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
1585 | \& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
1653 | \& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
1586 | \& } |
1654 | \& } |
1587 | .Ve |
1655 | .Ve |
1588 | .PP |
1656 | .PP |
1589 | .Vb 7 |
1657 | .Vb 8 |
1590 | \& // create io watchers for each fd and a timer before blocking |
1658 | \& // create io watchers for each fd and a timer before blocking |
1591 | \& static void |
1659 | \& static void |
1592 | \& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
1660 | \& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
1593 | \& { |
1661 | \& { |
1594 | \& int timeout = 3600000;truct pollfd fds [nfd]; |
1662 | \& int timeout = 3600000; |
|
|
1663 | \& struct pollfd fds [nfd]; |
1595 | \& // actual code will need to loop here and realloc etc. |
1664 | \& // actual code will need to loop here and realloc etc. |
1596 | \& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
1665 | \& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
1597 | .Ve |
1666 | .Ve |
1598 | .PP |
1667 | .PP |
1599 | .Vb 3 |
1668 | .Vb 3 |
… | |
… | |
1926 | \& } |
1995 | \& } |
1927 | .Ve |
1996 | .Ve |
1928 | .SH "MACRO MAGIC" |
1997 | .SH "MACRO MAGIC" |
1929 | .IX Header "MACRO MAGIC" |
1998 | .IX Header "MACRO MAGIC" |
1930 | Libev can be compiled with a variety of options, the most fundemantal is |
1999 | Libev can be compiled with a variety of options, the most fundemantal is |
1931 | \&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines wether (most) functions and |
2000 | \&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) functions and |
1932 | callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. |
2001 | callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. |
1933 | .PP |
2002 | .PP |
1934 | To make it easier to write programs that cope with either variant, the |
2003 | To make it easier to write programs that cope with either variant, the |
1935 | following macros are defined: |
2004 | following macros are defined: |
1936 | .ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4 |
2005 | .ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4 |
… | |
… | |
1971 | .el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 |
2040 | .el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 |
1972 | .IX Item "EV_DEFAULT, EV_DEFAULT_" |
2041 | .IX Item "EV_DEFAULT, EV_DEFAULT_" |
1973 | Similar to the other two macros, this gives you the value of the default |
2042 | Similar to the other two macros, this gives you the value of the default |
1974 | loop, if multiple loops are supported (\*(L"ev loop default\*(R"). |
2043 | loop, if multiple loops are supported (\*(L"ev loop default\*(R"). |
1975 | .PP |
2044 | .PP |
1976 | Example: Declare and initialise a check watcher, working regardless of |
2045 | Example: Declare and initialise a check watcher, utilising the above |
1977 | wether multiple loops are supported or not. |
2046 | macros so it will work regardless of whether multiple loops are supported |
|
|
2047 | or not. |
1978 | .PP |
2048 | .PP |
1979 | .Vb 5 |
2049 | .Vb 5 |
1980 | \& static void |
2050 | \& static void |
1981 | \& check_cb (EV_P_ ev_timer *w, int revents) |
2051 | \& check_cb (EV_P_ ev_timer *w, int revents) |
1982 | \& { |
2052 | \& { |
… | |
… | |
2045 | .Vb 1 |
2115 | .Vb 1 |
2046 | \& ev_win32.c required on win32 platforms only |
2116 | \& ev_win32.c required on win32 platforms only |
2047 | .Ve |
2117 | .Ve |
2048 | .PP |
2118 | .PP |
2049 | .Vb 5 |
2119 | .Vb 5 |
2050 | \& ev_select.c only when select backend is enabled (which is by default) |
2120 | \& ev_select.c only when select backend is enabled (which is enabled by default) |
2051 | \& ev_poll.c only when poll backend is enabled (disabled by default) |
2121 | \& ev_poll.c only when poll backend is enabled (disabled by default) |
2052 | \& ev_epoll.c only when the epoll backend is enabled (disabled by default) |
2122 | \& ev_epoll.c only when the epoll backend is enabled (disabled by default) |
2053 | \& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
2123 | \& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
2054 | \& ev_port.c only when the solaris port backend is enabled (disabled by default) |
2124 | \& ev_port.c only when the solaris port backend is enabled (disabled by default) |
2055 | .Ve |
2125 | .Ve |
… | |
… | |
2208 | If undefined or defined to \f(CW1\fR, then all event-loop-specific functions |
2278 | If undefined or defined to \f(CW1\fR, then all event-loop-specific functions |
2209 | will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create |
2279 | will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create |
2210 | additional independent event loops. Otherwise there will be no support |
2280 | additional independent event loops. Otherwise there will be no support |
2211 | for multiple event loops and there is no first event loop pointer |
2281 | for multiple event loops and there is no first event loop pointer |
2212 | argument. Instead, all functions act on the single default loop. |
2282 | argument. Instead, all functions act on the single default loop. |
|
|
2283 | .IP "\s-1EV_MINPRI\s0" 4 |
|
|
2284 | .IX Item "EV_MINPRI" |
|
|
2285 | .PD 0 |
|
|
2286 | .IP "\s-1EV_MAXPRI\s0" 4 |
|
|
2287 | .IX Item "EV_MAXPRI" |
|
|
2288 | .PD |
|
|
2289 | The range of allowed priorities. \f(CW\*(C`EV_MINPRI\*(C'\fR must be smaller or equal to |
|
|
2290 | \&\f(CW\*(C`EV_MAXPRI\*(C'\fR, but otherwise there are no non-obvious limitations. You can |
|
|
2291 | provide for more priorities by overriding those symbols (usually defined |
|
|
2292 | to be \f(CW\*(C`\-2\*(C'\fR and \f(CW2\fR, respectively). |
|
|
2293 | .Sp |
|
|
2294 | When doing priority-based operations, libev usually has to linearly search |
|
|
2295 | all the priorities, so having many of them (hundreds) uses a lot of space |
|
|
2296 | and time, so using the defaults of five priorities (\-2 .. +2) is usually |
|
|
2297 | fine. |
|
|
2298 | .Sp |
|
|
2299 | If your embedding app does not need any priorities, defining these both to |
|
|
2300 | \&\f(CW0\fR will save some memory and cpu. |
2213 | .IP "\s-1EV_PERIODIC_ENABLE\s0" 4 |
2301 | .IP "\s-1EV_PERIODIC_ENABLE\s0" 4 |
2214 | .IX Item "EV_PERIODIC_ENABLE" |
2302 | .IX Item "EV_PERIODIC_ENABLE" |
2215 | If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If |
2303 | If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If |
|
|
2304 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
|
|
2305 | code. |
|
|
2306 | .IP "\s-1EV_IDLE_ENABLE\s0" 4 |
|
|
2307 | .IX Item "EV_IDLE_ENABLE" |
|
|
2308 | If undefined or defined to be \f(CW1\fR, then idle watchers are supported. If |
2216 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
2309 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
2217 | code. |
2310 | code. |
2218 | .IP "\s-1EV_EMBED_ENABLE\s0" 4 |
2311 | .IP "\s-1EV_EMBED_ENABLE\s0" 4 |
2219 | .IX Item "EV_EMBED_ENABLE" |
2312 | .IX Item "EV_EMBED_ENABLE" |
2220 | If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If |
2313 | If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If |
… | |
… | |
2282 | interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file |
2375 | interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file |
2283 | will be compiled. It is pretty complex because it provides its own header |
2376 | will be compiled. It is pretty complex because it provides its own header |
2284 | file. |
2377 | file. |
2285 | .Sp |
2378 | .Sp |
2286 | The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file |
2379 | The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file |
2287 | that everybody includes and which overrides some autoconf choices: |
2380 | that everybody includes and which overrides some configure choices: |
2288 | .Sp |
2381 | .Sp |
2289 | .Vb 4 |
2382 | .Vb 9 |
|
|
2383 | \& #define EV_MINIMAL 1 |
2290 | \& #define EV_USE_POLL 0 |
2384 | \& #define EV_USE_POLL 0 |
2291 | \& #define EV_MULTIPLICITY 0 |
2385 | \& #define EV_MULTIPLICITY 0 |
2292 | \& #define EV_PERIODICS 0 |
2386 | \& #define EV_PERIODIC_ENABLE 0 |
|
|
2387 | \& #define EV_STAT_ENABLE 0 |
|
|
2388 | \& #define EV_FORK_ENABLE 0 |
2293 | \& #define EV_CONFIG_H <config.h> |
2389 | \& #define EV_CONFIG_H <config.h> |
|
|
2390 | \& #define EV_MINPRI 0 |
|
|
2391 | \& #define EV_MAXPRI 0 |
2294 | .Ve |
2392 | .Ve |
2295 | .Sp |
2393 | .Sp |
2296 | .Vb 1 |
2394 | .Vb 1 |
2297 | \& #include "ev++.h" |
2395 | \& #include "ev++.h" |
2298 | .Ve |
2396 | .Ve |
… | |
… | |
2309 | libev will be explained. For complexity discussions about backends see the |
2407 | libev will be explained. For complexity discussions about backends see the |
2310 | documentation for \f(CW\*(C`ev_default_init\*(C'\fR. |
2408 | documentation for \f(CW\*(C`ev_default_init\*(C'\fR. |
2311 | .RS 4 |
2409 | .RS 4 |
2312 | .IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 |
2410 | .IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 |
2313 | .IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" |
2411 | .IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" |
2314 | .PD 0 |
2412 | This means that, when you have a watcher that triggers in one hour and |
|
|
2413 | there are 100 watchers that would trigger before that then inserting will |
|
|
2414 | have to skip those 100 watchers. |
2315 | .IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4 |
2415 | .IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4 |
2316 | .IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" |
2416 | .IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" |
|
|
2417 | That means that for changing a timer costs less than removing/adding them |
|
|
2418 | as only the relative motion in the event queue has to be paid for. |
2317 | .IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 |
2419 | .IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 |
2318 | .IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" |
2420 | .IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" |
|
|
2421 | These just add the watcher into an array or at the head of a list. If |
|
|
2422 | the array needs to be extended libev needs to realloc and move the whole |
|
|
2423 | array, but this happen asymptotically less and less with more watchers, |
|
|
2424 | thus amortised O(1). |
2319 | .IP "Stopping check/prepare/idle watchers: O(1)" 4 |
2425 | .IP "Stopping check/prepare/idle watchers: O(1)" 4 |
2320 | .IX Item "Stopping check/prepare/idle watchers: O(1)" |
2426 | .IX Item "Stopping check/prepare/idle watchers: O(1)" |
|
|
2427 | .PD 0 |
2321 | .IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4 |
2428 | .IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4 |
2322 | .IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))" |
2429 | .IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))" |
|
|
2430 | .PD |
|
|
2431 | These watchers are stored in lists then need to be walked to find the |
|
|
2432 | correct watcher to remove. The lists are usually short (you don't usually |
|
|
2433 | have many watchers waiting for the same fd or signal). |
2323 | .IP "Finding the next timer per loop iteration: O(1)" 4 |
2434 | .IP "Finding the next timer per loop iteration: O(1)" 4 |
2324 | .IX Item "Finding the next timer per loop iteration: O(1)" |
2435 | .IX Item "Finding the next timer per loop iteration: O(1)" |
|
|
2436 | .PD 0 |
2325 | .IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 |
2437 | .IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 |
2326 | .IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" |
2438 | .IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" |
|
|
2439 | .PD |
|
|
2440 | A change means an I/O watcher gets started or stopped, which requires |
|
|
2441 | libev to recalculate its status (and possibly tell the kernel). |
2327 | .IP "Activating one watcher: O(1)" 4 |
2442 | .IP "Activating one watcher: O(1)" 4 |
2328 | .IX Item "Activating one watcher: O(1)" |
2443 | .IX Item "Activating one watcher: O(1)" |
|
|
2444 | .PD 0 |
|
|
2445 | .IP "Priority handling: O(number_of_priorities)" 4 |
|
|
2446 | .IX Item "Priority handling: O(number_of_priorities)" |
|
|
2447 | .PD |
|
|
2448 | Priorities are implemented by allocating some space for each |
|
|
2449 | priority. When doing priority-based operations, libev usually has to |
|
|
2450 | linearly search all the priorities. |
2329 | .RE |
2451 | .RE |
2330 | .RS 4 |
2452 | .RS 4 |
2331 | .PD |
|
|
2332 | .SH "AUTHOR" |
2453 | .SH "AUTHOR" |
2333 | .IX Header "AUTHOR" |
2454 | .IX Header "AUTHOR" |
2334 | Marc Lehmann <libev@schmorp.de>. |
2455 | Marc Lehmann <libev@schmorp.de>. |