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

Comparing libev/ev.html (file contents):
Revision 1.77 by root, Wed Dec 12 04:53:58 2007 UTC vs.
Revision 1.78 by root, Wed Dec 12 17:55:06 2007 UTC

… …
4<head> 4<head>
5 <title>libev</title> 5 <title>libev</title>
6 <meta name="description" content="Pod documentation for libev" /> 6 <meta name="description" content="Pod documentation for libev" />
7 <meta name="inputfile" content="&lt;standard input&gt;" /> 7 <meta name="inputfile" content="&lt;standard input&gt;" />
8 <meta name="outputfile" content="&lt;standard output&gt;" /> 8 <meta name="outputfile" content="&lt;standard output&gt;" />
9 <meta name="created" content="Wed Dec 12 05:53:55 2007" /> 9 <meta name="created" content="Wed Dec 12 18:55:04 2007" />
10 <meta name="generator" content="Pod::Xhtml 1.57" /> 10 <meta name="generator" content="Pod::Xhtml 1.57" />
11<link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head> 11<link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head>
12<body> 12<body>
13<div class="pod"> 13<div class="pod">
14<!-- INDEX START --> 14<!-- INDEX START -->
… …
29</ul> 29</ul>
30</li> 30</li>
31<li><a href="#WATCHER_TYPES">WATCHER TYPES</a> 31<li><a href="#WATCHER_TYPES">WATCHER TYPES</a>
32<ul><li><a href="#code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable?</a> 32<ul><li><a href="#code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable?</a>
33<ul><li><a href="#The_special_problem_of_disappearing_">The special problem of disappearing file descriptors</a></li> 33<ul><li><a href="#The_special_problem_of_disappearing_">The special problem of disappearing file descriptors</a></li>
34<li><a href="#Watcher_Specific_Functions">Watcher-Specific Functions</a></li>
34</ul> 35</ul>
35</li> 36</li>
36<li><a href="#code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally repeating timeouts</a></li> 37<li><a href="#code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally repeating timeouts</a>
38<ul><li><a href="#Watcher_Specific_Functions_and_Data_">Watcher-Specific Functions and Data Members</a></li>
39</ul>
40</li>
37<li><a href="#code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron?</a></li> 41<li><a href="#code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron?</a>
42<ul><li><a href="#Watcher_Specific_Functions_and_Data_-3">Watcher-Specific Functions and Data Members</a></li>
43</ul>
44</li>
38<li><a href="#code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled!</a></li> 45<li><a href="#code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled!</a>
46<ul><li><a href="#Watcher_Specific_Functions_and_Data_-4">Watcher-Specific Functions and Data Members</a></li>
47</ul>
48</li>
39<li><a href="#code_ev_child_code_watch_out_for_pro"><code>ev_child</code> - watch out for process status changes</a></li> 49<li><a href="#code_ev_child_code_watch_out_for_pro"><code>ev_child</code> - watch out for process status changes</a>
50<ul><li><a href="#Watcher_Specific_Functions_and_Data_-5">Watcher-Specific Functions and Data Members</a></li>
51</ul>
52</li>
40<li><a href="#code_ev_stat_code_did_the_file_attri"><code>ev_stat</code> - did the file attributes just change?</a></li> 53<li><a href="#code_ev_stat_code_did_the_file_attri"><code>ev_stat</code> - did the file attributes just change?</a>
54<ul><li><a href="#Watcher_Specific_Functions_and_Data_-6">Watcher-Specific Functions and Data Members</a></li>
55</ul>
56</li>
41<li><a href="#code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do...</a></li> 57<li><a href="#code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do...</a>
58<ul><li><a href="#Watcher_Specific_Functions_and_Data_-7">Watcher-Specific Functions and Data Members</a></li>
59</ul>
60</li>
42<li><a href="#code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop!</a></li> 61<li><a href="#code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop!</a>
62<ul><li><a href="#Watcher_Specific_Functions_and_Data_-8">Watcher-Specific Functions and Data Members</a></li>
63</ul>
64</li>
43<li><a href="#code_ev_embed_code_when_one_backend_"><code>ev_embed</code> - when one backend isn't enough...</a></li> 65<li><a href="#code_ev_embed_code_when_one_backend_"><code>ev_embed</code> - when one backend isn't enough...</a>
66<ul><li><a href="#Watcher_Specific_Functions_and_Data_-9">Watcher-Specific Functions and Data Members</a></li>
67</ul>
68</li>
44<li><a href="#code_ev_fork_code_the_audacity_to_re"><code>ev_fork</code> - the audacity to resume the event loop after a fork</a></li> 69<li><a href="#code_ev_fork_code_the_audacity_to_re"><code>ev_fork</code> - the audacity to resume the event loop after a fork</a></li>
45</ul> 70</ul>
46</li> 71</li>
47<li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li> 72<li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li>
48<li><a href="#LIBEVENT_EMULATION">LIBEVENT EMULATION</a></li> 73<li><a href="#LIBEVENT_EMULATION">LIBEVENT EMULATION</a></li>
… …
968optimisations to libev.</p> 993optimisations to libev.</p>
969 994
970 995
971 996
972 997
998
999</div>
1000<h3 id="Watcher_Specific_Functions">Watcher-Specific Functions</h3>
1001<div id="Watcher_Specific_Functions_CONTENT">
973<dl> 1002<dl>
974 <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt> 1003 <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt>
975 <dt>ev_io_set (ev_io *, int fd, int events)</dt> 1004 <dt>ev_io_set (ev_io *, int fd, int events)</dt>
976 <dd> 1005 <dd>
977 <p>Configures an <code>ev_io</code> watcher. The <code>fd</code> is the file descriptor to 1006 <p>Configures an <code>ev_io</code> watcher. The <code>fd</code> is the file descriptor to
… …
1028 1057
1029</pre> 1058</pre>
1030<p>The callback is guarenteed to be invoked only when its timeout has passed, 1059<p>The callback is guarenteed to be invoked only when its timeout has passed,
1031but if multiple timers become ready during the same loop iteration then 1060but if multiple timers become ready during the same loop iteration then
1032order of execution is undefined.</p> 1061order of execution is undefined.</p>
1062
1063</div>
1064<h3 id="Watcher_Specific_Functions_and_Data_">Watcher-Specific Functions and Data Members</h3>
1065<div id="Watcher_Specific_Functions_and_Data_-2">
1033<dl> 1066<dl>
1034 <dt>ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)</dt> 1067 <dt>ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)</dt>
1035 <dt>ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)</dt> 1068 <dt>ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)</dt>
1036 <dd> 1069 <dd>
1037 <p>Configure the timer to trigger after <code>after</code> seconds. If <code>repeat</code> is 1070 <p>Configure the timer to trigger after <code>after</code> seconds. If <code>repeat</code> is
… …
1133triggering an event on each midnight, local time or other, complicated, 1166triggering an event on each midnight, local time or other, complicated,
1134rules.</p> 1167rules.</p>
1135<p>As with timers, the callback is guarenteed to be invoked only when the 1168<p>As with timers, the callback is guarenteed to be invoked only when the
1136time (<code>at</code>) has been passed, but if multiple periodic timers become ready 1169time (<code>at</code>) has been passed, but if multiple periodic timers become ready
1137during the same loop iteration then order of execution is undefined.</p> 1170during the same loop iteration then order of execution is undefined.</p>
1171
1172</div>
1173<h3 id="Watcher_Specific_Functions_and_Data_-3">Watcher-Specific Functions and Data Members</h3>
1174<div id="Watcher_Specific_Functions_and_Data_-2">
1138<dl> 1175<dl>
1139 <dt>ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)</dt> 1176 <dt>ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)</dt>
1140 <dt>ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)</dt> 1177 <dt>ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)</dt>
1141 <dd> 1178 <dd>
1142 <p>Lots of arguments, lets sort it out... There are basically three modes of 1179 <p>Lots of arguments, lets sort it out... There are basically three modes of
… …
1279first watcher gets started will libev actually register a signal watcher 1316first watcher gets started will libev actually register a signal watcher
1280with the kernel (thus it coexists with your own signal handlers as long 1317with the kernel (thus it coexists with your own signal handlers as long
1281as you don't register any with libev). Similarly, when the last signal 1318as you don't register any with libev). Similarly, when the last signal
1282watcher for a signal is stopped libev will reset the signal handler to 1319watcher for a signal is stopped libev will reset the signal handler to
1283SIG_DFL (regardless of what it was set to before).</p> 1320SIG_DFL (regardless of what it was set to before).</p>
1321
1322</div>
1323<h3 id="Watcher_Specific_Functions_and_Data_-4">Watcher-Specific Functions and Data Members</h3>
1324<div id="Watcher_Specific_Functions_and_Data_-2-2">
1284<dl> 1325<dl>
1285 <dt>ev_signal_init (ev_signal *, callback, int signum)</dt> 1326 <dt>ev_signal_init (ev_signal *, callback, int signum)</dt>
1286 <dt>ev_signal_set (ev_signal *, int signum)</dt> 1327 <dt>ev_signal_set (ev_signal *, int signum)</dt>
1287 <dd> 1328 <dd>
1288 <p>Configures the watcher to trigger on the given signal number (usually one 1329 <p>Configures the watcher to trigger on the given signal number (usually one
… …
1301</div> 1342</div>
1302<h2 id="code_ev_child_code_watch_out_for_pro"><code>ev_child</code> - watch out for process status changes</h2> 1343<h2 id="code_ev_child_code_watch_out_for_pro"><code>ev_child</code> - watch out for process status changes</h2>
1303<div id="code_ev_child_code_watch_out_for_pro-2"> 1344<div id="code_ev_child_code_watch_out_for_pro-2">
1304<p>Child watchers trigger when your process receives a SIGCHLD in response to 1345<p>Child watchers trigger when your process receives a SIGCHLD in response to
1305some child status changes (most typically when a child of yours dies).</p> 1346some child status changes (most typically when a child of yours dies).</p>
1347
1348</div>
1349<h3 id="Watcher_Specific_Functions_and_Data_-5">Watcher-Specific Functions and Data Members</h3>
1350<div id="Watcher_Specific_Functions_and_Data_-2-3">
1306<dl> 1351<dl>
1307 <dt>ev_child_init (ev_child *, callback, int pid)</dt> 1352 <dt>ev_child_init (ev_child *, callback, int pid)</dt>
1308 <dt>ev_child_set (ev_child *, int pid)</dt> 1353 <dt>ev_child_set (ev_child *, int pid)</dt>
1309 <dd> 1354 <dd>
1310 <p>Configures the watcher to wait for status changes of process <code>pid</code> (or 1355 <p>Configures the watcher to wait for status changes of process <code>pid</code> (or
… …
1373reader). Inotify will be used to give hints only and should not change the 1418reader). Inotify will be used to give hints only and should not change the
1374semantics of <code>ev_stat</code> watchers, which means that libev sometimes needs 1419semantics of <code>ev_stat</code> watchers, which means that libev sometimes needs
1375to fall back to regular polling again even with inotify, but changes are 1420to fall back to regular polling again even with inotify, but changes are
1376usually detected immediately, and if the file exists there will be no 1421usually detected immediately, and if the file exists there will be no
1377polling.</p> 1422polling.</p>
1423
1424</div>
1425<h3 id="Watcher_Specific_Functions_and_Data_-6">Watcher-Specific Functions and Data Members</h3>
1426<div id="Watcher_Specific_Functions_and_Data_-2-4">
1378<dl> 1427<dl>
1379 <dt>ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)</dt> 1428 <dt>ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)</dt>
1380 <dt>ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)</dt> 1429 <dt>ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)</dt>
1381 <dd> 1430 <dd>
1382 <p>Configures the watcher to wait for status changes of the given 1431 <p>Configures the watcher to wait for status changes of the given
… …
1460active, the process will not block when waiting for new events.</p> 1509active, the process will not block when waiting for new events.</p>
1461<p>Apart from keeping your process non-blocking (which is a useful 1510<p>Apart from keeping your process non-blocking (which is a useful
1462effect on its own sometimes), idle watchers are a good place to do 1511effect on its own sometimes), idle watchers are a good place to do
1463&quot;pseudo-background processing&quot;, or delay processing stuff to after the 1512&quot;pseudo-background processing&quot;, or delay processing stuff to after the
1464event loop has handled all outstanding events.</p> 1513event loop has handled all outstanding events.</p>
1514
1515</div>
1516<h3 id="Watcher_Specific_Functions_and_Data_-7">Watcher-Specific Functions and Data Members</h3>
1517<div id="Watcher_Specific_Functions_and_Data_-2-5">
1465<dl> 1518<dl>
1466 <dt>ev_idle_init (ev_signal *, callback)</dt> 1519 <dt>ev_idle_init (ev_signal *, callback)</dt>
1467 <dd> 1520 <dd>
1468 <p>Initialises and configures the idle watcher - it has no parameters of any 1521 <p>Initialises and configures the idle watcher - it has no parameters of any
1469kind. There is a <code>ev_idle_set</code> macro, but using it is utterly pointless, 1522kind. There is a <code>ev_idle_set</code> macro, but using it is utterly pointless,
… …
1532supports this, they will be called before other <code>ev_check</code> watchers did 1585supports this, they will be called before other <code>ev_check</code> watchers did
1533their job. As <code>ev_check</code> watchers are often used to embed other event 1586their job. As <code>ev_check</code> watchers are often used to embed other event
1534loops those other event loops might be in an unusable state until their 1587loops those other event loops might be in an unusable state until their
1535<code>ev_check</code> watcher ran (always remind yourself to coexist peacefully with 1588<code>ev_check</code> watcher ran (always remind yourself to coexist peacefully with
1536others).</p> 1589others).</p>
1590
1591</div>
1592<h3 id="Watcher_Specific_Functions_and_Data_-8">Watcher-Specific Functions and Data Members</h3>
1593<div id="Watcher_Specific_Functions_and_Data_-2-6">
1537<dl> 1594<dl>
1538 <dt>ev_prepare_init (ev_prepare *, callback)</dt> 1595 <dt>ev_prepare_init (ev_prepare *, callback)</dt>
1539 <dt>ev_check_init (ev_check *, callback)</dt> 1596 <dt>ev_check_init (ev_check *, callback)</dt>
1540 <dd> 1597 <dd>
1541 <p>Initialises and configures the prepare or check watcher - they have no 1598 <p>Initialises and configures the prepare or check watcher - they have no
… …
1733 } 1790 }
1734 else 1791 else
1735 loop_lo = loop_hi; 1792 loop_lo = loop_hi;
1736 1793
1737</pre> 1794</pre>
1795
1796</div>
1797<h3 id="Watcher_Specific_Functions_and_Data_-9">Watcher-Specific Functions and Data Members</h3>
1798<div id="Watcher_Specific_Functions_and_Data_-2-7">
1738<dl> 1799<dl>
1739 <dt>ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)</dt> 1800 <dt>ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)</dt>
1740 <dt>ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)</dt> 1801 <dt>ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)</dt>
1741 <dd> 1802 <dd>
1742 <p>Configures the watcher to embed the given loop, which must be 1803 <p>Configures the watcher to embed the given loop, which must be

Diff Legend

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