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

Comparing libev/ev.pod (file contents):
Revision 1.130 by root, Wed Feb 6 18:34:24 2008 UTC vs.
Revision 1.133 by root, Sun Feb 24 06:50:16 2008 UTC

… …
505=item ev_loop_fork (loop) 505=item ev_loop_fork (loop)
506 506
507Like C<ev_default_fork>, but acts on an event loop created by 507Like C<ev_default_fork>, but acts on an event loop created by
508C<ev_loop_new>. Yes, you have to call this on every allocated event loop 508C<ev_loop_new>. Yes, you have to call this on every allocated event loop
509after fork, and how you do this is entirely your own problem. 509after fork, and how you do this is entirely your own problem.
510
511=item int ev_is_default_loop (loop)
512
513Returns true when the given loop actually is the default loop, false otherwise.
510 514
511=item unsigned int ev_loop_count (loop) 515=item unsigned int ev_loop_count (loop)
512 516
513Returns the count of loop iterations for the loop, which is identical to 517Returns the count of loop iterations for the loop, which is identical to
514the number of times libev did poll for new events. It starts at C<0> and 518the number of times libev did poll for new events. It starts at C<0> and
… …
1152configure 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
1153exactly 10 second intervals. If, however, your program cannot keep up with 1157exactly 10 second intervals. If, however, your program cannot keep up with
1154the 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
1155timer will not fire more than once per event loop iteration. 1159timer will not fire more than once per event loop iteration.
1156 1160
1157=item ev_timer_again (loop) 1161=item ev_timer_again (loop, ev_timer *)
1158 1162
1159This 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
1160repeating. The exact semantics are: 1164repeating. The exact semantics are:
1161 1165
1162If the timer is pending, its pending status is cleared. 1166If the timer is pending, its pending status is cleared.
… …
1271In this configuration the watcher triggers an event at the wallclock time 1275In this configuration the watcher triggers an event at the wallclock time
1272C<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,
1273that 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
1274system time reaches or surpasses this time. 1278system time reaches or surpasses this time.
1275 1279
1276=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) 1280=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1277 1281
1278In 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
1279C<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)
1280and then repeat, regardless of any time jumps. 1284and then repeat, regardless of any time jumps.
1281 1285
… …
1431=item int signum [read-only] 1435=item int signum [read-only]
1432 1436
1433The signal the watcher watches out for. 1437The signal the watcher watches out for.
1434 1438
1435=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);
1436 1454
1437 1455
1438=head2 C<ev_child> - watch out for process status changes 1456=head2 C<ev_child> - watch out for process status changes
1439 1457
1440Child watchers trigger when your process receives a SIGCHLD in response to 1458Child watchers trigger when your process receives a SIGCHLD in response to
… …
1470The process exit/trace status caused by C<rpid> (see your systems 1488The process exit/trace status caused by C<rpid> (see your systems
1471C<waitpid> and C<sys/wait.h> documentation for details). 1489C<waitpid> and C<sys/wait.h> documentation for details).
1472 1490
1473=back 1491=back
1474 1492
1475=head3 Examples
1476
1477Example: Try to exit cleanly on SIGINT and SIGTERM.
1478
1479 static void
1480 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1481 {
1482 ev_unloop (loop, EVUNLOOP_ALL);
1483 }
1484
1485 struct ev_signal signal_watcher;
1486 ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1487 ev_signal_start (loop, &sigint_cb);
1488
1489 1493
1490=head2 C<ev_stat> - did the file attributes just change? 1494=head2 C<ev_stat> - did the file attributes just change?
1491 1495
1492This watches a filesystem path for attribute changes. That is, it calls 1496This watches a filesystem path for attribute changes. That is, it calls
1493C<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
… …
1572 1576
1573The 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,
1574relative 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
1575last change was detected). 1579last change was detected).
1576 1580
1577=item ev_stat_stat (ev_stat *) 1581=item ev_stat_stat (loop, ev_stat *)
1578 1582
1579Updates the stat buffer immediately with new values. If you change the 1583Updates the stat buffer immediately with new values. If you change the
1580watched path in your callback, you could call this fucntion to avoid 1584watched path in your callback, you could call this fucntion to avoid
1581detecting this change (while introducing a race condition). Can also be 1585detecting this change (while introducing a race condition). Can also be
1582useful simply to find out the new values. 1586useful simply to find out the new values.
… …
2098 { 2102 {
2099 sometype data; 2103 sometype data;
2100 2104
2101 // no locking etc. 2105 // no locking etc.
2102 queue_put (data); 2106 queue_put (data);
2103 ev_async_send (DEFAULT_ &mysig); 2107 ev_async_send (EV_DEFAULT_ &mysig);
2104 } 2108 }
2105 2109
2106 static void 2110 static void
2107 mysig_cb (EV_P_ ev_async *w, int revents) 2111 mysig_cb (EV_P_ ev_async *w, int revents)
2108 { 2112 {
… …
2139 // only need to lock the actual queueing operation 2143 // only need to lock the actual queueing operation
2140 pthread_mutex_lock (&mymutex); 2144 pthread_mutex_lock (&mymutex);
2141 queue_put (data); 2145 queue_put (data);
2142 pthread_mutex_unlock (&mymutex); 2146 pthread_mutex_unlock (&mymutex);
2143 2147
2144 ev_async_send (DEFAULT_ &mysig); 2148 ev_async_send (EV_DEFAULT_ &mysig);
2145 } 2149 }
2146 2150
2147 static void 2151 static void
2148 mysig_cb (EV_P_ ev_async *w, int revents) 2152 mysig_cb (EV_P_ ev_async *w, int revents)
2149 { 2153 {

Diff Legend

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