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

Comparing libev/ev.html (file contents):
Revision 1.67 by root, Fri Dec 7 19:23:48 2007 UTC vs.
Revision 1.68 by root, Fri Dec 7 20:13: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="Fri Dec 7 20:23:46 2007" /> 9 <meta name="created" content="Fri Dec 7 21:13:07 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 -->
… …
1736the callback model to a model using method callbacks on objects.</p> 1736the callback model to a model using method callbacks on objects.</p>
1737<p>To use it,</p> 1737<p>To use it,</p>
1738<pre> #include &lt;ev++.h&gt; 1738<pre> #include &lt;ev++.h&gt;
1739 1739
1740</pre> 1740</pre>
1741<p>(it is not installed by default). This automatically includes <cite>ev.h</cite> 1741<p>This automatically includes <cite>ev.h</cite> and puts all of its definitions (many
1742and puts all of its definitions (many of them macros) into the global 1742of them macros) into the global namespace. All C++ specific things are
1743namespace. All C++ specific things are put into the <code>ev</code> namespace.</p> 1743put into the <code>ev</code> namespace. It should support all the same embedding
1744<p>It should support all the same embedding options as <cite>ev.h</cite>, most notably 1744options as <cite>ev.h</cite>, most notably <code>EV_MULTIPLICITY</code>.</p>
1745<code>EV_MULTIPLICITY</code>.</p> 1745<p>Care has been taken to keep the overhead low. The only data member added
1746to the C-style watchers is the event loop the watcher is associated with
1747(or no additional members at all if you disable <code>EV_MULTIPLICITY</code> when
1748embedding libev).</p>
1749<p>Currently, functions and static and non-static member functions can be
1750used as callbacks. Other types should be easy to add as long as they only
1751need one additional pointer for context. If you need support for other
1752types of functors please contact the author (preferably after implementing
1753it).</p>
1746<p>Here is a list of things available in the <code>ev</code> namespace:</p> 1754<p>Here is a list of things available in the <code>ev</code> namespace:</p>
1747<dl> 1755<dl>
1748 <dt><code>ev::READ</code>, <code>ev::WRITE</code> etc.</dt> 1756 <dt><code>ev::READ</code>, <code>ev::WRITE</code> etc.</dt>
1749 <dd> 1757 <dd>
1750 <p>These are just enum values with the same values as the <code>EV_READ</code> etc. 1758 <p>These are just enum values with the same values as the <code>EV_READ</code> etc.
… …
1761which is called <code>ev::sig</code> to avoid clashes with the <code>signal</code> macro 1769which is called <code>ev::sig</code> to avoid clashes with the <code>signal</code> macro
1762defines by many implementations.</p> 1770defines by many implementations.</p>
1763 <p>All of those classes have these methods:</p> 1771 <p>All of those classes have these methods:</p>
1764 <p> 1772 <p>
1765 <dl> 1773 <dl>
1766 <dt>ev::TYPE::TYPE (object *, object::method *)</dt> 1774 <dt>ev::TYPE::TYPE ()</dt>
1767 <dt>ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)</dt> 1775 <dt>ev::TYPE::TYPE (struct ev_loop *)</dt>
1768 <dt>ev::TYPE::~TYPE</dt> 1776 <dt>ev::TYPE::~TYPE</dt>
1769 <dd> 1777 <dd>
1770 <p>The constructor takes a pointer to an object and a method pointer to 1778 <p>The constructor (optionally) takes an event loop to associate the watcher
1771the event handler callback to call in this class. The constructor calls 1779with. If it is omitted, it will use <code>EV_DEFAULT</code>.</p>
1772<code>ev_init</code> for you, which means you have to call the <code>set</code> method 1780 <p>The constructor calls <code>ev_init</code> for you, which means you have to call the
1773before starting it. If you do not specify a loop then the constructor 1781<code>set</code> method before starting it.</p>
1774automatically associates the default loop with this watcher.</p> 1782 <p>It will not set a callback, however: You have to call the templated <code>set</code>
1783method to set a callback before you can start the watcher.</p>
1784 <p>(The reason why you have to use a method is a limitation in C++ which does
1785not allow explicit template arguments for constructors).</p>
1775 <p>The destructor automatically stops the watcher if it is active.</p> 1786 <p>The destructor automatically stops the watcher if it is active.</p>
1787 </dd>
1788 <dt>w-&gt;set&lt;class, &amp;class::method&gt; (object *)</dt>
1789 <dd>
1790 <p>This method sets the callback method to call. The method has to have a
1791signature of <code>void (*)(ev_TYPE &amp;, int)</code>, it receives the watcher as
1792first argument and the <code>revents</code> as second. The object must be given as
1793parameter and is stored in the <code>data</code> member of the watcher.</p>
1794 <p>This method synthesizes efficient thunking code to call your method from
1795the C callback that libev requires. If your compiler can inline your
1796callback (i.e. it is visible to it at the place of the <code>set</code> call and
1797your compiler is good :), then the method will be fully inlined into the
1798thunking function, making it as fast as a direct C callback.</p>
1799 <p>Example: simple class declaration and watcher initialisation</p>
1800<pre> struct myclass
1801 {
1802 void io_cb (ev::io &amp;w, int revents) { }
1803 }
1804
1805 myclass obj;
1806 ev::io iow;
1807 iow.set &lt;myclass, &amp;myclass::io_cb&gt; (&amp;obj);
1808
1809</pre>
1810 </dd>
1811 <dt>w-&gt;set (void (*function)(watcher &amp;w, int), void *data = 0)</dt>
1812 <dd>
1813 <p>Also sets a callback, but uses a static method or plain function as
1814callback. The optional <code>data</code> argument will be stored in the watcher's
1815<code>data</code> member and is free for you to use.</p>
1816 <p>See the method-<code>set</code> above for more details.</p>
1776 </dd> 1817 </dd>
1777 <dt>w-&gt;set (struct ev_loop *)</dt> 1818 <dt>w-&gt;set (struct ev_loop *)</dt>
1778 <dd> 1819 <dd>
1779 <p>Associates a different <code>struct ev_loop</code> with this watcher. You can only 1820 <p>Associates a different <code>struct ev_loop</code> with this watcher. You can only
1780do this when the watcher is inactive (and not pending either).</p> 1821do this when the watcher is inactive (and not pending either).</p>
1781 </dd> 1822 </dd>
1782 <dt>w-&gt;set ([args])</dt> 1823 <dt>w-&gt;set ([args])</dt>
1783 <dd> 1824 <dd>
1784 <p>Basically the same as <code>ev_TYPE_set</code>, with the same args. Must be 1825 <p>Basically the same as <code>ev_TYPE_set</code>, with the same args. Must be
1785called at least once. Unlike the C counterpart, an active watcher gets 1826called at least once. Unlike the C counterpart, an active watcher gets
1786automatically stopped and restarted.</p> 1827automatically stopped and restarted when reconfiguring it with this
1828method.</p>
1787 </dd> 1829 </dd>
1788 <dt>w-&gt;start ()</dt> 1830 <dt>w-&gt;start ()</dt>
1789 <dd> 1831 <dd>
1790 <p>Starts the watcher. Note that there is no <code>loop</code> argument as the 1832 <p>Starts the watcher. Note that there is no <code>loop</code> argument, as the
1791constructor already takes the loop.</p> 1833constructor already stores the event loop.</p>
1792 </dd> 1834 </dd>
1793 <dt>w-&gt;stop ()</dt> 1835 <dt>w-&gt;stop ()</dt>
1794 <dd> 1836 <dd>
1795 <p>Stops the watcher if it is active. Again, no <code>loop</code> argument.</p> 1837 <p>Stops the watcher if it is active. Again, no <code>loop</code> argument.</p>
1796 </dd> 1838 </dd>
… …
1820 1862
1821 myclass (); 1863 myclass ();
1822 } 1864 }
1823 1865
1824 myclass::myclass (int fd) 1866 myclass::myclass (int fd)
1825 : io (this, &amp;myclass::io_cb),
1826 idle (this, &amp;myclass::idle_cb)
1827 { 1867 {
1868 io .set &lt;myclass, &amp;myclass::io_cb &gt; (this);
1869 idle.set &lt;myclass, &amp;myclass::idle_cb&gt; (this);
1870
1828 io.start (fd, ev::READ); 1871 io.start (fd, ev::READ);
1829 } 1872 }
1830 1873
1831 1874
1832 1875

Diff Legend

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