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

Comparing libev/ev.pod (file contents):
Revision 1.131 by root, Tue Feb 19 17:09:28 2008 UTC vs.
Revision 1.132 by root, Wed Feb 20 17:45:29 2008 UTC

… …
1156configure a timer to trigger every 10 seconds, then it will trigger at 1156configure a timer to trigger every 10 seconds, then it will trigger at
1157exactly 10 second intervals. If, however, your program cannot keep up with 1157exactly 10 second intervals. If, however, your program cannot keep up with
1158the timer (because it takes longer than those 10 seconds to do stuff) the 1158the timer (because it takes longer than those 10 seconds to do stuff) the
1159timer will not fire more than once per event loop iteration. 1159timer will not fire more than once per event loop iteration.
1160 1160
1161=item ev_timer_again (loop) 1161=item ev_timer_again (loop, ev_timer *)
1162 1162
1163This will act as if the timer timed out and restart it again if it is 1163This will act as if the timer timed out and restart it again if it is
1164repeating. The exact semantics are: 1164repeating. The exact semantics are:
1165 1165
1166If the timer is pending, its pending status is cleared. 1166If the timer is pending, its pending status is cleared.
… …
1275In this configuration the watcher triggers an event at the wallclock time 1275In this configuration the watcher triggers an event at the wallclock time
1276C<at> and doesn't repeat. It will not adjust when a time jump occurs, 1276C<at> and doesn't repeat. It will not adjust when a time jump occurs,
1277that is, if it is to be run at January 1st 2011 then it will run when the 1277that is, if it is to be run at January 1st 2011 then it will run when the
1278system time reaches or surpasses this time. 1278system time reaches or surpasses this time.
1279 1279
1280=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) 1280=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1281 1281
1282In this mode the watcher will always be scheduled to time out at the next 1282In this mode the watcher will always be scheduled to time out at the next
1283C<at + N * interval> time (for some integer N, which can also be negative) 1283C<at + N * interval> time (for some integer N, which can also be negative)
1284and then repeat, regardless of any time jumps. 1284and then repeat, regardless of any time jumps.
1285 1285
… …
1435=item int signum [read-only] 1435=item int signum [read-only]
1436 1436
1437The signal the watcher watches out for. 1437The signal the watcher watches out for.
1438 1438
1439=back 1439=back
1440
1441=head3 Examples
1442
1443Example: Try to exit cleanly on SIGINT and SIGTERM.
1444
1445 static void
1446 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1447 {
1448 ev_unloop (loop, EVUNLOOP_ALL);
1449 }
1450
1451 struct ev_signal signal_watcher;
1452 ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1453 ev_signal_start (loop, &sigint_cb);
1440 1454
1441 1455
1442=head2 C<ev_child> - watch out for process status changes 1456=head2 C<ev_child> - watch out for process status changes
1443 1457
1444Child watchers trigger when your process receives a SIGCHLD in response to 1458Child watchers trigger when your process receives a SIGCHLD in response to
… …
1474The process exit/trace status caused by C<rpid> (see your systems 1488The process exit/trace status caused by C<rpid> (see your systems
1475C<waitpid> and C<sys/wait.h> documentation for details). 1489C<waitpid> and C<sys/wait.h> documentation for details).
1476 1490
1477=back 1491=back
1478 1492
1479=head3 Examples
1480
1481Example: Try to exit cleanly on SIGINT and SIGTERM.
1482
1483 static void
1484 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1485 {
1486 ev_unloop (loop, EVUNLOOP_ALL);
1487 }
1488
1489 struct ev_signal signal_watcher;
1490 ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1491 ev_signal_start (loop, &sigint_cb);
1492
1493 1493
1494=head2 C<ev_stat> - did the file attributes just change? 1494=head2 C<ev_stat> - did the file attributes just change?
1495 1495
1496This watches a filesystem path for attribute changes. That is, it calls 1496This watches a filesystem path for attribute changes. That is, it calls
1497C<stat> regularly (or when the OS says it changed) and sees if it changed 1497C<stat> regularly (or when the OS says it changed) and sees if it changed
… …
1576 1576
1577The callback will be receive C<EV_STAT> when a change was detected, 1577The callback will be receive C<EV_STAT> when a change was detected,
1578relative to the attributes at the time the watcher was started (or the 1578relative to the attributes at the time the watcher was started (or the
1579last change was detected). 1579last change was detected).
1580 1580
1581=item ev_stat_stat (ev_stat *) 1581=item ev_stat_stat (loop, ev_stat *)
1582 1582
1583Updates the stat buffer immediately with new values. If you change the 1583Updates the stat buffer immediately with new values. If you change the
1584watched path in your callback, you could call this fucntion to avoid 1584watched path in your callback, you could call this fucntion to avoid
1585detecting this change (while introducing a race condition). Can also be 1585detecting this change (while introducing a race condition). Can also be
1586useful simply to find out the new values. 1586useful simply to find out the new values.

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines