… | |
… | |
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-12-07" "perl v5.8.8" "User Contributed Perl Documentation" |
132 | .TH "<STANDARD INPUT>" 1 "2007-12-12" "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 |
… | |
… | |
255 | .IX Item "int ev_version_major ()" |
259 | .IX Item "int ev_version_major ()" |
256 | .PD 0 |
260 | .PD 0 |
257 | .IP "int ev_version_minor ()" 4 |
261 | .IP "int ev_version_minor ()" 4 |
258 | .IX Item "int ev_version_minor ()" |
262 | .IX Item "int ev_version_minor ()" |
259 | .PD |
263 | .PD |
260 | You can find out the major and minor version numbers of the library |
264 | You can find out the major and minor \s-1ABI\s0 version numbers of the library |
261 | you linked against by calling the functions \f(CW\*(C`ev_version_major\*(C'\fR and |
265 | you linked against by calling the functions \f(CW\*(C`ev_version_major\*(C'\fR and |
262 | \&\f(CW\*(C`ev_version_minor\*(C'\fR. If you want, you can compare against the global |
266 | \&\f(CW\*(C`ev_version_minor\*(C'\fR. If you want, you can compare against the global |
263 | symbols \f(CW\*(C`EV_VERSION_MAJOR\*(C'\fR and \f(CW\*(C`EV_VERSION_MINOR\*(C'\fR, which specify the |
267 | symbols \f(CW\*(C`EV_VERSION_MAJOR\*(C'\fR and \f(CW\*(C`EV_VERSION_MINOR\*(C'\fR, which specify the |
264 | version of the library your program was compiled against. |
268 | version of the library your program was compiled against. |
265 | .Sp |
269 | .Sp |
|
|
270 | These version numbers refer to the \s-1ABI\s0 version of the library, not the |
|
|
271 | release version. |
|
|
272 | .Sp |
266 | Usually, it's a good idea to terminate if the major versions mismatch, |
273 | Usually, it's a good idea to terminate if the major versions mismatch, |
267 | as this indicates an incompatible change. Minor versions are usually |
274 | as this indicates an incompatible change. Minor versions are usually |
268 | compatible to older versions, so a larger minor version alone is usually |
275 | compatible to older versions, so a larger minor version alone is usually |
269 | not a problem. |
276 | not a problem. |
270 | .Sp |
277 | .Sp |
271 | Example: Make sure we haven't accidentally been linked against the wrong |
278 | Example: Make sure we haven't accidentally been linked against the wrong |
272 | version. |
279 | version. |
… | |
… | |
630 | libev watchers. However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is |
637 | libev watchers. However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is |
631 | usually a better approach for this kind of thing. |
638 | usually a better approach for this kind of thing. |
632 | .Sp |
639 | .Sp |
633 | Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does: |
640 | Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does: |
634 | .Sp |
641 | .Sp |
635 | .Vb 18 |
642 | .Vb 19 |
|
|
643 | \& - Before the first iteration, call any pending watchers. |
636 | \& * If there are no active watchers (reference count is zero), return. |
644 | \& * If there are no active watchers (reference count is zero), return. |
637 | \& - Queue prepare watchers and then call all outstanding watchers. |
645 | \& - Queue all prepare watchers and then call all outstanding watchers. |
638 | \& - If we have been forked, recreate the kernel state. |
646 | \& - If we have been forked, recreate the kernel state. |
639 | \& - Update the kernel state with all outstanding changes. |
647 | \& - Update the kernel state with all outstanding changes. |
640 | \& - Update the "event loop time". |
648 | \& - Update the "event loop time". |
641 | \& - Calculate for how long to block. |
649 | \& - Calculate for how long to block. |
642 | \& - Block the process, waiting for any events. |
650 | \& - Block the process, waiting for any events. |
… | |
… | |
885 | .IP "bool ev_is_pending (ev_TYPE *watcher)" 4 |
893 | .IP "bool ev_is_pending (ev_TYPE *watcher)" 4 |
886 | .IX Item "bool ev_is_pending (ev_TYPE *watcher)" |
894 | .IX Item "bool ev_is_pending (ev_TYPE *watcher)" |
887 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
895 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
888 | events but its callback has not yet been invoked). As long as a watcher |
896 | events but its callback has not yet been invoked). As long as a watcher |
889 | is pending (but not active) you must not call an init function on it (but |
897 | is pending (but not active) you must not call an init function on it (but |
890 | \&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe) and you must make sure the watcher is available to |
898 | \&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe), you must not change its priority, and you must |
891 | libev (e.g. you cnanot \f(CW\*(C`free ()\*(C'\fR it). |
899 | make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR |
|
|
900 | it). |
892 | .IP "callback ev_cb (ev_TYPE *watcher)" 4 |
901 | .IP "callback ev_cb (ev_TYPE *watcher)" 4 |
893 | .IX Item "callback ev_cb (ev_TYPE *watcher)" |
902 | .IX Item "callback ev_cb (ev_TYPE *watcher)" |
894 | Returns the callback currently set on the watcher. |
903 | Returns the callback currently set on the watcher. |
895 | .IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 |
904 | .IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 |
896 | .IX Item "ev_cb_set (ev_TYPE *watcher, callback)" |
905 | .IX Item "ev_cb_set (ev_TYPE *watcher, callback)" |
… | |
… | |
914 | watchers on the same event and make sure one is called first. |
923 | watchers on the same event and make sure one is called first. |
915 | .Sp |
924 | .Sp |
916 | If you need to suppress invocation when higher priority events are pending |
925 | If you need to suppress invocation when higher priority events are pending |
917 | you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality. |
926 | you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality. |
918 | .Sp |
927 | .Sp |
|
|
928 | You \fImust not\fR change the priority of a watcher as long as it is active or |
|
|
929 | pending. |
|
|
930 | .Sp |
919 | The default priority used by watchers when no priority has been set is |
931 | The default priority used by watchers when no priority has been set is |
920 | always \f(CW0\fR, which is supposed to not be too high and not be too low :). |
932 | always \f(CW0\fR, which is supposed to not be too high and not be too low :). |
921 | .Sp |
933 | .Sp |
922 | Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is |
934 | Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is |
923 | fine, as long as you do not mind that the priority value you query might |
935 | fine, as long as you do not mind that the priority value you query might |
924 | or might not have been adjusted to be within valid range. |
936 | or might not have been adjusted to be within valid range. |
|
|
937 | .IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4 |
|
|
938 | .IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)" |
|
|
939 | Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither |
|
|
940 | \&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback |
|
|
941 | can deal with that fact. |
|
|
942 | .IP "int ev_clear_pending (loop, ev_TYPE *watcher)" 4 |
|
|
943 | .IX Item "int ev_clear_pending (loop, ev_TYPE *watcher)" |
|
|
944 | If the watcher is pending, this function returns clears its pending status |
|
|
945 | and returns its \f(CW\*(C`revents\*(C'\fR bitset (as if its callback was invoked). If the |
|
|
946 | watcher isn't pending it does nothing and returns \f(CW0\fR. |
925 | .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" |
947 | .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" |
926 | .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" |
948 | .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" |
927 | Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change |
949 | Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change |
928 | and read at any time, libev will completely ignore it. This can be used |
950 | and read at any time, libev will completely ignore it. This can be used |
929 | to associate arbitrary data with your watcher. If you need more data and |
951 | to associate arbitrary data with your watcher. If you need more data and |
… | |
… | |
1043 | If you cannot run the fd in non-blocking mode (for example you should not |
1065 | If you cannot run the fd in non-blocking mode (for example you should not |
1044 | play around with an Xlib connection), then you have to seperately re-test |
1066 | play around with an Xlib connection), then you have to seperately re-test |
1045 | whether a file descriptor is really ready with a known-to-be good interface |
1067 | whether a file descriptor is really ready with a known-to-be good interface |
1046 | such as poll (fortunately in our Xlib example, Xlib already does this on |
1068 | such as poll (fortunately in our Xlib example, Xlib already does this on |
1047 | its own, so its quite safe to use). |
1069 | its own, so its quite safe to use). |
|
|
1070 | .PP |
|
|
1071 | \fIThe special problem of disappearing file descriptors\fR |
|
|
1072 | .IX Subsection "The special problem of disappearing file descriptors" |
|
|
1073 | .PP |
|
|
1074 | Some backends (e.g kqueue, epoll) need to be told about closing a file |
|
|
1075 | descriptor (either by calling \f(CW\*(C`close\*(C'\fR explicitly or by any other means, |
|
|
1076 | such as \f(CW\*(C`dup\*(C'\fR). The reason is that you register interest in some file |
|
|
1077 | descriptor, but when it goes away, the operating system will silently drop |
|
|
1078 | this interest. If another file descriptor with the same number then is |
|
|
1079 | registered with libev, there is no efficient way to see that this is, in |
|
|
1080 | fact, a different file descriptor. |
|
|
1081 | .PP |
|
|
1082 | To avoid having to explicitly tell libev about such cases, libev follows |
|
|
1083 | the following policy: Each time \f(CW\*(C`ev_io_set\*(C'\fR is being called, libev |
|
|
1084 | will assume that this is potentially a new file descriptor, otherwise |
|
|
1085 | it is assumed that the file descriptor stays the same. That means that |
|
|
1086 | you \fIhave\fR to call \f(CW\*(C`ev_io_set\*(C'\fR (or \f(CW\*(C`ev_io_init\*(C'\fR) when you change the |
|
|
1087 | descriptor even if the file descriptor number itself did not change. |
|
|
1088 | .PP |
|
|
1089 | This is how one would do it normally anyway, the important point is that |
|
|
1090 | the libev application should not optimise around libev but should leave |
|
|
1091 | optimisations to libev. |
|
|
1092 | .PP |
|
|
1093 | \fIWatcher-Specific Functions\fR |
|
|
1094 | .IX Subsection "Watcher-Specific Functions" |
1048 | .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 |
1095 | .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 |
1049 | .IX Item "ev_io_init (ev_io *, callback, int fd, int events)" |
1096 | .IX Item "ev_io_init (ev_io *, callback, int fd, int events)" |
1050 | .PD 0 |
1097 | .PD 0 |
1051 | .IP "ev_io_set (ev_io *, int fd, int events)" 4 |
1098 | .IP "ev_io_set (ev_io *, int fd, int events)" 4 |
1052 | .IX Item "ev_io_set (ev_io *, int fd, int events)" |
1099 | .IX Item "ev_io_set (ev_io *, int fd, int events)" |
… | |
… | |
1105 | .Ve |
1152 | .Ve |
1106 | .PP |
1153 | .PP |
1107 | The callback is guarenteed to be invoked only when its timeout has passed, |
1154 | The callback is guarenteed to be invoked only when its timeout has passed, |
1108 | but if multiple timers become ready during the same loop iteration then |
1155 | but if multiple timers become ready during the same loop iteration then |
1109 | order of execution is undefined. |
1156 | order of execution is undefined. |
|
|
1157 | .PP |
|
|
1158 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1159 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1110 | .IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4 |
1160 | .IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4 |
1111 | .IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" |
1161 | .IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" |
1112 | .PD 0 |
1162 | .PD 0 |
1113 | .IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 |
1163 | .IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 |
1114 | .IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" |
1164 | .IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" |
… | |
… | |
1216 | but on wallclock time (absolute time). You can tell a periodic watcher |
1266 | but on wallclock time (absolute time). You can tell a periodic watcher |
1217 | to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a |
1267 | to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a |
1218 | periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now () |
1268 | periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now () |
1219 | + 10.\*(C'\fR) and then reset your system clock to the last year, then it will |
1269 | + 10.\*(C'\fR) and then reset your system clock to the last year, then it will |
1220 | take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger |
1270 | take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger |
1221 | roughly 10 seconds later and of course not if you reset your system time |
1271 | roughly 10 seconds later). |
1222 | again). |
|
|
1223 | .PP |
1272 | .PP |
1224 | They can also be used to implement vastly more complex timers, such as |
1273 | They can also be used to implement vastly more complex timers, such as |
1225 | triggering an event on eahc midnight, local time. |
1274 | triggering an event on each midnight, local time or other, complicated, |
|
|
1275 | rules. |
1226 | .PP |
1276 | .PP |
1227 | As with timers, the callback is guarenteed to be invoked only when the |
1277 | As with timers, the callback is guarenteed to be invoked only when the |
1228 | time (\f(CW\*(C`at\*(C'\fR) has been passed, but if multiple periodic timers become ready |
1278 | time (\f(CW\*(C`at\*(C'\fR) has been passed, but if multiple periodic timers become ready |
1229 | during the same loop iteration then order of execution is undefined. |
1279 | during the same loop iteration then order of execution is undefined. |
|
|
1280 | .PP |
|
|
1281 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1282 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1230 | .IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 |
1283 | .IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 |
1231 | .IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" |
1284 | .IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" |
1232 | .PD 0 |
1285 | .PD 0 |
1233 | .IP "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 4 |
1286 | .IP "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 4 |
1234 | .IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" |
1287 | .IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" |
1235 | .PD |
1288 | .PD |
1236 | Lots of arguments, lets sort it out... There are basically three modes of |
1289 | Lots of arguments, lets sort it out... There are basically three modes of |
1237 | operation, and we will explain them from simplest to complex: |
1290 | operation, and we will explain them from simplest to complex: |
1238 | .RS 4 |
1291 | .RS 4 |
1239 | .IP "* absolute timer (interval = reschedule_cb = 0)" 4 |
1292 | .IP "* absolute timer (at = time, interval = reschedule_cb = 0)" 4 |
1240 | .IX Item "absolute timer (interval = reschedule_cb = 0)" |
1293 | .IX Item "absolute timer (at = time, interval = reschedule_cb = 0)" |
1241 | In this configuration the watcher triggers an event at the wallclock time |
1294 | In this configuration the watcher triggers an event at the wallclock time |
1242 | \&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs, |
1295 | \&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs, |
1243 | that is, if it is to be run at January 1st 2011 then it will run when the |
1296 | that is, if it is to be run at January 1st 2011 then it will run when the |
1244 | system time reaches or surpasses this time. |
1297 | system time reaches or surpasses this time. |
1245 | .IP "* non-repeating interval timer (interval > 0, reschedule_cb = 0)" 4 |
1298 | .IP "* non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)" 4 |
1246 | .IX Item "non-repeating interval timer (interval > 0, reschedule_cb = 0)" |
1299 | .IX Item "non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)" |
1247 | In this mode the watcher will always be scheduled to time out at the next |
1300 | In this mode the watcher will always be scheduled to time out at the next |
1248 | \&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N) and then repeat, regardless |
1301 | \&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N, which can also be negative) |
1249 | of any time jumps. |
1302 | and then repeat, regardless of any time jumps. |
1250 | .Sp |
1303 | .Sp |
1251 | This can be used to create timers that do not drift with respect to system |
1304 | This can be used to create timers that do not drift with respect to system |
1252 | time: |
1305 | time: |
1253 | .Sp |
1306 | .Sp |
1254 | .Vb 1 |
1307 | .Vb 1 |
… | |
… | |
1261 | by 3600. |
1314 | by 3600. |
1262 | .Sp |
1315 | .Sp |
1263 | Another way to think about it (for the mathematically inclined) is that |
1316 | Another way to think about it (for the mathematically inclined) is that |
1264 | \&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible |
1317 | \&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible |
1265 | time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. |
1318 | time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. |
|
|
1319 | .Sp |
|
|
1320 | For numerical stability it is preferable that the \f(CW\*(C`at\*(C'\fR value is near |
|
|
1321 | \&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for |
|
|
1322 | this value. |
1266 | .IP "* manual reschedule mode (reschedule_cb = callback)" 4 |
1323 | .IP "* manual reschedule mode (at and interval ignored, reschedule_cb = callback)" 4 |
1267 | .IX Item "manual reschedule mode (reschedule_cb = callback)" |
1324 | .IX Item "manual reschedule mode (at and interval ignored, reschedule_cb = callback)" |
1268 | In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being |
1325 | In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being |
1269 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1326 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1270 | reschedule callback will be called with the watcher as first, and the |
1327 | reschedule callback will be called with the watcher as first, and the |
1271 | current time as second argument. |
1328 | current time as second argument. |
1272 | .Sp |
1329 | .Sp |
1273 | \&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, |
1330 | \&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, |
1274 | ever, or make any event loop modifications\fR. If you need to stop it, |
1331 | ever, or make any event loop modifications\fR. If you need to stop it, |
1275 | return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop it afterwards (e.g. by |
1332 | return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop it afterwards (e.g. by |
1276 | starting a prepare watcher). |
1333 | starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is legal). |
1277 | .Sp |
1334 | .Sp |
1278 | Its prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
1335 | Its prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
1279 | ev_tstamp now)\*(C'\fR, e.g.: |
1336 | ev_tstamp now)\*(C'\fR, e.g.: |
1280 | .Sp |
1337 | .Sp |
1281 | .Vb 4 |
1338 | .Vb 4 |
… | |
… | |
1305 | .IX Item "ev_periodic_again (loop, ev_periodic *)" |
1362 | .IX Item "ev_periodic_again (loop, ev_periodic *)" |
1306 | Simply stops and restarts the periodic watcher again. This is only useful |
1363 | Simply stops and restarts the periodic watcher again. This is only useful |
1307 | when you changed some parameters or the reschedule callback would return |
1364 | when you changed some parameters or the reschedule callback would return |
1308 | a different time than the last time it was called (e.g. in a crond like |
1365 | a different time than the last time it was called (e.g. in a crond like |
1309 | program when the crontabs have changed). |
1366 | program when the crontabs have changed). |
|
|
1367 | .IP "ev_tstamp offset [read\-write]" 4 |
|
|
1368 | .IX Item "ev_tstamp offset [read-write]" |
|
|
1369 | When repeating, this contains the offset value, otherwise this is the |
|
|
1370 | absolute point in time (the \f(CW\*(C`at\*(C'\fR value passed to \f(CW\*(C`ev_periodic_set\*(C'\fR). |
|
|
1371 | .Sp |
|
|
1372 | Can be modified any time, but changes only take effect when the periodic |
|
|
1373 | timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. |
1310 | .IP "ev_tstamp interval [read\-write]" 4 |
1374 | .IP "ev_tstamp interval [read\-write]" 4 |
1311 | .IX Item "ev_tstamp interval [read-write]" |
1375 | .IX Item "ev_tstamp interval [read-write]" |
1312 | The current interval value. Can be modified any time, but changes only |
1376 | The current interval value. Can be modified any time, but changes only |
1313 | take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being |
1377 | take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being |
1314 | called. |
1378 | called. |
… | |
… | |
1374 | first watcher gets started will libev actually register a signal watcher |
1438 | first watcher gets started will libev actually register a signal watcher |
1375 | with the kernel (thus it coexists with your own signal handlers as long |
1439 | with the kernel (thus it coexists with your own signal handlers as long |
1376 | as you don't register any with libev). Similarly, when the last signal |
1440 | as you don't register any with libev). Similarly, when the last signal |
1377 | watcher for a signal is stopped libev will reset the signal handler to |
1441 | watcher for a signal is stopped libev will reset the signal handler to |
1378 | \&\s-1SIG_DFL\s0 (regardless of what it was set to before). |
1442 | \&\s-1SIG_DFL\s0 (regardless of what it was set to before). |
|
|
1443 | .PP |
|
|
1444 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1445 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1379 | .IP "ev_signal_init (ev_signal *, callback, int signum)" 4 |
1446 | .IP "ev_signal_init (ev_signal *, callback, int signum)" 4 |
1380 | .IX Item "ev_signal_init (ev_signal *, callback, int signum)" |
1447 | .IX Item "ev_signal_init (ev_signal *, callback, int signum)" |
1381 | .PD 0 |
1448 | .PD 0 |
1382 | .IP "ev_signal_set (ev_signal *, int signum)" 4 |
1449 | .IP "ev_signal_set (ev_signal *, int signum)" 4 |
1383 | .IX Item "ev_signal_set (ev_signal *, int signum)" |
1450 | .IX Item "ev_signal_set (ev_signal *, int signum)" |
… | |
… | |
1390 | .ie n .Sh """ev_child"" \- watch out for process status changes" |
1457 | .ie n .Sh """ev_child"" \- watch out for process status changes" |
1391 | .el .Sh "\f(CWev_child\fP \- watch out for process status changes" |
1458 | .el .Sh "\f(CWev_child\fP \- watch out for process status changes" |
1392 | .IX Subsection "ev_child - watch out for process status changes" |
1459 | .IX Subsection "ev_child - watch out for process status changes" |
1393 | Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to |
1460 | Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to |
1394 | some child status changes (most typically when a child of yours dies). |
1461 | some child status changes (most typically when a child of yours dies). |
|
|
1462 | .PP |
|
|
1463 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1464 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1395 | .IP "ev_child_init (ev_child *, callback, int pid)" 4 |
1465 | .IP "ev_child_init (ev_child *, callback, int pid)" 4 |
1396 | .IX Item "ev_child_init (ev_child *, callback, int pid)" |
1466 | .IX Item "ev_child_init (ev_child *, callback, int pid)" |
1397 | .PD 0 |
1467 | .PD 0 |
1398 | .IP "ev_child_set (ev_child *, int pid)" 4 |
1468 | .IP "ev_child_set (ev_child *, int pid)" 4 |
1399 | .IX Item "ev_child_set (ev_child *, int pid)" |
1469 | .IX Item "ev_child_set (ev_child *, int pid)" |
… | |
… | |
1464 | reader). Inotify will be used to give hints only and should not change the |
1534 | reader). Inotify will be used to give hints only and should not change the |
1465 | semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs |
1535 | semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs |
1466 | to fall back to regular polling again even with inotify, but changes are |
1536 | to fall back to regular polling again even with inotify, but changes are |
1467 | usually detected immediately, and if the file exists there will be no |
1537 | usually detected immediately, and if the file exists there will be no |
1468 | polling. |
1538 | polling. |
|
|
1539 | .PP |
|
|
1540 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1541 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1469 | .IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 |
1542 | .IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 |
1470 | .IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" |
1543 | .IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" |
1471 | .PD 0 |
1544 | .PD 0 |
1472 | .IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4 |
1545 | .IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4 |
1473 | .IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" |
1546 | .IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" |
… | |
… | |
1552 | .PP |
1625 | .PP |
1553 | Apart from keeping your process non-blocking (which is a useful |
1626 | Apart from keeping your process non-blocking (which is a useful |
1554 | effect on its own sometimes), idle watchers are a good place to do |
1627 | effect on its own sometimes), idle watchers are a good place to do |
1555 | \&\*(L"pseudo\-background processing\*(R", or delay processing stuff to after the |
1628 | \&\*(L"pseudo\-background processing\*(R", or delay processing stuff to after the |
1556 | event loop has handled all outstanding events. |
1629 | event loop has handled all outstanding events. |
|
|
1630 | .PP |
|
|
1631 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1632 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1557 | .IP "ev_idle_init (ev_signal *, callback)" 4 |
1633 | .IP "ev_idle_init (ev_signal *, callback)" 4 |
1558 | .IX Item "ev_idle_init (ev_signal *, callback)" |
1634 | .IX Item "ev_idle_init (ev_signal *, callback)" |
1559 | Initialises and configures the idle watcher \- it has no parameters of any |
1635 | Initialises and configures the idle watcher \- it has no parameters of any |
1560 | kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, |
1636 | kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, |
1561 | believe me. |
1637 | believe me. |
… | |
… | |
1616 | are ready to run (it's actually more complicated: it only runs coroutines |
1692 | are ready to run (it's actually more complicated: it only runs coroutines |
1617 | with priority higher than or equal to the event loop and one coroutine |
1693 | with priority higher than or equal to the event loop and one coroutine |
1618 | of lower priority, but only once, using idle watchers to keep the event |
1694 | of lower priority, but only once, using idle watchers to keep the event |
1619 | loop from blocking if lower-priority coroutines are active, thus mapping |
1695 | loop from blocking if lower-priority coroutines are active, thus mapping |
1620 | low-priority coroutines to idle/background tasks). |
1696 | low-priority coroutines to idle/background tasks). |
|
|
1697 | .PP |
|
|
1698 | It is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) |
|
|
1699 | priority, to ensure that they are being run before any other watchers |
|
|
1700 | after the poll. Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, |
|
|
1701 | too) should not activate (\*(L"feed\*(R") events into libev. While libev fully |
|
|
1702 | supports this, they will be called before other \f(CW\*(C`ev_check\*(C'\fR watchers did |
|
|
1703 | their job. As \f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other event |
|
|
1704 | loops those other event loops might be in an unusable state until their |
|
|
1705 | \&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with |
|
|
1706 | others). |
|
|
1707 | .PP |
|
|
1708 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1709 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1621 | .IP "ev_prepare_init (ev_prepare *, callback)" 4 |
1710 | .IP "ev_prepare_init (ev_prepare *, callback)" 4 |
1622 | .IX Item "ev_prepare_init (ev_prepare *, callback)" |
1711 | .IX Item "ev_prepare_init (ev_prepare *, callback)" |
1623 | .PD 0 |
1712 | .PD 0 |
1624 | .IP "ev_check_init (ev_check *, callback)" 4 |
1713 | .IP "ev_check_init (ev_check *, callback)" 4 |
1625 | .IX Item "ev_check_init (ev_check *, callback)" |
1714 | .IX Item "ev_check_init (ev_check *, callback)" |
1626 | .PD |
1715 | .PD |
1627 | Initialises and configures the prepare or check watcher \- they have no |
1716 | Initialises and configures the prepare or check watcher \- they have no |
1628 | parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR |
1717 | parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR |
1629 | macros, but using them is utterly, utterly and completely pointless. |
1718 | macros, but using them is utterly, utterly and completely pointless. |
1630 | .PP |
1719 | .PP |
1631 | Example: To include a library such as adns, you would add \s-1IO\s0 watchers |
1720 | There are a number of principal ways to embed other event loops or modules |
1632 | and a timeout watcher in a prepare handler, as required by libadns, and |
1721 | into libev. Here are some ideas on how to include libadns into libev |
|
|
1722 | (there is a Perl module named \f(CW\*(C`EV::ADNS\*(C'\fR that does this, which you could |
|
|
1723 | use for an actually working example. Another Perl module named \f(CW\*(C`EV::Glib\*(C'\fR |
|
|
1724 | embeds a Glib main context into libev, and finally, \f(CW\*(C`Glib::EV\*(C'\fR embeds \s-1EV\s0 |
|
|
1725 | into the Glib event loop). |
|
|
1726 | .PP |
|
|
1727 | Method 1: Add \s-1IO\s0 watchers and a timeout watcher in a prepare handler, |
1633 | in a check watcher, destroy them and call into libadns. What follows is |
1728 | and in a check watcher, destroy them and call into libadns. What follows |
1634 | pseudo-code only of course: |
1729 | is pseudo-code only of course. This requires you to either use a low |
|
|
1730 | priority for the check watcher or use \f(CW\*(C`ev_clear_pending\*(C'\fR explicitly, as |
|
|
1731 | the callbacks for the IO/timeout watchers might not have been called yet. |
1635 | .PP |
1732 | .PP |
1636 | .Vb 2 |
1733 | .Vb 2 |
1637 | \& static ev_io iow [nfd]; |
1734 | \& static ev_io iow [nfd]; |
1638 | \& static ev_timer tw; |
1735 | \& static ev_timer tw; |
1639 | .Ve |
1736 | .Ve |
1640 | .PP |
1737 | .PP |
1641 | .Vb 9 |
1738 | .Vb 4 |
1642 | \& static void |
1739 | \& static void |
1643 | \& io_cb (ev_loop *loop, ev_io *w, int revents) |
1740 | \& io_cb (ev_loop *loop, ev_io *w, int revents) |
1644 | \& { |
1741 | \& { |
1645 | \& // set the relevant poll flags |
|
|
1646 | \& // could also call adns_processreadable etc. here |
|
|
1647 | \& struct pollfd *fd = (struct pollfd *)w->data; |
|
|
1648 | \& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
|
|
1649 | \& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
|
|
1650 | \& } |
1742 | \& } |
1651 | .Ve |
1743 | .Ve |
1652 | .PP |
1744 | .PP |
1653 | .Vb 8 |
1745 | .Vb 8 |
1654 | \& // create io watchers for each fd and a timer before blocking |
1746 | \& // create io watchers for each fd and a timer before blocking |
… | |
… | |
1666 | \& ev_timer_init (&tw, 0, timeout * 1e-3); |
1758 | \& ev_timer_init (&tw, 0, timeout * 1e-3); |
1667 | \& ev_timer_start (loop, &tw); |
1759 | \& ev_timer_start (loop, &tw); |
1668 | .Ve |
1760 | .Ve |
1669 | .PP |
1761 | .PP |
1670 | .Vb 6 |
1762 | .Vb 6 |
1671 | \& // create on ev_io per pollfd |
1763 | \& // create one ev_io per pollfd |
1672 | \& for (int i = 0; i < nfd; ++i) |
1764 | \& for (int i = 0; i < nfd; ++i) |
1673 | \& { |
1765 | \& { |
1674 | \& ev_io_init (iow + i, io_cb, fds [i].fd, |
1766 | \& ev_io_init (iow + i, io_cb, fds [i].fd, |
1675 | \& ((fds [i].events & POLLIN ? EV_READ : 0) |
1767 | \& ((fds [i].events & POLLIN ? EV_READ : 0) |
1676 | \& | (fds [i].events & POLLOUT ? EV_WRITE : 0))); |
1768 | \& | (fds [i].events & POLLOUT ? EV_WRITE : 0))); |
1677 | .Ve |
1769 | .Ve |
1678 | .PP |
1770 | .PP |
1679 | .Vb 5 |
1771 | .Vb 4 |
1680 | \& fds [i].revents = 0; |
1772 | \& fds [i].revents = 0; |
1681 | \& iow [i].data = fds + i; |
|
|
1682 | \& ev_io_start (loop, iow + i); |
1773 | \& ev_io_start (loop, iow + i); |
1683 | \& } |
1774 | \& } |
1684 | \& } |
1775 | \& } |
1685 | .Ve |
1776 | .Ve |
1686 | .PP |
1777 | .PP |
… | |
… | |
1690 | \& adns_check_cb (ev_loop *loop, ev_check *w, int revents) |
1781 | \& adns_check_cb (ev_loop *loop, ev_check *w, int revents) |
1691 | \& { |
1782 | \& { |
1692 | \& ev_timer_stop (loop, &tw); |
1783 | \& ev_timer_stop (loop, &tw); |
1693 | .Ve |
1784 | .Ve |
1694 | .PP |
1785 | .PP |
1695 | .Vb 2 |
1786 | .Vb 8 |
1696 | \& for (int i = 0; i < nfd; ++i) |
1787 | \& for (int i = 0; i < nfd; ++i) |
|
|
1788 | \& { |
|
|
1789 | \& // set the relevant poll flags |
|
|
1790 | \& // could also call adns_processreadable etc. here |
|
|
1791 | \& struct pollfd *fd = fds + i; |
|
|
1792 | \& int revents = ev_clear_pending (iow + i); |
|
|
1793 | \& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
|
|
1794 | \& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
|
|
1795 | .Ve |
|
|
1796 | .PP |
|
|
1797 | .Vb 3 |
|
|
1798 | \& // now stop the watcher |
1697 | \& ev_io_stop (loop, iow + i); |
1799 | \& ev_io_stop (loop, iow + i); |
|
|
1800 | \& } |
1698 | .Ve |
1801 | .Ve |
1699 | .PP |
1802 | .PP |
1700 | .Vb 2 |
1803 | .Vb 2 |
1701 | \& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); |
1804 | \& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); |
|
|
1805 | \& } |
|
|
1806 | .Ve |
|
|
1807 | .PP |
|
|
1808 | Method 2: This would be just like method 1, but you run \f(CW\*(C`adns_afterpoll\*(C'\fR |
|
|
1809 | in the prepare watcher and would dispose of the check watcher. |
|
|
1810 | .PP |
|
|
1811 | Method 3: If the module to be embedded supports explicit event |
|
|
1812 | notification (adns does), you can also make use of the actual watcher |
|
|
1813 | callbacks, and only destroy/create the watchers in the prepare watcher. |
|
|
1814 | .PP |
|
|
1815 | .Vb 5 |
|
|
1816 | \& static void |
|
|
1817 | \& timer_cb (EV_P_ ev_timer *w, int revents) |
|
|
1818 | \& { |
|
|
1819 | \& adns_state ads = (adns_state)w->data; |
|
|
1820 | \& update_now (EV_A); |
|
|
1821 | .Ve |
|
|
1822 | .PP |
|
|
1823 | .Vb 2 |
|
|
1824 | \& adns_processtimeouts (ads, &tv_now); |
|
|
1825 | \& } |
|
|
1826 | .Ve |
|
|
1827 | .PP |
|
|
1828 | .Vb 5 |
|
|
1829 | \& static void |
|
|
1830 | \& io_cb (EV_P_ ev_io *w, int revents) |
|
|
1831 | \& { |
|
|
1832 | \& adns_state ads = (adns_state)w->data; |
|
|
1833 | \& update_now (EV_A); |
|
|
1834 | .Ve |
|
|
1835 | .PP |
|
|
1836 | .Vb 3 |
|
|
1837 | \& if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now); |
|
|
1838 | \& if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now); |
|
|
1839 | \& } |
|
|
1840 | .Ve |
|
|
1841 | .PP |
|
|
1842 | .Vb 1 |
|
|
1843 | \& // do not ever call adns_afterpoll |
|
|
1844 | .Ve |
|
|
1845 | .PP |
|
|
1846 | Method 4: Do not use a prepare or check watcher because the module you |
|
|
1847 | want to embed is too inflexible to support it. Instead, youc na override |
|
|
1848 | their poll function. The drawback with this solution is that the main |
|
|
1849 | loop is now no longer controllable by \s-1EV\s0. The \f(CW\*(C`Glib::EV\*(C'\fR module does |
|
|
1850 | this. |
|
|
1851 | .PP |
|
|
1852 | .Vb 4 |
|
|
1853 | \& static gint |
|
|
1854 | \& event_poll_func (GPollFD *fds, guint nfds, gint timeout) |
|
|
1855 | \& { |
|
|
1856 | \& int got_events = 0; |
|
|
1857 | .Ve |
|
|
1858 | .PP |
|
|
1859 | .Vb 2 |
|
|
1860 | \& for (n = 0; n < nfds; ++n) |
|
|
1861 | \& // create/start io watcher that sets the relevant bits in fds[n] and increment got_events |
|
|
1862 | .Ve |
|
|
1863 | .PP |
|
|
1864 | .Vb 2 |
|
|
1865 | \& if (timeout >= 0) |
|
|
1866 | \& // create/start timer |
|
|
1867 | .Ve |
|
|
1868 | .PP |
|
|
1869 | .Vb 2 |
|
|
1870 | \& // poll |
|
|
1871 | \& ev_loop (EV_A_ 0); |
|
|
1872 | .Ve |
|
|
1873 | .PP |
|
|
1874 | .Vb 3 |
|
|
1875 | \& // stop timer again |
|
|
1876 | \& if (timeout >= 0) |
|
|
1877 | \& ev_timer_stop (EV_A_ &to); |
|
|
1878 | .Ve |
|
|
1879 | .PP |
|
|
1880 | .Vb 3 |
|
|
1881 | \& // stop io watchers again - their callbacks should have set |
|
|
1882 | \& for (n = 0; n < nfds; ++n) |
|
|
1883 | \& ev_io_stop (EV_A_ iow [n]); |
|
|
1884 | .Ve |
|
|
1885 | .PP |
|
|
1886 | .Vb 2 |
|
|
1887 | \& return got_events; |
1702 | \& } |
1888 | \& } |
1703 | .Ve |
1889 | .Ve |
1704 | .ie n .Sh """ev_embed"" \- when one backend isn't enough..." |
1890 | .ie n .Sh """ev_embed"" \- when one backend isn't enough..." |
1705 | .el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." |
1891 | .el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." |
1706 | .IX Subsection "ev_embed - when one backend isn't enough..." |
1892 | .IX Subsection "ev_embed - when one backend isn't enough..." |
… | |
… | |
1775 | \& ev_embed_start (loop_hi, &embed); |
1961 | \& ev_embed_start (loop_hi, &embed); |
1776 | \& } |
1962 | \& } |
1777 | \& else |
1963 | \& else |
1778 | \& loop_lo = loop_hi; |
1964 | \& loop_lo = loop_hi; |
1779 | .Ve |
1965 | .Ve |
|
|
1966 | .PP |
|
|
1967 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1968 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1780 | .IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
1969 | .IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
1781 | .IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" |
1970 | .IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" |
1782 | .PD 0 |
1971 | .PD 0 |
1783 | .IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
1972 | .IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
1784 | .IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" |
1973 | .IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" |
… | |
… | |
1890 | .PP |
2079 | .PP |
1891 | .Vb 1 |
2080 | .Vb 1 |
1892 | \& #include <ev++.h> |
2081 | \& #include <ev++.h> |
1893 | .Ve |
2082 | .Ve |
1894 | .PP |
2083 | .PP |
1895 | (it is not installed by default). This automatically includes \fIev.h\fR |
2084 | This automatically includes \fIev.h\fR and puts all of its definitions (many |
1896 | and puts all of its definitions (many of them macros) into the global |
2085 | of them macros) into the global namespace. All \*(C+ specific things are |
1897 | namespace. All \*(C+ specific things are put into the \f(CW\*(C`ev\*(C'\fR namespace. |
2086 | put into the \f(CW\*(C`ev\*(C'\fR namespace. It should support all the same embedding |
|
|
2087 | options as \fIev.h\fR, most notably \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. |
1898 | .PP |
2088 | .PP |
1899 | It should support all the same embedding options as \fIev.h\fR, most notably |
2089 | Care has been taken to keep the overhead low. The only data member the \*(C+ |
1900 | \&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. |
2090 | classes add (compared to plain C\-style watchers) is the event loop pointer |
|
|
2091 | that the watcher is associated with (or no additional members at all if |
|
|
2092 | you disable \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR when embedding libev). |
|
|
2093 | .PP |
|
|
2094 | Currently, functions, and static and non-static member functions can be |
|
|
2095 | used as callbacks. Other types should be easy to add as long as they only |
|
|
2096 | need one additional pointer for context. If you need support for other |
|
|
2097 | types of functors please contact the author (preferably after implementing |
|
|
2098 | it). |
1901 | .PP |
2099 | .PP |
1902 | Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: |
2100 | Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: |
1903 | .ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4 |
2101 | .ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4 |
1904 | .el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 |
2102 | .el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 |
1905 | .IX Item "ev::READ, ev::WRITE etc." |
2103 | .IX Item "ev::READ, ev::WRITE etc." |
… | |
… | |
1917 | which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro |
2115 | which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro |
1918 | defines by many implementations. |
2116 | defines by many implementations. |
1919 | .Sp |
2117 | .Sp |
1920 | All of those classes have these methods: |
2118 | All of those classes have these methods: |
1921 | .RS 4 |
2119 | .RS 4 |
1922 | .IP "ev::TYPE::TYPE (object *, object::method *)" 4 |
2120 | .IP "ev::TYPE::TYPE ()" 4 |
1923 | .IX Item "ev::TYPE::TYPE (object *, object::method *)" |
2121 | .IX Item "ev::TYPE::TYPE ()" |
1924 | .PD 0 |
2122 | .PD 0 |
1925 | .IP "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" 4 |
2123 | .IP "ev::TYPE::TYPE (struct ev_loop *)" 4 |
1926 | .IX Item "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" |
2124 | .IX Item "ev::TYPE::TYPE (struct ev_loop *)" |
1927 | .IP "ev::TYPE::~TYPE" 4 |
2125 | .IP "ev::TYPE::~TYPE" 4 |
1928 | .IX Item "ev::TYPE::~TYPE" |
2126 | .IX Item "ev::TYPE::~TYPE" |
1929 | .PD |
2127 | .PD |
1930 | The constructor takes a pointer to an object and a method pointer to |
2128 | The constructor (optionally) takes an event loop to associate the watcher |
1931 | the event handler callback to call in this class. The constructor calls |
2129 | with. If it is omitted, it will use \f(CW\*(C`EV_DEFAULT\*(C'\fR. |
1932 | \&\f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the \f(CW\*(C`set\*(C'\fR method |
2130 | .Sp |
1933 | before starting it. If you do not specify a loop then the constructor |
2131 | The constructor calls \f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the |
1934 | automatically associates the default loop with this watcher. |
2132 | \&\f(CW\*(C`set\*(C'\fR method before starting it. |
|
|
2133 | .Sp |
|
|
2134 | It will not set a callback, however: You have to call the templated \f(CW\*(C`set\*(C'\fR |
|
|
2135 | method to set a callback before you can start the watcher. |
|
|
2136 | .Sp |
|
|
2137 | (The reason why you have to use a method is a limitation in \*(C+ which does |
|
|
2138 | not allow explicit template arguments for constructors). |
1935 | .Sp |
2139 | .Sp |
1936 | The destructor automatically stops the watcher if it is active. |
2140 | The destructor automatically stops the watcher if it is active. |
|
|
2141 | .IP "w\->set<class, &class::method> (object *)" 4 |
|
|
2142 | .IX Item "w->set<class, &class::method> (object *)" |
|
|
2143 | This method sets the callback method to call. The method has to have a |
|
|
2144 | signature of \f(CW\*(C`void (*)(ev_TYPE &, int)\*(C'\fR, it receives the watcher as |
|
|
2145 | first argument and the \f(CW\*(C`revents\*(C'\fR as second. The object must be given as |
|
|
2146 | parameter and is stored in the \f(CW\*(C`data\*(C'\fR member of the watcher. |
|
|
2147 | .Sp |
|
|
2148 | This method synthesizes efficient thunking code to call your method from |
|
|
2149 | the C callback that libev requires. If your compiler can inline your |
|
|
2150 | callback (i.e. it is visible to it at the place of the \f(CW\*(C`set\*(C'\fR call and |
|
|
2151 | your compiler is good :), then the method will be fully inlined into the |
|
|
2152 | thunking function, making it as fast as a direct C callback. |
|
|
2153 | .Sp |
|
|
2154 | Example: simple class declaration and watcher initialisation |
|
|
2155 | .Sp |
|
|
2156 | .Vb 4 |
|
|
2157 | \& struct myclass |
|
|
2158 | \& { |
|
|
2159 | \& void io_cb (ev::io &w, int revents) { } |
|
|
2160 | \& } |
|
|
2161 | .Ve |
|
|
2162 | .Sp |
|
|
2163 | .Vb 3 |
|
|
2164 | \& myclass obj; |
|
|
2165 | \& ev::io iow; |
|
|
2166 | \& iow.set <myclass, &myclass::io_cb> (&obj); |
|
|
2167 | .Ve |
|
|
2168 | .IP "w\->set<function> (void *data = 0)" 4 |
|
|
2169 | .IX Item "w->set<function> (void *data = 0)" |
|
|
2170 | Also sets a callback, but uses a static method or plain function as |
|
|
2171 | callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's |
|
|
2172 | \&\f(CW\*(C`data\*(C'\fR member and is free for you to use. |
|
|
2173 | .Sp |
|
|
2174 | The prototype of the \f(CW\*(C`function\*(C'\fR must be \f(CW\*(C`void (*)(ev::TYPE &w, int)\*(C'\fR. |
|
|
2175 | .Sp |
|
|
2176 | See the method\-\f(CW\*(C`set\*(C'\fR above for more details. |
|
|
2177 | .Sp |
|
|
2178 | Example: |
|
|
2179 | .Sp |
|
|
2180 | .Vb 2 |
|
|
2181 | \& static void io_cb (ev::io &w, int revents) { } |
|
|
2182 | \& iow.set <io_cb> (); |
|
|
2183 | .Ve |
1937 | .IP "w\->set (struct ev_loop *)" 4 |
2184 | .IP "w\->set (struct ev_loop *)" 4 |
1938 | .IX Item "w->set (struct ev_loop *)" |
2185 | .IX Item "w->set (struct ev_loop *)" |
1939 | Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only |
2186 | Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only |
1940 | do this when the watcher is inactive (and not pending either). |
2187 | do this when the watcher is inactive (and not pending either). |
1941 | .IP "w\->set ([args])" 4 |
2188 | .IP "w\->set ([args])" 4 |
1942 | .IX Item "w->set ([args])" |
2189 | .IX Item "w->set ([args])" |
1943 | Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be |
2190 | Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be |
1944 | called at least once. Unlike the C counterpart, an active watcher gets |
2191 | called at least once. Unlike the C counterpart, an active watcher gets |
1945 | automatically stopped and restarted. |
2192 | automatically stopped and restarted when reconfiguring it with this |
|
|
2193 | method. |
1946 | .IP "w\->start ()" 4 |
2194 | .IP "w\->start ()" 4 |
1947 | .IX Item "w->start ()" |
2195 | .IX Item "w->start ()" |
1948 | Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument as the |
2196 | Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the |
1949 | constructor already takes the loop. |
2197 | constructor already stores the event loop. |
1950 | .IP "w\->stop ()" 4 |
2198 | .IP "w\->stop ()" 4 |
1951 | .IX Item "w->stop ()" |
2199 | .IX Item "w->stop ()" |
1952 | Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. |
2200 | Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. |
1953 | .ie n .IP "w\->again () ""ev::timer""\fR, \f(CW""ev::periodic"" only" 4 |
2201 | .ie n .IP "w\->again () ""ev::timer""\fR, \f(CW""ev::periodic"" only" 4 |
1954 | .el .IP "w\->again () \f(CWev::timer\fR, \f(CWev::periodic\fR only" 4 |
2202 | .el .IP "w\->again () \f(CWev::timer\fR, \f(CWev::periodic\fR only" 4 |
… | |
… | |
1980 | .Vb 2 |
2228 | .Vb 2 |
1981 | \& myclass (); |
2229 | \& myclass (); |
1982 | \& } |
2230 | \& } |
1983 | .Ve |
2231 | .Ve |
1984 | .PP |
2232 | .PP |
1985 | .Vb 6 |
2233 | .Vb 4 |
1986 | \& myclass::myclass (int fd) |
2234 | \& myclass::myclass (int fd) |
1987 | \& : io (this, &myclass::io_cb), |
|
|
1988 | \& idle (this, &myclass::idle_cb) |
|
|
1989 | \& { |
2235 | \& { |
|
|
2236 | \& io .set <myclass, &myclass::io_cb > (this); |
|
|
2237 | \& idle.set <myclass, &myclass::idle_cb> (this); |
|
|
2238 | .Ve |
|
|
2239 | .PP |
|
|
2240 | .Vb 2 |
1990 | \& io.start (fd, ev::READ); |
2241 | \& io.start (fd, ev::READ); |
1991 | \& } |
2242 | \& } |
1992 | .Ve |
2243 | .Ve |
1993 | .SH "MACRO MAGIC" |
2244 | .SH "MACRO MAGIC" |
1994 | .IX Header "MACRO MAGIC" |
2245 | .IX Header "MACRO MAGIC" |
… | |
… | |
2274 | If undefined or defined to \f(CW1\fR, then all event-loop-specific functions |
2525 | If undefined or defined to \f(CW1\fR, then all event-loop-specific functions |
2275 | will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create |
2526 | will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create |
2276 | additional independent event loops. Otherwise there will be no support |
2527 | additional independent event loops. Otherwise there will be no support |
2277 | for multiple event loops and there is no first event loop pointer |
2528 | for multiple event loops and there is no first event loop pointer |
2278 | argument. Instead, all functions act on the single default loop. |
2529 | argument. Instead, all functions act on the single default loop. |
|
|
2530 | .IP "\s-1EV_MINPRI\s0" 4 |
|
|
2531 | .IX Item "EV_MINPRI" |
|
|
2532 | .PD 0 |
|
|
2533 | .IP "\s-1EV_MAXPRI\s0" 4 |
|
|
2534 | .IX Item "EV_MAXPRI" |
|
|
2535 | .PD |
|
|
2536 | The range of allowed priorities. \f(CW\*(C`EV_MINPRI\*(C'\fR must be smaller or equal to |
|
|
2537 | \&\f(CW\*(C`EV_MAXPRI\*(C'\fR, but otherwise there are no non-obvious limitations. You can |
|
|
2538 | provide for more priorities by overriding those symbols (usually defined |
|
|
2539 | to be \f(CW\*(C`\-2\*(C'\fR and \f(CW2\fR, respectively). |
|
|
2540 | .Sp |
|
|
2541 | When doing priority-based operations, libev usually has to linearly search |
|
|
2542 | all the priorities, so having many of them (hundreds) uses a lot of space |
|
|
2543 | and time, so using the defaults of five priorities (\-2 .. +2) is usually |
|
|
2544 | fine. |
|
|
2545 | .Sp |
|
|
2546 | If your embedding app does not need any priorities, defining these both to |
|
|
2547 | \&\f(CW0\fR will save some memory and cpu. |
2279 | .IP "\s-1EV_PERIODIC_ENABLE\s0" 4 |
2548 | .IP "\s-1EV_PERIODIC_ENABLE\s0" 4 |
2280 | .IX Item "EV_PERIODIC_ENABLE" |
2549 | .IX Item "EV_PERIODIC_ENABLE" |
2281 | If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If |
2550 | If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If |
2282 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
2551 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
2283 | code. |
2552 | code. |
… | |
… | |
2382 | .SH "COMPLEXITIES" |
2651 | .SH "COMPLEXITIES" |
2383 | .IX Header "COMPLEXITIES" |
2652 | .IX Header "COMPLEXITIES" |
2384 | In this section the complexities of (many of) the algorithms used inside |
2653 | In this section the complexities of (many of) the algorithms used inside |
2385 | libev will be explained. For complexity discussions about backends see the |
2654 | libev will be explained. For complexity discussions about backends see the |
2386 | documentation for \f(CW\*(C`ev_default_init\*(C'\fR. |
2655 | documentation for \f(CW\*(C`ev_default_init\*(C'\fR. |
|
|
2656 | .Sp |
|
|
2657 | All of the following are about amortised time: If an array needs to be |
|
|
2658 | extended, libev needs to realloc and move the whole array, but this |
|
|
2659 | happens asymptotically never with higher number of elements, so O(1) might |
|
|
2660 | mean it might do a lengthy realloc operation in rare cases, but on average |
|
|
2661 | it is much faster and asymptotically approaches constant time. |
2387 | .RS 4 |
2662 | .RS 4 |
2388 | .IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 |
2663 | .IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 |
2389 | .IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" |
2664 | .IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" |
2390 | .PD 0 |
2665 | This means that, when you have a watcher that triggers in one hour and |
|
|
2666 | there are 100 watchers that would trigger before that then inserting will |
|
|
2667 | have to skip those 100 watchers. |
2391 | .IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4 |
2668 | .IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4 |
2392 | .IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" |
2669 | .IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" |
|
|
2670 | That means that for changing a timer costs less than removing/adding them |
|
|
2671 | as only the relative motion in the event queue has to be paid for. |
2393 | .IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 |
2672 | .IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 |
2394 | .IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" |
2673 | .IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" |
2395 | .IP "Stopping check/prepare/idle watchers: O(1)" 4 |
2674 | These just add the watcher into an array or at the head of a list. |
2396 | .IX Item "Stopping check/prepare/idle watchers: O(1)" |
2675 | =item Stopping check/prepare/idle watchers: O(1) |
2397 | .IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4 |
2676 | .IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4 |
2398 | .IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))" |
2677 | .IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))" |
|
|
2678 | These watchers are stored in lists then need to be walked to find the |
|
|
2679 | correct watcher to remove. The lists are usually short (you don't usually |
|
|
2680 | have many watchers waiting for the same fd or signal). |
2399 | .IP "Finding the next timer per loop iteration: O(1)" 4 |
2681 | .IP "Finding the next timer per loop iteration: O(1)" 4 |
2400 | .IX Item "Finding the next timer per loop iteration: O(1)" |
2682 | .IX Item "Finding the next timer per loop iteration: O(1)" |
|
|
2683 | .PD 0 |
2401 | .IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 |
2684 | .IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 |
2402 | .IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" |
2685 | .IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" |
|
|
2686 | .PD |
|
|
2687 | A change means an I/O watcher gets started or stopped, which requires |
|
|
2688 | libev to recalculate its status (and possibly tell the kernel). |
2403 | .IP "Activating one watcher: O(1)" 4 |
2689 | .IP "Activating one watcher: O(1)" 4 |
2404 | .IX Item "Activating one watcher: O(1)" |
2690 | .IX Item "Activating one watcher: O(1)" |
|
|
2691 | .PD 0 |
|
|
2692 | .IP "Priority handling: O(number_of_priorities)" 4 |
|
|
2693 | .IX Item "Priority handling: O(number_of_priorities)" |
|
|
2694 | .PD |
|
|
2695 | Priorities are implemented by allocating some space for each |
|
|
2696 | priority. When doing priority-based operations, libev usually has to |
|
|
2697 | linearly search all the priorities. |
2405 | .RE |
2698 | .RE |
2406 | .RS 4 |
2699 | .RS 4 |
2407 | .PD |
|
|
2408 | .SH "AUTHOR" |
2700 | .SH "AUTHOR" |
2409 | .IX Header "AUTHOR" |
2701 | .IX Header "AUTHOR" |
2410 | Marc Lehmann <libev@schmorp.de>. |
2702 | Marc Lehmann <libev@schmorp.de>. |