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

Comparing libev/ev.3 (file contents):
Revision 1.35 by root, Thu Nov 29 17:28:13 2007 UTC vs.
Revision 1.43 by root, Sat Dec 8 14:27:38 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-11-29" "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
420a fork, you can also make libev check for a fork in each iteration by 424a fork, you can also make libev check for a fork in each iteration by
421enabling this flag. 425enabling this flag.
422.Sp 426.Sp
423This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, 427This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop,
424and thus this might slow down your event loop if you do a lot of loop 428and thus this might slow down your event loop if you do a lot of loop
425iterations and little real work, but is usually not noticable (on my 429iterations and little real work, but is usually not noticeable (on my
426Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence 430Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence
427without a syscall and thus \fIvery\fR fast, but my Linux system also has 431without a syscall and thus \fIvery\fR fast, but my Linux system also has
428\&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). 432\&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster).
429.Sp 433.Sp
430The big advantage of this flag is that you can forget about fork (and 434The big advantage of this flag is that you can forget about fork (and
581.IP "ev_loop_fork (loop)" 4 585.IP "ev_loop_fork (loop)" 4
582.IX Item "ev_loop_fork (loop)" 586.IX Item "ev_loop_fork (loop)"
583Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by 587Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by
584\&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop 588\&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop
585after fork, and how you do this is entirely your own problem. 589after fork, and how you do this is entirely your own problem.
590.IP "unsigned int ev_loop_count (loop)" 4
591.IX Item "unsigned int ev_loop_count (loop)"
592Returns the count of loop iterations for the loop, which is identical to
593the number of times libev did poll for new events. It starts at \f(CW0\fR and
594happily wraps around with enough iterations.
595.Sp
596This value can sometimes be useful as a generation counter of sorts (it
597\&\*(L"ticks\*(R" the number of loop iterations), as it roughly corresponds with
598\&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls.
586.IP "unsigned int ev_backend (loop)" 4 599.IP "unsigned int ev_backend (loop)" 4
587.IX Item "unsigned int ev_backend (loop)" 600.IX Item "unsigned int ev_backend (loop)"
588Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in 601Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in
589use. 602use.
590.IP "ev_tstamp ev_now (loop)" 4 603.IP "ev_tstamp ev_now (loop)" 4
876.IP "bool ev_is_pending (ev_TYPE *watcher)" 4 889.IP "bool ev_is_pending (ev_TYPE *watcher)" 4
877.IX Item "bool ev_is_pending (ev_TYPE *watcher)" 890.IX Item "bool ev_is_pending (ev_TYPE *watcher)"
878Returns a true value iff the watcher is pending, (i.e. it has outstanding 891Returns a true value iff the watcher is pending, (i.e. it has outstanding
879events but its callback has not yet been invoked). As long as a watcher 892events but its callback has not yet been invoked). As long as a watcher
880is pending (but not active) you must not call an init function on it (but 893is pending (but not active) you must not call an init function on it (but
881\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe) and you must make sure the watcher is available to 894\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe), you must not change its priority, and you must
882libev (e.g. you cnanot \f(CW\*(C`free ()\*(C'\fR it). 895make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR
896it).
883.IP "callback ev_cb (ev_TYPE *watcher)" 4 897.IP "callback ev_cb (ev_TYPE *watcher)" 4
884.IX Item "callback ev_cb (ev_TYPE *watcher)" 898.IX Item "callback ev_cb (ev_TYPE *watcher)"
885Returns the callback currently set on the watcher. 899Returns the callback currently set on the watcher.
886.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 900.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4
887.IX Item "ev_cb_set (ev_TYPE *watcher, callback)" 901.IX Item "ev_cb_set (ev_TYPE *watcher, callback)"
888Change the callback. You can change the callback at virtually any time 902Change the callback. You can change the callback at virtually any time
889(modulo threads). 903(modulo threads).
904.IP "ev_set_priority (ev_TYPE *watcher, priority)" 4
905.IX Item "ev_set_priority (ev_TYPE *watcher, priority)"
906.PD 0
907.IP "int ev_priority (ev_TYPE *watcher)" 4
908.IX Item "int ev_priority (ev_TYPE *watcher)"
909.PD
910Set and query the priority of the watcher. The priority is a small
911integer between \f(CW\*(C`EV_MAXPRI\*(C'\fR (default: \f(CW2\fR) and \f(CW\*(C`EV_MINPRI\*(C'\fR
912(default: \f(CW\*(C`\-2\*(C'\fR). Pending watchers with higher priority will be invoked
913before watchers with lower priority, but priority will not keep watchers
914from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers).
915.Sp
916This means that priorities are \fIonly\fR used for ordering callback
917invocation after new events have been received. This is useful, for
918example, to reduce latency after idling, or more often, to bind two
919watchers on the same event and make sure one is called first.
920.Sp
921If you need to suppress invocation when higher priority events are pending
922you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality.
923.Sp
924You \fImust not\fR change the priority of a watcher as long as it is active or
925pending.
926.Sp
927The default priority used by watchers when no priority has been set is
928always \f(CW0\fR, which is supposed to not be too high and not be too low :).
929.Sp
930Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is
931fine, as long as you do not mind that the priority value you query might
932or might not have been adjusted to be within valid range.
933.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4
934.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)"
935Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither
936\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback
937can deal with that fact.
938.IP "int ev_clear_pending (loop, ev_TYPE *watcher)" 4
939.IX Item "int ev_clear_pending (loop, ev_TYPE *watcher)"
940If the watcher is pending, this function returns clears its pending status
941and returns its \f(CW\*(C`revents\*(C'\fR bitset (as if its callback was invoked). If the
942watcher isn't pending it does nothing and returns \f(CW0\fR.
890.Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" 943.Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0"
891.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" 944.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER"
892Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change 945Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change
893and read at any time, libev will completely ignore it. This can be used 946and read at any time, libev will completely ignore it. This can be used
894to associate arbitrary data with your watcher. If you need more data and 947to associate arbitrary data with your watcher. If you need more data and
1005it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning 1058it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning
1006\&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives. 1059\&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives.
1007.PP 1060.PP
1008If you cannot run the fd in non-blocking mode (for example you should not 1061If you cannot run the fd in non-blocking mode (for example you should not
1009play around with an Xlib connection), then you have to seperately re-test 1062play around with an Xlib connection), then you have to seperately re-test
1010wether a file descriptor is really ready with a known-to-be good interface 1063whether a file descriptor is really ready with a known-to-be good interface
1011such as poll (fortunately in our Xlib example, Xlib already does this on 1064such as poll (fortunately in our Xlib example, Xlib already does this on
1012its own, so its quite safe to use). 1065its own, so its quite safe to use).
1013.IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 1066.IP "ev_io_init (ev_io *, callback, int fd, int events)" 4
1014.IX Item "ev_io_init (ev_io *, callback, int fd, int events)" 1067.IX Item "ev_io_init (ev_io *, callback, int fd, int events)"
1015.PD 0 1068.PD 0
1499\& ev_stat_start (loop, &passwd); 1552\& ev_stat_start (loop, &passwd);
1500.Ve 1553.Ve
1501.ie n .Sh """ev_idle"" \- when you've got nothing better to do..." 1554.ie n .Sh """ev_idle"" \- when you've got nothing better to do..."
1502.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." 1555.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..."
1503.IX Subsection "ev_idle - when you've got nothing better to do..." 1556.IX Subsection "ev_idle - when you've got nothing better to do..."
1504Idle watchers trigger events when there are no other events are pending 1557Idle watchers trigger events when no other events of the same or higher
1505(prepare, check and other idle watchers do not count). That is, as long 1558priority are pending (prepare, check and other idle watchers do not
1506as your process is busy handling sockets or timeouts (or even signals, 1559count).
1507imagine) it will not be triggered. But when your process is idle all idle 1560.PP
1508watchers are being called again and again, once per event loop iteration \- 1561That is, as long as your process is busy handling sockets or timeouts
1562(or even signals, imagine) of the same or higher priority it will not be
1563triggered. But when your process is idle (or only lower-priority watchers
1564are pending), the idle watchers are being called once per event loop
1509until stopped, that is, or your process receives more events and becomes 1565iteration \- until stopped, that is, or your process receives more events
1510busy. 1566and becomes busy again with higher priority stuff.
1511.PP 1567.PP
1512The most noteworthy effect is that as long as any idle watchers are 1568The most noteworthy effect is that as long as any idle watchers are
1513active, the process will not block when waiting for new events. 1569active, the process will not block when waiting for new events.
1514.PP 1570.PP
1515Apart from keeping your process non-blocking (which is a useful 1571Apart from keeping your process non-blocking (which is a useful
1610\& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; 1666\& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1611\& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; 1667\& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1612\& } 1668\& }
1613.Ve 1669.Ve
1614.PP 1670.PP
1615.Vb 7 1671.Vb 8
1616\& // create io watchers for each fd and a timer before blocking 1672\& // create io watchers for each fd and a timer before blocking
1617\& static void 1673\& static void
1618\& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) 1674\& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
1619\& { 1675\& {
1620\& int timeout = 3600000;truct pollfd fds [nfd]; 1676\& int timeout = 3600000;
1677\& struct pollfd fds [nfd];
1621\& // actual code will need to loop here and realloc etc. 1678\& // actual code will need to loop here and realloc etc.
1622\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); 1679\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1623.Ve 1680.Ve
1624.PP 1681.PP
1625.Vb 3 1682.Vb 3
1851.PP 1908.PP
1852.Vb 1 1909.Vb 1
1853\& #include <ev++.h> 1910\& #include <ev++.h>
1854.Ve 1911.Ve
1855.PP 1912.PP
1856(it is not installed by default). This automatically includes \fIev.h\fR 1913This automatically includes \fIev.h\fR and puts all of its definitions (many
1857and puts all of its definitions (many of them macros) into the global 1914of them macros) into the global namespace. All \*(C+ specific things are
1858namespace. All \*(C+ specific things are put into the \f(CW\*(C`ev\*(C'\fR namespace. 1915put into the \f(CW\*(C`ev\*(C'\fR namespace. It should support all the same embedding
1916options as \fIev.h\fR, most notably \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR.
1859.PP 1917.PP
1860It should support all the same embedding options as \fIev.h\fR, most notably 1918Care has been taken to keep the overhead low. The only data member the \*(C+
1861\&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. 1919classes add (compared to plain C\-style watchers) is the event loop pointer
1920that the watcher is associated with (or no additional members at all if
1921you disable \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR when embedding libev).
1922.PP
1923Currently, functions, and static and non-static member functions can be
1924used as callbacks. Other types should be easy to add as long as they only
1925need one additional pointer for context. If you need support for other
1926types of functors please contact the author (preferably after implementing
1927it).
1862.PP 1928.PP
1863Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: 1929Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace:
1864.ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4 1930.ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4
1865.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 1931.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4
1866.IX Item "ev::READ, ev::WRITE etc." 1932.IX Item "ev::READ, ev::WRITE etc."
1878which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro 1944which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro
1879defines by many implementations. 1945defines by many implementations.
1880.Sp 1946.Sp
1881All of those classes have these methods: 1947All of those classes have these methods:
1882.RS 4 1948.RS 4
1883.IP "ev::TYPE::TYPE (object *, object::method *)" 4 1949.IP "ev::TYPE::TYPE ()" 4
1884.IX Item "ev::TYPE::TYPE (object *, object::method *)" 1950.IX Item "ev::TYPE::TYPE ()"
1885.PD 0 1951.PD 0
1886.IP "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" 4 1952.IP "ev::TYPE::TYPE (struct ev_loop *)" 4
1887.IX Item "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" 1953.IX Item "ev::TYPE::TYPE (struct ev_loop *)"
1888.IP "ev::TYPE::~TYPE" 4 1954.IP "ev::TYPE::~TYPE" 4
1889.IX Item "ev::TYPE::~TYPE" 1955.IX Item "ev::TYPE::~TYPE"
1890.PD 1956.PD
1891The constructor takes a pointer to an object and a method pointer to 1957The constructor (optionally) takes an event loop to associate the watcher
1892the event handler callback to call in this class. The constructor calls 1958with. If it is omitted, it will use \f(CW\*(C`EV_DEFAULT\*(C'\fR.
1893\&\f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the \f(CW\*(C`set\*(C'\fR method 1959.Sp
1894before starting it. If you do not specify a loop then the constructor 1960The constructor calls \f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the
1895automatically associates the default loop with this watcher. 1961\&\f(CW\*(C`set\*(C'\fR method before starting it.
1962.Sp
1963It will not set a callback, however: You have to call the templated \f(CW\*(C`set\*(C'\fR
1964method to set a callback before you can start the watcher.
1965.Sp
1966(The reason why you have to use a method is a limitation in \*(C+ which does
1967not allow explicit template arguments for constructors).
1896.Sp 1968.Sp
1897The destructor automatically stops the watcher if it is active. 1969The destructor automatically stops the watcher if it is active.
1970.IP "w\->set<class, &class::method> (object *)" 4
1971.IX Item "w->set<class, &class::method> (object *)"
1972This method sets the callback method to call. The method has to have a
1973signature of \f(CW\*(C`void (*)(ev_TYPE &, int)\*(C'\fR, it receives the watcher as
1974first argument and the \f(CW\*(C`revents\*(C'\fR as second. The object must be given as
1975parameter and is stored in the \f(CW\*(C`data\*(C'\fR member of the watcher.
1976.Sp
1977This method synthesizes efficient thunking code to call your method from
1978the C callback that libev requires. If your compiler can inline your
1979callback (i.e. it is visible to it at the place of the \f(CW\*(C`set\*(C'\fR call and
1980your compiler is good :), then the method will be fully inlined into the
1981thunking function, making it as fast as a direct C callback.
1982.Sp
1983Example: simple class declaration and watcher initialisation
1984.Sp
1985.Vb 4
1986\& struct myclass
1987\& {
1988\& void io_cb (ev::io &w, int revents) { }
1989\& }
1990.Ve
1991.Sp
1992.Vb 3
1993\& myclass obj;
1994\& ev::io iow;
1995\& iow.set <myclass, &myclass::io_cb> (&obj);
1996.Ve
1997.IP "w\->set<function> (void *data = 0)" 4
1998.IX Item "w->set<function> (void *data = 0)"
1999Also sets a callback, but uses a static method or plain function as
2000callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's
2001\&\f(CW\*(C`data\*(C'\fR member and is free for you to use.
2002.Sp
2003The prototype of the \f(CW\*(C`function\*(C'\fR must be \f(CW\*(C`void (*)(ev::TYPE &w, int)\*(C'\fR.
2004.Sp
2005See the method\-\f(CW\*(C`set\*(C'\fR above for more details.
2006.Sp
2007Example:
2008.Sp
2009.Vb 2
2010\& static void io_cb (ev::io &w, int revents) { }
2011\& iow.set <io_cb> ();
2012.Ve
1898.IP "w\->set (struct ev_loop *)" 4 2013.IP "w\->set (struct ev_loop *)" 4
1899.IX Item "w->set (struct ev_loop *)" 2014.IX Item "w->set (struct ev_loop *)"
1900Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only 2015Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only
1901do this when the watcher is inactive (and not pending either). 2016do this when the watcher is inactive (and not pending either).
1902.IP "w\->set ([args])" 4 2017.IP "w\->set ([args])" 4
1903.IX Item "w->set ([args])" 2018.IX Item "w->set ([args])"
1904Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be 2019Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be
1905called at least once. Unlike the C counterpart, an active watcher gets 2020called at least once. Unlike the C counterpart, an active watcher gets
1906automatically stopped and restarted. 2021automatically stopped and restarted when reconfiguring it with this
2022method.
1907.IP "w\->start ()" 4 2023.IP "w\->start ()" 4
1908.IX Item "w->start ()" 2024.IX Item "w->start ()"
1909Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument as the 2025Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the
1910constructor already takes the loop. 2026constructor already stores the event loop.
1911.IP "w\->stop ()" 4 2027.IP "w\->stop ()" 4
1912.IX Item "w->stop ()" 2028.IX Item "w->stop ()"
1913Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. 2029Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument.
1914.ie n .IP "w\->again () ""ev::timer""\fR, \f(CW""ev::periodic"" only" 4 2030.ie n .IP "w\->again () ""ev::timer""\fR, \f(CW""ev::periodic"" only" 4
1915.el .IP "w\->again () \f(CWev::timer\fR, \f(CWev::periodic\fR only" 4 2031.el .IP "w\->again () \f(CWev::timer\fR, \f(CWev::periodic\fR only" 4
1941.Vb 2 2057.Vb 2
1942\& myclass (); 2058\& myclass ();
1943\& } 2059\& }
1944.Ve 2060.Ve
1945.PP 2061.PP
1946.Vb 6 2062.Vb 4
1947\& myclass::myclass (int fd) 2063\& myclass::myclass (int fd)
1948\& : io (this, &myclass::io_cb),
1949\& idle (this, &myclass::idle_cb)
1950\& { 2064\& {
2065\& io .set <myclass, &myclass::io_cb > (this);
2066\& idle.set <myclass, &myclass::idle_cb> (this);
2067.Ve
2068.PP
2069.Vb 2
1951\& io.start (fd, ev::READ); 2070\& io.start (fd, ev::READ);
1952\& } 2071\& }
1953.Ve 2072.Ve
1954.SH "MACRO MAGIC" 2073.SH "MACRO MAGIC"
1955.IX Header "MACRO MAGIC" 2074.IX Header "MACRO MAGIC"
1956Libev can be compiled with a variety of options, the most fundemantal is 2075Libev can be compiled with a variety of options, the most fundemantal is
1957\&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines wether (most) functions and 2076\&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) functions and
1958callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. 2077callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument.
1959.PP 2078.PP
1960To make it easier to write programs that cope with either variant, the 2079To make it easier to write programs that cope with either variant, the
1961following macros are defined: 2080following macros are defined:
1962.ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4 2081.ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4
1997.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 2116.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4
1998.IX Item "EV_DEFAULT, EV_DEFAULT_" 2117.IX Item "EV_DEFAULT, EV_DEFAULT_"
1999Similar to the other two macros, this gives you the value of the default 2118Similar to the other two macros, this gives you the value of the default
2000loop, if multiple loops are supported (\*(L"ev loop default\*(R"). 2119loop, if multiple loops are supported (\*(L"ev loop default\*(R").
2001.PP 2120.PP
2002Example: Declare and initialise a check watcher, working regardless of 2121Example: Declare and initialise a check watcher, utilising the above
2003wether multiple loops are supported or not. 2122macros so it will work regardless of whether multiple loops are supported
2123or not.
2004.PP 2124.PP
2005.Vb 5 2125.Vb 5
2006\& static void 2126\& static void
2007\& check_cb (EV_P_ ev_timer *w, int revents) 2127\& check_cb (EV_P_ ev_timer *w, int revents)
2008\& { 2128\& {
2071.Vb 1 2191.Vb 1
2072\& ev_win32.c required on win32 platforms only 2192\& ev_win32.c required on win32 platforms only
2073.Ve 2193.Ve
2074.PP 2194.PP
2075.Vb 5 2195.Vb 5
2076\& ev_select.c only when select backend is enabled (which is by default) 2196\& ev_select.c only when select backend is enabled (which is enabled by default)
2077\& ev_poll.c only when poll backend is enabled (disabled by default) 2197\& ev_poll.c only when poll backend is enabled (disabled by default)
2078\& ev_epoll.c only when the epoll backend is enabled (disabled by default) 2198\& ev_epoll.c only when the epoll backend is enabled (disabled by default)
2079\& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 2199\& ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
2080\& ev_port.c only when the solaris port backend is enabled (disabled by default) 2200\& ev_port.c only when the solaris port backend is enabled (disabled by default)
2081.Ve 2201.Ve
2234If undefined or defined to \f(CW1\fR, then all event-loop-specific functions 2354If undefined or defined to \f(CW1\fR, then all event-loop-specific functions
2235will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create 2355will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create
2236additional independent event loops. Otherwise there will be no support 2356additional independent event loops. Otherwise there will be no support
2237for multiple event loops and there is no first event loop pointer 2357for multiple event loops and there is no first event loop pointer
2238argument. Instead, all functions act on the single default loop. 2358argument. Instead, all functions act on the single default loop.
2359.IP "\s-1EV_MINPRI\s0" 4
2360.IX Item "EV_MINPRI"
2361.PD 0
2362.IP "\s-1EV_MAXPRI\s0" 4
2363.IX Item "EV_MAXPRI"
2364.PD
2365The range of allowed priorities. \f(CW\*(C`EV_MINPRI\*(C'\fR must be smaller or equal to
2366\&\f(CW\*(C`EV_MAXPRI\*(C'\fR, but otherwise there are no non-obvious limitations. You can
2367provide for more priorities by overriding those symbols (usually defined
2368to be \f(CW\*(C`\-2\*(C'\fR and \f(CW2\fR, respectively).
2369.Sp
2370When doing priority-based operations, libev usually has to linearly search
2371all the priorities, so having many of them (hundreds) uses a lot of space
2372and time, so using the defaults of five priorities (\-2 .. +2) is usually
2373fine.
2374.Sp
2375If your embedding app does not need any priorities, defining these both to
2376\&\f(CW0\fR will save some memory and cpu.
2239.IP "\s-1EV_PERIODIC_ENABLE\s0" 4 2377.IP "\s-1EV_PERIODIC_ENABLE\s0" 4
2240.IX Item "EV_PERIODIC_ENABLE" 2378.IX Item "EV_PERIODIC_ENABLE"
2241If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If 2379If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If
2380defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of
2381code.
2382.IP "\s-1EV_IDLE_ENABLE\s0" 4
2383.IX Item "EV_IDLE_ENABLE"
2384If undefined or defined to be \f(CW1\fR, then idle watchers are supported. If
2242defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of 2385defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of
2243code. 2386code.
2244.IP "\s-1EV_EMBED_ENABLE\s0" 4 2387.IP "\s-1EV_EMBED_ENABLE\s0" 4
2245.IX Item "EV_EMBED_ENABLE" 2388.IX Item "EV_EMBED_ENABLE"
2246If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If 2389If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If
2308interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file 2451interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file
2309will be compiled. It is pretty complex because it provides its own header 2452will be compiled. It is pretty complex because it provides its own header
2310file. 2453file.
2311.Sp 2454.Sp
2312The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file 2455The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file
2313that everybody includes and which overrides some autoconf choices: 2456that everybody includes and which overrides some configure choices:
2314.Sp 2457.Sp
2315.Vb 4 2458.Vb 9
2459\& #define EV_MINIMAL 1
2316\& #define EV_USE_POLL 0 2460\& #define EV_USE_POLL 0
2317\& #define EV_MULTIPLICITY 0 2461\& #define EV_MULTIPLICITY 0
2318\& #define EV_PERIODICS 0 2462\& #define EV_PERIODIC_ENABLE 0
2463\& #define EV_STAT_ENABLE 0
2464\& #define EV_FORK_ENABLE 0
2319\& #define EV_CONFIG_H <config.h> 2465\& #define EV_CONFIG_H <config.h>
2466\& #define EV_MINPRI 0
2467\& #define EV_MAXPRI 0
2320.Ve 2468.Ve
2321.Sp 2469.Sp
2322.Vb 1 2470.Vb 1
2323\& #include "ev++.h" 2471\& #include "ev++.h"
2324.Ve 2472.Ve
2332.SH "COMPLEXITIES" 2480.SH "COMPLEXITIES"
2333.IX Header "COMPLEXITIES" 2481.IX Header "COMPLEXITIES"
2334In this section the complexities of (many of) the algorithms used inside 2482In this section the complexities of (many of) the algorithms used inside
2335libev will be explained. For complexity discussions about backends see the 2483libev will be explained. For complexity discussions about backends see the
2336documentation for \f(CW\*(C`ev_default_init\*(C'\fR. 2484documentation for \f(CW\*(C`ev_default_init\*(C'\fR.
2485.Sp
2486All of the following are about amortised time: If an array needs to be
2487extended, libev needs to realloc and move the whole array, but this
2488happens asymptotically never with higher number of elements, so O(1) might
2489mean it might do a lengthy realloc operation in rare cases, but on average
2490it is much faster and asymptotically approaches constant time.
2337.RS 4 2491.RS 4
2338.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 2492.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4
2339.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 2493.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)"
2340.PD 0 2494This means that, when you have a watcher that triggers in one hour and
2495there are 100 watchers that would trigger before that then inserting will
2496have to skip those 100 watchers.
2341.IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4 2497.IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4
2342.IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 2498.IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)"
2499That means that for changing a timer costs less than removing/adding them
2500as only the relative motion in the event queue has to be paid for.
2343.IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 2501.IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4
2344.IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" 2502.IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)"
2345.IP "Stopping check/prepare/idle watchers: O(1)" 4 2503These just add the watcher into an array or at the head of a list.
2346.IX Item "Stopping check/prepare/idle watchers: O(1)" 2504=item Stopping check/prepare/idle watchers: O(1)
2347.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4 2505.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4
2348.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))" 2506.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))"
2507These watchers are stored in lists then need to be walked to find the
2508correct watcher to remove. The lists are usually short (you don't usually
2509have many watchers waiting for the same fd or signal).
2349.IP "Finding the next timer per loop iteration: O(1)" 4 2510.IP "Finding the next timer per loop iteration: O(1)" 4
2350.IX Item "Finding the next timer per loop iteration: O(1)" 2511.IX Item "Finding the next timer per loop iteration: O(1)"
2512.PD 0
2351.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 2513.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4
2352.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 2514.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)"
2515.PD
2516A change means an I/O watcher gets started or stopped, which requires
2517libev to recalculate its status (and possibly tell the kernel).
2353.IP "Activating one watcher: O(1)" 4 2518.IP "Activating one watcher: O(1)" 4
2354.IX Item "Activating one watcher: O(1)" 2519.IX Item "Activating one watcher: O(1)"
2520.PD 0
2521.IP "Priority handling: O(number_of_priorities)" 4
2522.IX Item "Priority handling: O(number_of_priorities)"
2523.PD
2524Priorities are implemented by allocating some space for each
2525priority. When doing priority-based operations, libev usually has to
2526linearly search all the priorities.
2355.RE 2527.RE
2356.RS 4 2528.RS 4
2357.PD
2358.SH "AUTHOR" 2529.SH "AUTHOR"
2359.IX Header "AUTHOR" 2530.IX Header "AUTHOR"
2360Marc Lehmann <libev@schmorp.de>. 2531Marc Lehmann <libev@schmorp.de>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines