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

Comparing libev/ev.html (file contents):
Revision 1.22 by root, Mon Nov 12 09:02:16 2007 UTC vs.
Revision 1.23 by root, Mon Nov 12 09:06:09 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="Mon Nov 12 10:02:16 2007" /> 9 <meta name="created" content="Mon Nov 12 10:06:08 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 -->
… …
35<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> 35<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>
36<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> 36<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>
37</ul> 37</ul>
38</li> 38</li>
39<li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li> 39<li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li>
40<li><a href="#LIBEVENT_EMULATION">LIBEVENT EMULATION</a></li>
41<li><a href="#C_SUPPORT">C++ SUPPORT</a></li>
40<li><a href="#AUTHOR">AUTHOR</a> 42<li><a href="#AUTHOR">AUTHOR</a>
41</li> 43</li>
42</ul><hr /> 44</ul><hr />
43<!-- INDEX END --> 45<!-- INDEX END -->
44 46
… …
674 676
675</div> 677</div>
676<h2 id="code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</h2> 678<h2 id="code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</h2>
677<div id="code_ev_prepare_code_and_code_ev_che-2"> 679<div id="code_ev_prepare_code_and_code_ev_che-2">
678<p>Prepare and check watchers are usually (but not always) used in tandem: 680<p>Prepare and check watchers are usually (but not always) used in tandem:
679Prepare watchers get invoked before the process blocks and check watchers 681prepare watchers get invoked before the process blocks and check watchers
680afterwards.</p> 682afterwards.</p>
681<p>Their main purpose is to integrate other event mechanisms into libev. This 683<p>Their main purpose is to integrate other event mechanisms into libev. This
682could be used, for example, to track variable changes, implement your own 684could be used, for example, to track variable changes, implement your own
683watchers, integrate net-snmp or a coroutine library and lots more.</p> 685watchers, integrate net-snmp or a coroutine library and lots more.</p>
684<p>This is done by examining in each prepare call which file descriptors need 686<p>This is done by examining in each prepare call which file descriptors need
685to be watched by the other library, registering <code>ev_io</code> watchers for 687to be watched by the other library, registering <code>ev_io</code> watchers for
686them and starting an <code>ev_timer</code> watcher for any timeouts (many libraries 688them and starting an <code>ev_timer</code> watcher for any timeouts (many libraries
687provide just this functionality). Then, in the check watcher you check for 689provide just this functionality). Then, in the check watcher you check for
688any events that occured (by checking the pending status of all watchers 690any events that occured (by checking the pending status of all watchers
689and stopping them) and call back into the library. The I/O and timer 691and stopping them) and call back into the library. The I/O and timer
690callbacks will never actually be called (but must be valid neverthelles, 692callbacks will never actually be called (but must be valid nevertheless,
691because you never know, you know?).</p> 693because you never know, you know?).</p>
692<p>As another example, the Perl Coro module uses these hooks to integrate 694<p>As another example, the Perl Coro module uses these hooks to integrate
693coroutines into libev programs, by yielding to other active coroutines 695coroutines into libev programs, by yielding to other active coroutines
694during each prepare and only letting the process block if no coroutines 696during each prepare and only letting the process block if no coroutines
695are ready to run (its actually more complicated, it only runs coroutines 697are ready to run (it's actually more complicated: it only runs coroutines
696with priority higher than the event loop and one lower priority once, 698with priority higher than or equal to the event loop and one coroutine
697using idle watchers to keep the event loop from blocking if lower-priority 699of lower priority, but only once, using idle watchers to keep the event
698coroutines exist, thus mapping low-priority coroutines to idle/background 700loop from blocking if lower-priority coroutines are active, thus mapping
699tasks).</p> 701low-priority coroutines to idle/background tasks).</p>
700<dl> 702<dl>
701 <dt>ev_prepare_init (ev_prepare *, callback)</dt> 703 <dt>ev_prepare_init (ev_prepare *, callback)</dt>
702 <dt>ev_check_init (ev_check *, callback)</dt> 704 <dt>ev_check_init (ev_check *, callback)</dt>
703 <dd> 705 <dd>
704 <p>Initialises and configures the prepare or check watcher - they have no 706 <p>Initialises and configures the prepare or check watcher - they have no
… …
758 <p>Feed an event as if the given signal occured (loop must be the default loop!).</p> 760 <p>Feed an event as if the given signal occured (loop must be the default loop!).</p>
759 </dd> 761 </dd>
760</dl> 762</dl>
761 763
762</div> 764</div>
765<h1 id="LIBEVENT_EMULATION">LIBEVENT EMULATION</h1><p><a href="#TOP" class="toplink">Top</a></p>
766<div id="LIBEVENT_EMULATION_CONTENT">
767<p>TBD.</p>
768
769</div>
770<h1 id="C_SUPPORT">C++ SUPPORT</h1><p><a href="#TOP" class="toplink">Top</a></p>
771<div id="C_SUPPORT_CONTENT">
772<p>TBD.</p>
773
774</div>
763<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p> 775<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
764<div id="AUTHOR_CONTENT"> 776<div id="AUTHOR_CONTENT">
765<p>Marc Lehmann &lt;libev@schmorp.de&gt;.</p> 777<p>Marc Lehmann &lt;libev@schmorp.de&gt;.</p>
766 778
767</div> 779</div>

Diff Legend

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