… | |
… | |
689 | interval to a value near C<0.1> or so, which is often enough for |
689 | interval to a value near C<0.1> or so, which is often enough for |
690 | interactive servers (of course not for games), likewise for timeouts. It |
690 | interactive servers (of course not for games), likewise for timeouts. It |
691 | usually doesn't make much sense to set it to a lower value than C<0.01>, |
691 | usually doesn't make much sense to set it to a lower value than C<0.01>, |
692 | as this approsaches the timing granularity of most systems. |
692 | as this approsaches the timing granularity of most systems. |
693 | |
693 | |
|
|
694 | =item ev_loop_verify (loop) |
|
|
695 | |
|
|
696 | This function only does something when C<EV_VERIFY> support has been |
|
|
697 | compiled in. It tries to go through all internal structures and checks |
|
|
698 | them for validity. If anything is found to be inconsistent, it will print |
|
|
699 | an error message to standard error and call C<abort ()>. |
|
|
700 | |
|
|
701 | This can be used to catch bugs inside libev itself: under normal |
|
|
702 | circumstances, this function will never abort as of course libev keeps its |
|
|
703 | data structures consistent. |
|
|
704 | |
694 | =back |
705 | =back |
695 | |
706 | |
696 | |
707 | |
697 | =head1 ANATOMY OF A WATCHER |
708 | =head1 ANATOMY OF A WATCHER |
698 | |
709 | |
… | |
… | |
1151 | |
1162 | |
1152 | Timer watchers are simple relative timers that generate an event after a |
1163 | Timer watchers are simple relative timers that generate an event after a |
1153 | given time, and optionally repeating in regular intervals after that. |
1164 | given time, and optionally repeating in regular intervals after that. |
1154 | |
1165 | |
1155 | The timers are based on real time, that is, if you register an event that |
1166 | The timers are based on real time, that is, if you register an event that |
1156 | times out after an hour and you reset your system clock to last years |
1167 | times out after an hour and you reset your system clock to january last |
1157 | time, it will still time out after (roughly) and hour. "Roughly" because |
1168 | year, it will still time out after (roughly) and hour. "Roughly" because |
1158 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1169 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1159 | monotonic clock option helps a lot here). |
1170 | monotonic clock option helps a lot here). |
1160 | |
1171 | |
1161 | The relative timeouts are calculated relative to the C<ev_now ()> |
1172 | The relative timeouts are calculated relative to the C<ev_now ()> |
1162 | time. This is usually the right thing as this timestamp refers to the time |
1173 | time. This is usually the right thing as this timestamp refers to the time |
… | |
… | |
1164 | you suspect event processing to be delayed and you I<need> to base the timeout |
1175 | you suspect event processing to be delayed and you I<need> to base the timeout |
1165 | on the current time, use something like this to adjust for this: |
1176 | on the current time, use something like this to adjust for this: |
1166 | |
1177 | |
1167 | ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
1178 | ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
1168 | |
1179 | |
1169 | The callback is guarenteed to be invoked only when its timeout has passed, |
1180 | The callback is guarenteed to be invoked only after its timeout has passed, |
1170 | but if multiple timers become ready during the same loop iteration then |
1181 | but if multiple timers become ready during the same loop iteration then |
1171 | order of execution is undefined. |
1182 | order of execution is undefined. |
1172 | |
1183 | |
1173 | =head3 Watcher-Specific Functions and Data Members |
1184 | =head3 Watcher-Specific Functions and Data Members |
1174 | |
1185 | |
… | |
… | |
1176 | |
1187 | |
1177 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
1188 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
1178 | |
1189 | |
1179 | =item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) |
1190 | =item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) |
1180 | |
1191 | |
1181 | Configure the timer to trigger after C<after> seconds. If C<repeat> is |
1192 | Configure the timer to trigger after C<after> seconds. If C<repeat> |
1182 | C<0.>, then it will automatically be stopped. If it is positive, then the |
1193 | is C<0.>, then it will automatically be stopped once the timeout is |
1183 | timer will automatically be configured to trigger again C<repeat> seconds |
1194 | reached. If it is positive, then the timer will automatically be |
1184 | later, again, and again, until stopped manually. |
1195 | configured to trigger again C<repeat> seconds later, again, and again, |
|
|
1196 | until stopped manually. |
1185 | |
1197 | |
1186 | The timer itself will do a best-effort at avoiding drift, that is, if you |
1198 | The timer itself will do a best-effort at avoiding drift, that is, if |
1187 | configure a timer to trigger every 10 seconds, then it will trigger at |
1199 | you configure a timer to trigger every 10 seconds, then it will normally |
1188 | exactly 10 second intervals. If, however, your program cannot keep up with |
1200 | trigger at exactly 10 second intervals. If, however, your program cannot |
1189 | the timer (because it takes longer than those 10 seconds to do stuff) the |
1201 | keep up with the timer (because it takes longer than those 10 seconds to |
1190 | timer will not fire more than once per event loop iteration. |
1202 | do stuff) the timer will not fire more than once per event loop iteration. |
1191 | |
1203 | |
1192 | =item ev_timer_again (loop, ev_timer *) |
1204 | =item ev_timer_again (loop, ev_timer *) |
1193 | |
1205 | |
1194 | This will act as if the timer timed out and restart it again if it is |
1206 | This will act as if the timer timed out and restart it again if it is |
1195 | repeating. The exact semantics are: |
1207 | repeating. The exact semantics are: |
… | |
… | |
1272 | Periodic watchers are also timers of a kind, but they are very versatile |
1284 | Periodic watchers are also timers of a kind, but they are very versatile |
1273 | (and unfortunately a bit complex). |
1285 | (and unfortunately a bit complex). |
1274 | |
1286 | |
1275 | Unlike C<ev_timer>'s, they are not based on real time (or relative time) |
1287 | Unlike C<ev_timer>'s, they are not based on real time (or relative time) |
1276 | but on wallclock time (absolute time). You can tell a periodic watcher |
1288 | but on wallclock time (absolute time). You can tell a periodic watcher |
1277 | to trigger "at" some specific point in time. For example, if you tell a |
1289 | to trigger after some specific point in time. For example, if you tell a |
1278 | periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now () |
1290 | periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now () |
1279 | + 10.>) and then reset your system clock to the last year, then it will |
1291 | + 10.>, that is, an absolute time not a delay) and then reset your system |
|
|
1292 | clock to january of the previous year, then it will take more than year |
1280 | take a year to trigger the event (unlike an C<ev_timer>, which would trigger |
1293 | to trigger the event (unlike an C<ev_timer>, which would still trigger |
1281 | roughly 10 seconds later). |
1294 | roughly 10 seconds later as it uses a relative timeout). |
1282 | |
1295 | |
1283 | They can also be used to implement vastly more complex timers, such as |
1296 | C<ev_periodic>s can also be used to implement vastly more complex timers, |
1284 | triggering an event on each midnight, local time or other, complicated, |
1297 | such as triggering an event on each "midnight, local time", or other |
1285 | rules. |
1298 | complicated, rules. |
1286 | |
1299 | |
1287 | As with timers, the callback is guarenteed to be invoked only when the |
1300 | As with timers, the callback is guarenteed to be invoked only when the |
1288 | time (C<at>) has been passed, but if multiple periodic timers become ready |
1301 | time (C<at>) has passed, but if multiple periodic timers become ready |
1289 | during the same loop iteration then order of execution is undefined. |
1302 | during the same loop iteration then order of execution is undefined. |
1290 | |
1303 | |
1291 | =head3 Watcher-Specific Functions and Data Members |
1304 | =head3 Watcher-Specific Functions and Data Members |
1292 | |
1305 | |
1293 | =over 4 |
1306 | =over 4 |
… | |
… | |
1301 | |
1314 | |
1302 | =over 4 |
1315 | =over 4 |
1303 | |
1316 | |
1304 | =item * absolute timer (at = time, interval = reschedule_cb = 0) |
1317 | =item * absolute timer (at = time, interval = reschedule_cb = 0) |
1305 | |
1318 | |
1306 | In this configuration the watcher triggers an event at the wallclock time |
1319 | In this configuration the watcher triggers an event after the wallclock |
1307 | C<at> and doesn't repeat. It will not adjust when a time jump occurs, |
1320 | time C<at> has passed and doesn't repeat. It will not adjust when a time |
1308 | that is, if it is to be run at January 1st 2011 then it will run when the |
1321 | jump occurs, that is, if it is to be run at January 1st 2011 then it will |
1309 | system time reaches or surpasses this time. |
1322 | run when the system time reaches or surpasses this time. |
1310 | |
1323 | |
1311 | =item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) |
1324 | =item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) |
1312 | |
1325 | |
1313 | In this mode the watcher will always be scheduled to time out at the next |
1326 | In this mode the watcher will always be scheduled to time out at the next |
1314 | C<at + N * interval> time (for some integer N, which can also be negative) |
1327 | C<at + N * interval> time (for some integer N, which can also be negative) |
1315 | and then repeat, regardless of any time jumps. |
1328 | and then repeat, regardless of any time jumps. |
1316 | |
1329 | |
1317 | This can be used to create timers that do not drift with respect to system |
1330 | This can be used to create timers that do not drift with respect to system |
1318 | time: |
1331 | time, for example, here is a C<ev_periodic> that triggers each hour, on |
|
|
1332 | the hour: |
1319 | |
1333 | |
1320 | ev_periodic_set (&periodic, 0., 3600., 0); |
1334 | ev_periodic_set (&periodic, 0., 3600., 0); |
1321 | |
1335 | |
1322 | This doesn't mean there will always be 3600 seconds in between triggers, |
1336 | This doesn't mean there will always be 3600 seconds in between triggers, |
1323 | but only that the the callback will be called when the system time shows a |
1337 | but only that the the callback will be called when the system time shows a |
… | |
… | |
1328 | C<ev_periodic> will try to run the callback in this mode at the next possible |
1342 | C<ev_periodic> will try to run the callback in this mode at the next possible |
1329 | time where C<time = at (mod interval)>, regardless of any time jumps. |
1343 | time where C<time = at (mod interval)>, regardless of any time jumps. |
1330 | |
1344 | |
1331 | For numerical stability it is preferable that the C<at> value is near |
1345 | For numerical stability it is preferable that the C<at> value is near |
1332 | C<ev_now ()> (the current time), but there is no range requirement for |
1346 | C<ev_now ()> (the current time), but there is no range requirement for |
1333 | this value. |
1347 | this value, and in fact is often specified as zero. |
|
|
1348 | |
|
|
1349 | Note also that there is an upper limit to how often a timer can fire (cpu |
|
|
1350 | speed for example), so if C<interval> is very small then timing stability |
|
|
1351 | will of course detoriate. Libev itself tries to be exact to be about one |
|
|
1352 | millisecond (if the OS supports it and the machine is fast enough). |
1334 | |
1353 | |
1335 | =item * manual reschedule mode (at and interval ignored, reschedule_cb = callback) |
1354 | =item * manual reschedule mode (at and interval ignored, reschedule_cb = callback) |
1336 | |
1355 | |
1337 | In this mode the values for C<interval> and C<at> are both being |
1356 | In this mode the values for C<interval> and C<at> are both being |
1338 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1357 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1339 | reschedule callback will be called with the watcher as first, and the |
1358 | reschedule callback will be called with the watcher as first, and the |
1340 | current time as second argument. |
1359 | current time as second argument. |
1341 | |
1360 | |
1342 | NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, |
1361 | NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, |
1343 | ever, or make any event loop modifications>. If you need to stop it, |
1362 | ever, or make ANY event loop modifications whatsoever>. |
1344 | return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by |
|
|
1345 | starting an C<ev_prepare> watcher, which is legal). |
|
|
1346 | |
1363 | |
|
|
1364 | If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop |
|
|
1365 | it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the |
|
|
1366 | only event loop modification you are allowed to do). |
|
|
1367 | |
1347 | Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
1368 | The callback prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic |
1348 | ev_tstamp now)>, e.g.: |
1369 | *w, ev_tstamp now)>, e.g.: |
1349 | |
1370 | |
1350 | static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) |
1371 | static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) |
1351 | { |
1372 | { |
1352 | return now + 60.; |
1373 | return now + 60.; |
1353 | } |
1374 | } |
… | |
… | |
1355 | It must return the next time to trigger, based on the passed time value |
1376 | It must return the next time to trigger, based on the passed time value |
1356 | (that is, the lowest time value larger than to the second argument). It |
1377 | (that is, the lowest time value larger than to the second argument). It |
1357 | will usually be called just before the callback will be triggered, but |
1378 | will usually be called just before the callback will be triggered, but |
1358 | might be called at other times, too. |
1379 | might be called at other times, too. |
1359 | |
1380 | |
1360 | NOTE: I<< This callback must always return a time that is later than the |
1381 | NOTE: I<< This callback must always return a time that is higher than or |
1361 | passed C<now> value >>. Not even C<now> itself will do, it I<must> be larger. |
1382 | equal to the passed C<now> value >>. |
1362 | |
1383 | |
1363 | This can be used to create very complex timers, such as a timer that |
1384 | This can be used to create very complex timers, such as a timer that |
1364 | triggers on each midnight, local time. To do this, you would calculate the |
1385 | triggers on "next midnight, local time". To do this, you would calculate the |
1365 | next midnight after C<now> and return the timestamp value for this. How |
1386 | next midnight after C<now> and return the timestamp value for this. How |
1366 | you do this is, again, up to you (but it is not trivial, which is the main |
1387 | you do this is, again, up to you (but it is not trivial, which is the main |
1367 | reason I omitted it as an example). |
1388 | reason I omitted it as an example). |
1368 | |
1389 | |
1369 | =back |
1390 | =back |
… | |
… | |
3021 | noticably with with many (hundreds) of watchers. |
3042 | noticably with with many (hundreds) of watchers. |
3022 | |
3043 | |
3023 | The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> |
3044 | The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> |
3024 | (disabled). |
3045 | (disabled). |
3025 | |
3046 | |
|
|
3047 | =item EV_VERIFY |
|
|
3048 | |
|
|
3049 | Controls how much internal verification (see C<ev_loop_verify ()>) will |
|
|
3050 | be done: If set to C<0>, no internal verification code will be compiled |
|
|
3051 | in. If set to C<1>, then verification code will be compiled in, but not |
|
|
3052 | called. If set to C<2>, then the internal verification code will be |
|
|
3053 | called once per loop, which can slow down libev. If set to C<3>, then the |
|
|
3054 | verification code will be called very frequently, which will slow down |
|
|
3055 | libev considerably. |
|
|
3056 | |
|
|
3057 | The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be |
|
|
3058 | C<0.> |
|
|
3059 | |
3026 | =item EV_COMMON |
3060 | =item EV_COMMON |
3027 | |
3061 | |
3028 | By default, all watchers have a C<void *data> member. By redefining |
3062 | By default, all watchers have a C<void *data> member. By redefining |
3029 | this macro to a something else you can include more and other types of |
3063 | this macro to a something else you can include more and other types of |
3030 | members. You have to define it each time you include one of the files, |
3064 | members. You have to define it each time you include one of the files, |