[ViewVC] Diff of: cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.131 by root, Tue Feb 19 17:09:28 2008 UTC vs.
Revision 1.134 by root, Sat Mar 8 07:04:56 2008 UTC

…		…
1156	configure a timer to trigger every 10 seconds, then it will trigger at	1156	configure a timer to trigger every 10 seconds, then it will trigger at
1157	exactly 10 second intervals. If, however, your program cannot keep up with	1157	exactly 10 second intervals. If, however, your program cannot keep up with
1158	the timer (because it takes longer than those 10 seconds to do stuff) the	1158	the timer (because it takes longer than those 10 seconds to do stuff) the
1159	timer will not fire more than once per event loop iteration.	1159	timer 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
1163	This will act as if the timer timed out and restart it again if it is	1163	This will act as if the timer timed out and restart it again if it is
1164	repeating. The exact semantics are:	1164	repeating. The exact semantics are:
1165		1165
1166	If the timer is pending, its pending status is cleared.	1166	If the timer is pending, its pending status is cleared.
…		…
1275	In this configuration the watcher triggers an event at the wallclock time	1275	In this configuration the watcher triggers an event at the wallclock time
1276	C<at> and doesn't repeat. It will not adjust when a time jump occurs,	1276	C<at> and doesn't repeat. It will not adjust when a time jump occurs,
1277	that is, if it is to be run at January 1st 2011 then it will run when the	1277	that is, if it is to be run at January 1st 2011 then it will run when the
1278	system time reaches or surpasses this time.	1278	system 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
1282	In this mode the watcher will always be scheduled to time out at the next	1282	In this mode the watcher will always be scheduled to time out at the next
1283	C<at + N * interval> time (for some integer N, which can also be negative)	1283	C<at + N * interval> time (for some integer N, which can also be negative)
1284	and then repeat, regardless of any time jumps.	1284	and then repeat, regardless of any time jumps.
1285		1285
…		…
1436		1436
1437	The signal the watcher watches out for.	1437	The signal the watcher watches out for.
1438		1438
1439	=back	1439	=back
1440		1440
		1441	=head3 Examples
		1442
		1443	Example: 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);
		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
1444	Child watchers trigger when your process receives a SIGCHLD in response to	1458	Child watchers trigger when your process receives a SIGCHLD in response to
1445	some child status changes (most typically when a child of yours dies).	1459	some child status changes (most typically when a child of yours dies). It
		1460	is permissible to install a child watcher I<after> the child has been
		1461	forked (which implies it might have already exited), as long as the event
		1462	loop isn't entered (or is continued from a watcher).
		1463
		1464	Only the default event loop is capable of handling signals, and therefore
		1465	you can only rgeister child watchers in the default event loop.
		1466
		1467	=head3 Process Interaction
		1468
		1469	Libev grabs C<SIGCHLD> as soon as the default event loop is
		1470	initialised. This is necessary to guarantee proper behaviour even if
		1471	the first child watcher is started after the child exits. The occurance
		1472	of C<SIGCHLD> is recorded asynchronously, but child reaping is done
		1473	synchronously as part of the event loop processing. Libev always reaps all
		1474	children, even ones not watched.
		1475
		1476	=head3 Overriding the Built-In Processing
		1477
		1478	Libev offers no special support for overriding the built-in child
		1479	processing, but if your application collides with libev's default child
		1480	handler, you can override it easily by installing your own handler for
		1481	C<SIGCHLD> after initialising the default loop, and making sure the
		1482	default loop never gets destroyed. You are encouraged, however, to use an
		1483	event-based approach to child reaping and thus use libev's support for
		1484	that, so other libev users can use C<ev_child> watchers freely.
1446		1485
1447	=head3 Watcher-Specific Functions and Data Members	1486	=head3 Watcher-Specific Functions and Data Members
1448		1487
1449	=over 4	1488	=over 4
1450		1489
…		…
1476		1515
1477	=back	1516	=back
1478		1517
1479	=head3 Examples	1518	=head3 Examples
1480		1519
1481	Example: Try to exit cleanly on SIGINT and SIGTERM.	1520	Example: C<fork()> a new process and install a child handler to wait for
		1521	its completion.
		1522
		1523	ev_child cw;
1482		1524
1483	static void	1525	static void
1484	sigint_cb (struct ev_loop loop, struct ev_signal w, int revents)	1526	child_cb (EV_P_ struct ev_child *w, int revents)
1485	{	1527	{
1486	ev_unloop (loop, EVUNLOOP_ALL);	1528	ev_child_stop (EV_A_ w);
		1529	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);
1487	}	1530	}
1488		1531
1489	struct ev_signal signal_watcher;	1532	pid_t pid = fork ();
1490	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	1533
1491	ev_signal_start (loop, &sigint_cb);	1534	if (pid < 0)
		1535	// error
		1536	else if (pid == 0)
		1537	{
		1538	// the forked child executes here
		1539	exit (1);
		1540	}
		1541	else
		1542	{
		1543	ev_child_init (&cw, child_cb, pid, 0);
		1544	ev_child_start (EV_DEFAULT_ &cw);
		1545	}
1492		1546
1493		1547
1494	=head2 C<ev_stat> - did the file attributes just change?	1548	=head2 C<ev_stat> - did the file attributes just change?
1495		1549
1496	This watches a filesystem path for attribute changes. That is, it calls	1550	This watches a filesystem path for attribute changes. That is, it calls
…		…
1576		1630
1577	The callback will be receive C<EV_STAT> when a change was detected,	1631	The callback will be receive C<EV_STAT> when a change was detected,
1578	relative to the attributes at the time the watcher was started (or the	1632	relative to the attributes at the time the watcher was started (or the
1579	last change was detected).	1633	last change was detected).
1580		1634
1581	=item ev_stat_stat (ev_stat *)	1635	=item ev_stat_stat (loop, ev_stat *)
1582		1636
1583	Updates the stat buffer immediately with new values. If you change the	1637	Updates the stat buffer immediately with new values. If you change the
1584	watched path in your callback, you could call this fucntion to avoid	1638	watched path in your callback, you could call this fucntion to avoid
1585	detecting this change (while introducing a race condition). Can also be	1639	detecting this change (while introducing a race condition). Can also be
1586	useful simply to find out the new values.	1640	useful simply to find out the new values.
…		…
2102	{	2156	{
2103	sometype data;	2157	sometype data;
2104		2158
2105	// no locking etc.	2159	// no locking etc.
2106	queue_put (data);	2160	queue_put (data);
2107	ev_async_send (DEFAULT_ &mysig);	2161	ev_async_send (EV_DEFAULT_ &mysig);
2108	}	2162	}
2109		2163
2110	static void	2164	static void
2111	mysig_cb (EV_P_ ev_async *w, int revents)	2165	mysig_cb (EV_P_ ev_async *w, int revents)
2112	{	2166	{
…		…
2143	// only need to lock the actual queueing operation	2197	// only need to lock the actual queueing operation
2144	pthread_mutex_lock (&mymutex);	2198	pthread_mutex_lock (&mymutex);
2145	queue_put (data);	2199	queue_put (data);
2146	pthread_mutex_unlock (&mymutex);	2200	pthread_mutex_unlock (&mymutex);
2147		2201
2148	ev_async_send (DEFAULT_ &mysig);	2202	ev_async_send (EV_DEFAULT_ &mysig);
2149	}	2203	}
2150		2204
2151	static void	2205	static void
2152	mysig_cb (EV_P_ ev_async *w, int revents)	2206	mysig_cb (EV_P_ ev_async *w, int revents)
2153	{	2207	{

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.131 by root, Tue Feb 19 17:09:28 2008 UTC vs. Revision 1.134 by root, Sat Mar 8 07:04:56 2008 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.131 by root, Tue Feb 19 17:09:28 2008 UTC vs.
Revision 1.134 by root, Sat Mar 8 07:04:56 2008 UTC