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

Comparing libev/ev.3 (file contents):
Revision 1.38 by root, Fri Dec 7 18:09:38 2007 UTC vs.
Revision 1.45 by root, Sat Dec 8 22:11:14 2007 UTC

127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title ""<STANDARD INPUT>" 1" 131.IX Title ""<STANDARD INPUT>" 1"
132.TH "<STANDARD INPUT>" 1 "2007-12-07" "perl v5.8.8" "User Contributed Perl Documentation" 132.TH "<STANDARD INPUT>" 1 "2007-12-08" "perl v5.8.8" "User Contributed Perl Documentation"
133.SH "NAME" 133.SH "NAME"
134libev \- a high performance full\-featured event loop written in C 134libev \- a high performance full\-featured event loop written in C
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137.Vb 1 137.Vb 1
196\& return 0; 196\& return 0;
197\& } 197\& }
198.Ve 198.Ve
199.SH "DESCRIPTION" 199.SH "DESCRIPTION"
200.IX Header "DESCRIPTION" 200.IX Header "DESCRIPTION"
201The newest version of this document is also available as a html-formatted
202web page you might find easier to navigate when reading it for the first
203time: <http://cvs.schmorp.de/libev/ev.html>.
204.PP
201Libev is an event loop: you register interest in certain events (such as a 205Libev is an event loop: you register interest in certain events (such as a
202file descriptor being readable or a timeout occuring), and it will manage 206file descriptor being readable or a timeout occuring), and it will manage
203these event sources and provide your program with events. 207these event sources and provide your program with events.
204.PP 208.PP
205To do this, it must take more or less complete control over your process 209To do this, it must take more or less complete control over your process
630libev watchers. However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is 634libev watchers. However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is
631usually a better approach for this kind of thing. 635usually a better approach for this kind of thing.
632.Sp 636.Sp
633Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does: 637Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does:
634.Sp 638.Sp
635.Vb 18 639.Vb 19
640\& - Before the first iteration, call any pending watchers.
636\& * If there are no active watchers (reference count is zero), return. 641\& * If there are no active watchers (reference count is zero), return.
637\& - Queue prepare watchers and then call all outstanding watchers. 642\& - Queue all prepare watchers and then call all outstanding watchers.
638\& - If we have been forked, recreate the kernel state. 643\& - If we have been forked, recreate the kernel state.
639\& - Update the kernel state with all outstanding changes. 644\& - Update the kernel state with all outstanding changes.
640\& - Update the "event loop time". 645\& - Update the "event loop time".
641\& - Calculate for how long to block. 646\& - Calculate for how long to block.
642\& - Block the process, waiting for any events. 647\& - Block the process, waiting for any events.
885.IP "bool ev_is_pending (ev_TYPE *watcher)" 4 890.IP "bool ev_is_pending (ev_TYPE *watcher)" 4
886.IX Item "bool ev_is_pending (ev_TYPE *watcher)" 891.IX Item "bool ev_is_pending (ev_TYPE *watcher)"
887Returns a true value iff the watcher is pending, (i.e. it has outstanding 892Returns a true value iff the watcher is pending, (i.e. it has outstanding
888events but its callback has not yet been invoked). As long as a watcher 893events but its callback has not yet been invoked). As long as a watcher
889is pending (but not active) you must not call an init function on it (but 894is pending (but not active) you must not call an init function on it (but
890\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe) and you must make sure the watcher is available to 895\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe), you must not change its priority, and you must
891libev (e.g. you cnanot \f(CW\*(C`free ()\*(C'\fR it). 896make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR
897it).
892.IP "callback ev_cb (ev_TYPE *watcher)" 4 898.IP "callback ev_cb (ev_TYPE *watcher)" 4
893.IX Item "callback ev_cb (ev_TYPE *watcher)" 899.IX Item "callback ev_cb (ev_TYPE *watcher)"
894Returns the callback currently set on the watcher. 900Returns the callback currently set on the watcher.
895.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 901.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4
896.IX Item "ev_cb_set (ev_TYPE *watcher, callback)" 902.IX Item "ev_cb_set (ev_TYPE *watcher, callback)"
914watchers on the same event and make sure one is called first. 920watchers on the same event and make sure one is called first.
915.Sp 921.Sp
916If you need to suppress invocation when higher priority events are pending 922If you need to suppress invocation when higher priority events are pending
917you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality. 923you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality.
918.Sp 924.Sp
925You \fImust not\fR change the priority of a watcher as long as it is active or
926pending.
927.Sp
919The default priority used by watchers when no priority has been set is 928The default priority used by watchers when no priority has been set is
920always \f(CW0\fR, which is supposed to not be too high and not be too low :). 929always \f(CW0\fR, which is supposed to not be too high and not be too low :).
921.Sp 930.Sp
922Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is 931Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is
923fine, as long as you do not mind that the priority value you query might 932fine, as long as you do not mind that the priority value you query might
924or might not have been adjusted to be within valid range. 933or might not have been adjusted to be within valid range.
934.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4
935.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)"
936Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither
937\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback
938can deal with that fact.
939.IP "int ev_clear_pending (loop, ev_TYPE *watcher)" 4
940.IX Item "int ev_clear_pending (loop, ev_TYPE *watcher)"
941If the watcher is pending, this function returns clears its pending status
942and returns its \f(CW\*(C`revents\*(C'\fR bitset (as if its callback was invoked). If the
943watcher isn't pending it does nothing and returns \f(CW0\fR.
925.Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" 944.Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0"
926.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" 945.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER"
927Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change 946Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change
928and read at any time, libev will completely ignore it. This can be used 947and read at any time, libev will completely ignore it. This can be used
929to associate arbitrary data with your watcher. If you need more data and 948to associate arbitrary data with your watcher. If you need more data and
1616are ready to run (it's actually more complicated: it only runs coroutines 1635are ready to run (it's actually more complicated: it only runs coroutines
1617with priority higher than or equal to the event loop and one coroutine 1636with priority higher than or equal to the event loop and one coroutine
1618of lower priority, but only once, using idle watchers to keep the event 1637of lower priority, but only once, using idle watchers to keep the event
1619loop from blocking if lower-priority coroutines are active, thus mapping 1638loop from blocking if lower-priority coroutines are active, thus mapping
1620low-priority coroutines to idle/background tasks). 1639low-priority coroutines to idle/background tasks).
1640.PP
1641It is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR)
1642priority, to ensure that they are being run before any other watchers
1643after the poll. Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers,
1644too) should not activate (\*(L"feed\*(R") events into libev. While libev fully
1645supports this, they will be called before other \f(CW\*(C`ev_check\*(C'\fR watchers did
1646their job. As \f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other event
1647loops those other event loops might be in an unusable state until their
1648\&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with
1649others).
1621.IP "ev_prepare_init (ev_prepare *, callback)" 4 1650.IP "ev_prepare_init (ev_prepare *, callback)" 4
1622.IX Item "ev_prepare_init (ev_prepare *, callback)" 1651.IX Item "ev_prepare_init (ev_prepare *, callback)"
1623.PD 0 1652.PD 0
1624.IP "ev_check_init (ev_check *, callback)" 4 1653.IP "ev_check_init (ev_check *, callback)" 4
1625.IX Item "ev_check_init (ev_check *, callback)" 1654.IX Item "ev_check_init (ev_check *, callback)"
1626.PD 1655.PD
1627Initialises and configures the prepare or check watcher \- they have no 1656Initialises and configures the prepare or check watcher \- they have no
1628parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR 1657parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR
1629macros, but using them is utterly, utterly and completely pointless. 1658macros, but using them is utterly, utterly and completely pointless.
1630.PP 1659.PP
1631Example: To include a library such as adns, you would add \s-1IO\s0 watchers 1660There are a number of principal ways to embed other event loops or modules
1632and a timeout watcher in a prepare handler, as required by libadns, and 1661into libev. Here are some ideas on how to include libadns into libev
1662(there is a Perl module named \f(CW\*(C`EV::ADNS\*(C'\fR that does this, which you could
1663use for an actually working example. Another Perl module named \f(CW\*(C`EV::Glib\*(C'\fR
1664embeds a Glib main context into libev, and finally, \f(CW\*(C`Glib::EV\*(C'\fR embeds \s-1EV\s0
1665into the Glib event loop).
1666.PP
1667Method 1: Add \s-1IO\s0 watchers and a timeout watcher in a prepare handler,
1633in a check watcher, destroy them and call into libadns. What follows is 1668and in a check watcher, destroy them and call into libadns. What follows
1634pseudo-code only of course: 1669is pseudo-code only of course. This requires you to either use a low
1670priority for the check watcher or use \f(CW\*(C`ev_clear_pending\*(C'\fR explicitly, as
1671the callbacks for the IO/timeout watchers might not have been called yet.
1635.PP 1672.PP
1636.Vb 2 1673.Vb 2
1637\& static ev_io iow [nfd]; 1674\& static ev_io iow [nfd];
1638\& static ev_timer tw; 1675\& static ev_timer tw;
1639.Ve 1676.Ve
1640.PP 1677.PP
1641.Vb 9 1678.Vb 4
1642\& static void 1679\& static void
1643\& io_cb (ev_loop *loop, ev_io *w, int revents) 1680\& io_cb (ev_loop *loop, ev_io *w, int revents)
1644\& { 1681\& {
1645\& // set the relevant poll flags
1646\& // could also call adns_processreadable etc. here
1647\& struct pollfd *fd = (struct pollfd *)w->data;
1648\& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1649\& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1650\& } 1682\& }
1651.Ve 1683.Ve
1652.PP 1684.PP
1653.Vb 8 1685.Vb 8
1654\& // create io watchers for each fd and a timer before blocking 1686\& // create io watchers for each fd and a timer before blocking
1666\& ev_timer_init (&tw, 0, timeout * 1e-3); 1698\& ev_timer_init (&tw, 0, timeout * 1e-3);
1667\& ev_timer_start (loop, &tw); 1699\& ev_timer_start (loop, &tw);
1668.Ve 1700.Ve
1669.PP 1701.PP
1670.Vb 6 1702.Vb 6
1671\& // create on ev_io per pollfd 1703\& // create one ev_io per pollfd
1672\& for (int i = 0; i < nfd; ++i) 1704\& for (int i = 0; i < nfd; ++i)
1673\& { 1705\& {
1674\& ev_io_init (iow + i, io_cb, fds [i].fd, 1706\& ev_io_init (iow + i, io_cb, fds [i].fd,
1675\& ((fds [i].events & POLLIN ? EV_READ : 0) 1707\& ((fds [i].events & POLLIN ? EV_READ : 0)
1676\& | (fds [i].events & POLLOUT ? EV_WRITE : 0))); 1708\& | (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1677.Ve 1709.Ve
1678.PP 1710.PP
1679.Vb 5 1711.Vb 4
1680\& fds [i].revents = 0; 1712\& fds [i].revents = 0;
1681\& iow [i].data = fds + i;
1682\& ev_io_start (loop, iow + i); 1713\& ev_io_start (loop, iow + i);
1683\& } 1714\& }
1684\& } 1715\& }
1685.Ve 1716.Ve
1686.PP 1717.PP
1690\& adns_check_cb (ev_loop *loop, ev_check *w, int revents) 1721\& adns_check_cb (ev_loop *loop, ev_check *w, int revents)
1691\& { 1722\& {
1692\& ev_timer_stop (loop, &tw); 1723\& ev_timer_stop (loop, &tw);
1693.Ve 1724.Ve
1694.PP 1725.PP
1695.Vb 2 1726.Vb 8
1696\& for (int i = 0; i < nfd; ++i) 1727\& for (int i = 0; i < nfd; ++i)
1728\& {
1729\& // set the relevant poll flags
1730\& // could also call adns_processreadable etc. here
1731\& struct pollfd *fd = fds + i;
1732\& int revents = ev_clear_pending (iow + i);
1733\& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1734\& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1735.Ve
1736.PP
1737.Vb 3
1738\& // now stop the watcher
1697\& ev_io_stop (loop, iow + i); 1739\& ev_io_stop (loop, iow + i);
1740\& }
1698.Ve 1741.Ve
1699.PP 1742.PP
1700.Vb 2 1743.Vb 2
1701\& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); 1744\& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
1745\& }
1746.Ve
1747.PP
1748Method 2: This would be just like method 1, but you run \f(CW\*(C`adns_afterpoll\*(C'\fR
1749in the prepare watcher and would dispose of the check watcher.
1750.PP
1751Method 3: If the module to be embedded supports explicit event
1752notification (adns does), you can also make use of the actual watcher
1753callbacks, and only destroy/create the watchers in the prepare watcher.
1754.PP
1755.Vb 5
1756\& static void
1757\& timer_cb (EV_P_ ev_timer *w, int revents)
1758\& {
1759\& adns_state ads = (adns_state)w->data;
1760\& update_now (EV_A);
1761.Ve
1762.PP
1763.Vb 2
1764\& adns_processtimeouts (ads, &tv_now);
1765\& }
1766.Ve
1767.PP
1768.Vb 5
1769\& static void
1770\& io_cb (EV_P_ ev_io *w, int revents)
1771\& {
1772\& adns_state ads = (adns_state)w->data;
1773\& update_now (EV_A);
1774.Ve
1775.PP
1776.Vb 3
1777\& if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
1778\& if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
1779\& }
1780.Ve
1781.PP
1782.Vb 1
1783\& // do not ever call adns_afterpoll
1784.Ve
1785.PP
1786Method 4: Do not use a prepare or check watcher because the module you
1787want to embed is too inflexible to support it. Instead, youc na override
1788their poll function. The drawback with this solution is that the main
1789loop is now no longer controllable by \s-1EV\s0. The \f(CW\*(C`Glib::EV\*(C'\fR module does
1790this.
1791.PP
1792.Vb 4
1793\& static gint
1794\& event_poll_func (GPollFD *fds, guint nfds, gint timeout)
1795\& {
1796\& int got_events = 0;
1797.Ve
1798.PP
1799.Vb 2
1800\& for (n = 0; n < nfds; ++n)
1801\& // create/start io watcher that sets the relevant bits in fds[n] and increment got_events
1802.Ve
1803.PP
1804.Vb 2
1805\& if (timeout >= 0)
1806\& // create/start timer
1807.Ve
1808.PP
1809.Vb 2
1810\& // poll
1811\& ev_loop (EV_A_ 0);
1812.Ve
1813.PP
1814.Vb 3
1815\& // stop timer again
1816\& if (timeout >= 0)
1817\& ev_timer_stop (EV_A_ &to);
1818.Ve
1819.PP
1820.Vb 3
1821\& // stop io watchers again - their callbacks should have set
1822\& for (n = 0; n < nfds; ++n)
1823\& ev_io_stop (EV_A_ iow [n]);
1824.Ve
1825.PP
1826.Vb 2
1827\& return got_events;
1702\& } 1828\& }
1703.Ve 1829.Ve
1704.ie n .Sh """ev_embed"" \- when one backend isn't enough..." 1830.ie n .Sh """ev_embed"" \- when one backend isn't enough..."
1705.el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." 1831.el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..."
1706.IX Subsection "ev_embed - when one backend isn't enough..." 1832.IX Subsection "ev_embed - when one backend isn't enough..."
1890.PP 2016.PP
1891.Vb 1 2017.Vb 1
1892\& #include <ev++.h> 2018\& #include <ev++.h>
1893.Ve 2019.Ve
1894.PP 2020.PP
1895(it is not installed by default). This automatically includes \fIev.h\fR 2021This automatically includes \fIev.h\fR and puts all of its definitions (many
1896and puts all of its definitions (many of them macros) into the global 2022of them macros) into the global namespace. All \*(C+ specific things are
1897namespace. All \*(C+ specific things are put into the \f(CW\*(C`ev\*(C'\fR namespace. 2023put into the \f(CW\*(C`ev\*(C'\fR namespace. It should support all the same embedding
2024options as \fIev.h\fR, most notably \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR.
1898.PP 2025.PP
1899It should support all the same embedding options as \fIev.h\fR, most notably 2026Care has been taken to keep the overhead low. The only data member the \*(C+
1900\&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. 2027classes add (compared to plain C\-style watchers) is the event loop pointer
2028that the watcher is associated with (or no additional members at all if
2029you disable \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR when embedding libev).
2030.PP
2031Currently, functions, and static and non-static member functions can be
2032used as callbacks. Other types should be easy to add as long as they only
2033need one additional pointer for context. If you need support for other
2034types of functors please contact the author (preferably after implementing
2035it).
1901.PP 2036.PP
1902Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: 2037Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace:
1903.ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4 2038.ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4
1904.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 2039.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4
1905.IX Item "ev::READ, ev::WRITE etc." 2040.IX Item "ev::READ, ev::WRITE etc."
1917which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro 2052which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro
1918defines by many implementations. 2053defines by many implementations.
1919.Sp 2054.Sp
1920All of those classes have these methods: 2055All of those classes have these methods:
1921.RS 4 2056.RS 4
1922.IP "ev::TYPE::TYPE (object *, object::method *)" 4 2057.IP "ev::TYPE::TYPE ()" 4
1923.IX Item "ev::TYPE::TYPE (object *, object::method *)" 2058.IX Item "ev::TYPE::TYPE ()"
1924.PD 0 2059.PD 0
1925.IP "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" 4 2060.IP "ev::TYPE::TYPE (struct ev_loop *)" 4
1926.IX Item "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" 2061.IX Item "ev::TYPE::TYPE (struct ev_loop *)"
1927.IP "ev::TYPE::~TYPE" 4 2062.IP "ev::TYPE::~TYPE" 4
1928.IX Item "ev::TYPE::~TYPE" 2063.IX Item "ev::TYPE::~TYPE"
1929.PD 2064.PD
1930The constructor takes a pointer to an object and a method pointer to 2065The constructor (optionally) takes an event loop to associate the watcher
1931the event handler callback to call in this class. The constructor calls 2066with. If it is omitted, it will use \f(CW\*(C`EV_DEFAULT\*(C'\fR.
1932\&\f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the \f(CW\*(C`set\*(C'\fR method 2067.Sp
1933before starting it. If you do not specify a loop then the constructor 2068The constructor calls \f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the
1934automatically associates the default loop with this watcher. 2069\&\f(CW\*(C`set\*(C'\fR method before starting it.
2070.Sp
2071It will not set a callback, however: You have to call the templated \f(CW\*(C`set\*(C'\fR
2072method to set a callback before you can start the watcher.
2073.Sp
2074(The reason why you have to use a method is a limitation in \*(C+ which does
2075not allow explicit template arguments for constructors).
1935.Sp 2076.Sp
1936The destructor automatically stops the watcher if it is active. 2077The destructor automatically stops the watcher if it is active.
2078.IP "w\->set<class, &class::method> (object *)" 4
2079.IX Item "w->set<class, &class::method> (object *)"
2080This method sets the callback method to call. The method has to have a
2081signature of \f(CW\*(C`void (*)(ev_TYPE &, int)\*(C'\fR, it receives the watcher as
2082first argument and the \f(CW\*(C`revents\*(C'\fR as second. The object must be given as
2083parameter and is stored in the \f(CW\*(C`data\*(C'\fR member of the watcher.
2084.Sp
2085This method synthesizes efficient thunking code to call your method from
2086the C callback that libev requires. If your compiler can inline your
2087callback (i.e. it is visible to it at the place of the \f(CW\*(C`set\*(C'\fR call and
2088your compiler is good :), then the method will be fully inlined into the
2089thunking function, making it as fast as a direct C callback.
2090.Sp
2091Example: simple class declaration and watcher initialisation
2092.Sp
2093.Vb 4
2094\& struct myclass
2095\& {
2096\& void io_cb (ev::io &w, int revents) { }
2097\& }
2098.Ve
2099.Sp
2100.Vb 3
2101\& myclass obj;
2102\& ev::io iow;
2103\& iow.set <myclass, &myclass::io_cb> (&obj);
2104.Ve
2105.IP "w\->set<function> (void *data = 0)" 4
2106.IX Item "w->set<function> (void *data = 0)"
2107Also sets a callback, but uses a static method or plain function as
2108callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's
2109\&\f(CW\*(C`data\*(C'\fR member and is free for you to use.
2110.Sp
2111The prototype of the \f(CW\*(C`function\*(C'\fR must be \f(CW\*(C`void (*)(ev::TYPE &w, int)\*(C'\fR.
2112.Sp
2113See the method\-\f(CW\*(C`set\*(C'\fR above for more details.
2114.Sp
2115Example:
2116.Sp
2117.Vb 2
2118\& static void io_cb (ev::io &w, int revents) { }
2119\& iow.set <io_cb> ();
2120.Ve
1937.IP "w\->set (struct ev_loop *)" 4 2121.IP "w\->set (struct ev_loop *)" 4
1938.IX Item "w->set (struct ev_loop *)" 2122.IX Item "w->set (struct ev_loop *)"
1939Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only 2123Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only
1940do this when the watcher is inactive (and not pending either). 2124do this when the watcher is inactive (and not pending either).
1941.IP "w\->set ([args])" 4 2125.IP "w\->set ([args])" 4
1942.IX Item "w->set ([args])" 2126.IX Item "w->set ([args])"
1943Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be 2127Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be
1944called at least once. Unlike the C counterpart, an active watcher gets 2128called at least once. Unlike the C counterpart, an active watcher gets
1945automatically stopped and restarted. 2129automatically stopped and restarted when reconfiguring it with this
2130method.
1946.IP "w\->start ()" 4 2131.IP "w\->start ()" 4
1947.IX Item "w->start ()" 2132.IX Item "w->start ()"
1948Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument as the 2133Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the
1949constructor already takes the loop. 2134constructor already stores the event loop.
1950.IP "w\->stop ()" 4 2135.IP "w\->stop ()" 4
1951.IX Item "w->stop ()" 2136.IX Item "w->stop ()"
1952Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. 2137Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument.
1953.ie n .IP "w\->again () ""ev::timer""\fR, \f(CW""ev::periodic"" only" 4 2138.ie n .IP "w\->again () ""ev::timer""\fR, \f(CW""ev::periodic"" only" 4
1954.el .IP "w\->again () \f(CWev::timer\fR, \f(CWev::periodic\fR only" 4 2139.el .IP "w\->again () \f(CWev::timer\fR, \f(CWev::periodic\fR only" 4
1980.Vb 2 2165.Vb 2
1981\& myclass (); 2166\& myclass ();
1982\& } 2167\& }
1983.Ve 2168.Ve
1984.PP 2169.PP
1985.Vb 6 2170.Vb 4
1986\& myclass::myclass (int fd) 2171\& myclass::myclass (int fd)
1987\& : io (this, &myclass::io_cb),
1988\& idle (this, &myclass::idle_cb)
1989\& { 2172\& {
2173\& io .set <myclass, &myclass::io_cb > (this);
2174\& idle.set <myclass, &myclass::idle_cb> (this);
2175.Ve
2176.PP
2177.Vb 2
1990\& io.start (fd, ev::READ); 2178\& io.start (fd, ev::READ);
1991\& } 2179\& }
1992.Ve 2180.Ve
1993.SH "MACRO MAGIC" 2181.SH "MACRO MAGIC"
1994.IX Header "MACRO MAGIC" 2182.IX Header "MACRO MAGIC"
2274If undefined or defined to \f(CW1\fR, then all event-loop-specific functions 2462If undefined or defined to \f(CW1\fR, then all event-loop-specific functions
2275will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create 2463will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create
2276additional independent event loops. Otherwise there will be no support 2464additional independent event loops. Otherwise there will be no support
2277for multiple event loops and there is no first event loop pointer 2465for multiple event loops and there is no first event loop pointer
2278argument. Instead, all functions act on the single default loop. 2466argument. Instead, all functions act on the single default loop.
2467.IP "\s-1EV_MINPRI\s0" 4
2468.IX Item "EV_MINPRI"
2469.PD 0
2470.IP "\s-1EV_MAXPRI\s0" 4
2471.IX Item "EV_MAXPRI"
2472.PD
2473The range of allowed priorities. \f(CW\*(C`EV_MINPRI\*(C'\fR must be smaller or equal to
2474\&\f(CW\*(C`EV_MAXPRI\*(C'\fR, but otherwise there are no non-obvious limitations. You can
2475provide for more priorities by overriding those symbols (usually defined
2476to be \f(CW\*(C`\-2\*(C'\fR and \f(CW2\fR, respectively).
2477.Sp
2478When doing priority-based operations, libev usually has to linearly search
2479all the priorities, so having many of them (hundreds) uses a lot of space
2480and time, so using the defaults of five priorities (\-2 .. +2) is usually
2481fine.
2482.Sp
2483If your embedding app does not need any priorities, defining these both to
2484\&\f(CW0\fR will save some memory and cpu.
2279.IP "\s-1EV_PERIODIC_ENABLE\s0" 4 2485.IP "\s-1EV_PERIODIC_ENABLE\s0" 4
2280.IX Item "EV_PERIODIC_ENABLE" 2486.IX Item "EV_PERIODIC_ENABLE"
2281If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If 2487If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If
2282defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of 2488defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of
2283code. 2489code.
2382.SH "COMPLEXITIES" 2588.SH "COMPLEXITIES"
2383.IX Header "COMPLEXITIES" 2589.IX Header "COMPLEXITIES"
2384In this section the complexities of (many of) the algorithms used inside 2590In this section the complexities of (many of) the algorithms used inside
2385libev will be explained. For complexity discussions about backends see the 2591libev will be explained. For complexity discussions about backends see the
2386documentation for \f(CW\*(C`ev_default_init\*(C'\fR. 2592documentation for \f(CW\*(C`ev_default_init\*(C'\fR.
2593.Sp
2594All of the following are about amortised time: If an array needs to be
2595extended, libev needs to realloc and move the whole array, but this
2596happens asymptotically never with higher number of elements, so O(1) might
2597mean it might do a lengthy realloc operation in rare cases, but on average
2598it is much faster and asymptotically approaches constant time.
2387.RS 4 2599.RS 4
2388.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 2600.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4
2389.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 2601.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)"
2390.PD 0 2602This means that, when you have a watcher that triggers in one hour and
2603there are 100 watchers that would trigger before that then inserting will
2604have to skip those 100 watchers.
2391.IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4 2605.IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4
2392.IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 2606.IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)"
2607That means that for changing a timer costs less than removing/adding them
2608as only the relative motion in the event queue has to be paid for.
2393.IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 2609.IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4
2394.IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" 2610.IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)"
2395.IP "Stopping check/prepare/idle watchers: O(1)" 4 2611These just add the watcher into an array or at the head of a list.
2396.IX Item "Stopping check/prepare/idle watchers: O(1)" 2612=item Stopping check/prepare/idle watchers: O(1)
2397.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4 2613.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4
2398.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))" 2614.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))"
2615These watchers are stored in lists then need to be walked to find the
2616correct watcher to remove. The lists are usually short (you don't usually
2617have many watchers waiting for the same fd or signal).
2399.IP "Finding the next timer per loop iteration: O(1)" 4 2618.IP "Finding the next timer per loop iteration: O(1)" 4
2400.IX Item "Finding the next timer per loop iteration: O(1)" 2619.IX Item "Finding the next timer per loop iteration: O(1)"
2620.PD 0
2401.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 2621.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4
2402.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 2622.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)"
2623.PD
2624A change means an I/O watcher gets started or stopped, which requires
2625libev to recalculate its status (and possibly tell the kernel).
2403.IP "Activating one watcher: O(1)" 4 2626.IP "Activating one watcher: O(1)" 4
2404.IX Item "Activating one watcher: O(1)" 2627.IX Item "Activating one watcher: O(1)"
2628.PD 0
2629.IP "Priority handling: O(number_of_priorities)" 4
2630.IX Item "Priority handling: O(number_of_priorities)"
2631.PD
2632Priorities are implemented by allocating some space for each
2633priority. When doing priority-based operations, libev usually has to
2634linearly search all the priorities.
2405.RE 2635.RE
2406.RS 4 2636.RS 4
2407.PD
2408.SH "AUTHOR" 2637.SH "AUTHOR"
2409.IX Header "AUTHOR" 2638.IX Header "AUTHOR"
2410Marc Lehmann <libev@schmorp.de>. 2639Marc Lehmann <libev@schmorp.de>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines