… | |
… | |
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-07" "perl v5.8.8" "User Contributed Perl Documentation" |
133 | .SH "NAME" |
133 | .SH "NAME" |
134 | libev \- a high performance full\-featured event loop written in C |
134 | libev \- 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" |
|
|
201 | The newest version of this document is also available as a html-formatted |
|
|
202 | web page you might find easier to navigate when reading it for the first |
|
|
203 | time: <http://cvs.schmorp.de/libev/ev.html>. |
|
|
204 | .PP |
201 | Libev is an event loop: you register interest in certain events (such as a |
205 | Libev is an event loop: you register interest in certain events (such as a |
202 | file descriptor being readable or a timeout occuring), and it will manage |
206 | file descriptor being readable or a timeout occuring), and it will manage |
203 | these event sources and provide your program with events. |
207 | these event sources and provide your program with events. |
204 | .PP |
208 | .PP |
205 | To do this, it must take more or less complete control over your process |
209 | To do this, it must take more or less complete control over your process |
… | |
… | |
420 | a fork, you can also make libev check for a fork in each iteration by |
424 | a fork, you can also make libev check for a fork in each iteration by |
421 | enabling this flag. |
425 | enabling this flag. |
422 | .Sp |
426 | .Sp |
423 | This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, |
427 | This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, |
424 | and thus this might slow down your event loop if you do a lot of loop |
428 | and thus this might slow down your event loop if you do a lot of loop |
425 | iterations and little real work, but is usually not noticable (on my |
429 | iterations and little real work, but is usually not noticeable (on my |
426 | Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence |
430 | Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence |
427 | without a syscall and thus \fIvery\fR fast, but my Linux system also has |
431 | without 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 |
430 | The big advantage of this flag is that you can forget about fork (and |
434 | The 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)" |
583 | Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by |
587 | Like \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 |
585 | after fork, and how you do this is entirely your own problem. |
589 | after 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)" |
|
|
592 | Returns the count of loop iterations for the loop, which is identical to |
|
|
593 | the number of times libev did poll for new events. It starts at \f(CW0\fR and |
|
|
594 | happily wraps around with enough iterations. |
|
|
595 | .Sp |
|
|
596 | This 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)" |
588 | Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in |
601 | Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in |
589 | use. |
602 | use. |
590 | .IP "ev_tstamp ev_now (loop)" 4 |
603 | .IP "ev_tstamp ev_now (loop)" 4 |
… | |
… | |
885 | Returns the callback currently set on the watcher. |
898 | Returns the callback currently set on the watcher. |
886 | .IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 |
899 | .IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 |
887 | .IX Item "ev_cb_set (ev_TYPE *watcher, callback)" |
900 | .IX Item "ev_cb_set (ev_TYPE *watcher, callback)" |
888 | Change the callback. You can change the callback at virtually any time |
901 | Change the callback. You can change the callback at virtually any time |
889 | (modulo threads). |
902 | (modulo threads). |
|
|
903 | .IP "ev_set_priority (ev_TYPE *watcher, priority)" 4 |
|
|
904 | .IX Item "ev_set_priority (ev_TYPE *watcher, priority)" |
|
|
905 | .PD 0 |
|
|
906 | .IP "int ev_priority (ev_TYPE *watcher)" 4 |
|
|
907 | .IX Item "int ev_priority (ev_TYPE *watcher)" |
|
|
908 | .PD |
|
|
909 | Set and query the priority of the watcher. The priority is a small |
|
|
910 | integer between \f(CW\*(C`EV_MAXPRI\*(C'\fR (default: \f(CW2\fR) and \f(CW\*(C`EV_MINPRI\*(C'\fR |
|
|
911 | (default: \f(CW\*(C`\-2\*(C'\fR). Pending watchers with higher priority will be invoked |
|
|
912 | before watchers with lower priority, but priority will not keep watchers |
|
|
913 | from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers). |
|
|
914 | .Sp |
|
|
915 | This means that priorities are \fIonly\fR used for ordering callback |
|
|
916 | invocation after new events have been received. This is useful, for |
|
|
917 | example, to reduce latency after idling, or more often, to bind two |
|
|
918 | watchers on the same event and make sure one is called first. |
|
|
919 | .Sp |
|
|
920 | If you need to suppress invocation when higher priority events are pending |
|
|
921 | you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality. |
|
|
922 | .Sp |
|
|
923 | The default priority used by watchers when no priority has been set is |
|
|
924 | always \f(CW0\fR, which is supposed to not be too high and not be too low :). |
|
|
925 | .Sp |
|
|
926 | Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is |
|
|
927 | fine, as long as you do not mind that the priority value you query might |
|
|
928 | or might not have been adjusted to be within valid range. |
890 | .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" |
929 | .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" |
930 | .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" |
892 | Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change |
931 | Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change |
893 | and read at any time, libev will completely ignore it. This can be used |
932 | and read at any time, libev will completely ignore it. This can be used |
894 | to associate arbitrary data with your watcher. If you need more data and |
933 | to associate arbitrary data with your watcher. If you need more data and |
… | |
… | |
1005 | it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning |
1044 | it 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. |
1045 | \&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives. |
1007 | .PP |
1046 | .PP |
1008 | If you cannot run the fd in non-blocking mode (for example you should not |
1047 | If you cannot run the fd in non-blocking mode (for example you should not |
1009 | play around with an Xlib connection), then you have to seperately re-test |
1048 | play around with an Xlib connection), then you have to seperately re-test |
1010 | wether a file descriptor is really ready with a known-to-be good interface |
1049 | whether a file descriptor is really ready with a known-to-be good interface |
1011 | such as poll (fortunately in our Xlib example, Xlib already does this on |
1050 | such as poll (fortunately in our Xlib example, Xlib already does this on |
1012 | its own, so its quite safe to use). |
1051 | its own, so its quite safe to use). |
1013 | .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 |
1052 | .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)" |
1053 | .IX Item "ev_io_init (ev_io *, callback, int fd, int events)" |
1015 | .PD 0 |
1054 | .PD 0 |
… | |
… | |
1499 | \& ev_stat_start (loop, &passwd); |
1538 | \& ev_stat_start (loop, &passwd); |
1500 | .Ve |
1539 | .Ve |
1501 | .ie n .Sh """ev_idle"" \- when you've got nothing better to do..." |
1540 | .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..." |
1541 | .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..." |
1542 | .IX Subsection "ev_idle - when you've got nothing better to do..." |
1504 | Idle watchers trigger events when there are no other events are pending |
1543 | Idle 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 |
1544 | priority are pending (prepare, check and other idle watchers do not |
1506 | as your process is busy handling sockets or timeouts (or even signals, |
1545 | count). |
1507 | imagine) it will not be triggered. But when your process is idle all idle |
1546 | .PP |
1508 | watchers are being called again and again, once per event loop iteration \- |
1547 | That is, as long as your process is busy handling sockets or timeouts |
|
|
1548 | (or even signals, imagine) of the same or higher priority it will not be |
|
|
1549 | triggered. But when your process is idle (or only lower-priority watchers |
|
|
1550 | are pending), the idle watchers are being called once per event loop |
1509 | until stopped, that is, or your process receives more events and becomes |
1551 | iteration \- until stopped, that is, or your process receives more events |
1510 | busy. |
1552 | and becomes busy again with higher priority stuff. |
1511 | .PP |
1553 | .PP |
1512 | The most noteworthy effect is that as long as any idle watchers are |
1554 | The most noteworthy effect is that as long as any idle watchers are |
1513 | active, the process will not block when waiting for new events. |
1555 | active, the process will not block when waiting for new events. |
1514 | .PP |
1556 | .PP |
1515 | Apart from keeping your process non-blocking (which is a useful |
1557 | Apart from keeping your process non-blocking (which is a useful |
… | |
… | |
1610 | \& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
1652 | \& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
1611 | \& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
1653 | \& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
1612 | \& } |
1654 | \& } |
1613 | .Ve |
1655 | .Ve |
1614 | .PP |
1656 | .PP |
1615 | .Vb 7 |
1657 | .Vb 8 |
1616 | \& // create io watchers for each fd and a timer before blocking |
1658 | \& // create io watchers for each fd and a timer before blocking |
1617 | \& static void |
1659 | \& static void |
1618 | \& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
1660 | \& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
1619 | \& { |
1661 | \& { |
1620 | \& int timeout = 3600000;truct pollfd fds [nfd]; |
1662 | \& int timeout = 3600000; |
|
|
1663 | \& struct pollfd fds [nfd]; |
1621 | \& // actual code will need to loop here and realloc etc. |
1664 | \& // actual code will need to loop here and realloc etc. |
1622 | \& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
1665 | \& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
1623 | .Ve |
1666 | .Ve |
1624 | .PP |
1667 | .PP |
1625 | .Vb 3 |
1668 | .Vb 3 |
… | |
… | |
1851 | .PP |
1894 | .PP |
1852 | .Vb 1 |
1895 | .Vb 1 |
1853 | \& #include <ev++.h> |
1896 | \& #include <ev++.h> |
1854 | .Ve |
1897 | .Ve |
1855 | .PP |
1898 | .PP |
1856 | (it is not installed by default). This automatically includes \fIev.h\fR |
1899 | This automatically includes \fIev.h\fR and puts all of its definitions (many |
1857 | and puts all of its definitions (many of them macros) into the global |
1900 | of them macros) into the global namespace. All \*(C+ specific things are |
1858 | namespace. All \*(C+ specific things are put into the \f(CW\*(C`ev\*(C'\fR namespace. |
1901 | put into the \f(CW\*(C`ev\*(C'\fR namespace. It should support all the same embedding |
|
|
1902 | options as \fIev.h\fR, most notably \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. |
1859 | .PP |
1903 | .PP |
1860 | It should support all the same embedding options as \fIev.h\fR, most notably |
1904 | Care has been taken to keep the overhead low. The only data member the \*(C+ |
1861 | \&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. |
1905 | classes add (compared to plain C\-style watchers) is the event loop pointer |
|
|
1906 | that the watcher is associated with (or no additional members at all if |
|
|
1907 | you disable \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR when embedding libev). |
|
|
1908 | .PP |
|
|
1909 | Currently, functions, and static and non-static member functions can be |
|
|
1910 | used as callbacks. Other types should be easy to add as long as they only |
|
|
1911 | need one additional pointer for context. If you need support for other |
|
|
1912 | types of functors please contact the author (preferably after implementing |
|
|
1913 | it). |
1862 | .PP |
1914 | .PP |
1863 | Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: |
1915 | Here 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 |
1916 | .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 |
1917 | .el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 |
1866 | .IX Item "ev::READ, ev::WRITE etc." |
1918 | .IX Item "ev::READ, ev::WRITE etc." |
… | |
… | |
1878 | which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro |
1930 | which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro |
1879 | defines by many implementations. |
1931 | defines by many implementations. |
1880 | .Sp |
1932 | .Sp |
1881 | All of those classes have these methods: |
1933 | All of those classes have these methods: |
1882 | .RS 4 |
1934 | .RS 4 |
1883 | .IP "ev::TYPE::TYPE (object *, object::method *)" 4 |
1935 | .IP "ev::TYPE::TYPE ()" 4 |
1884 | .IX Item "ev::TYPE::TYPE (object *, object::method *)" |
1936 | .IX Item "ev::TYPE::TYPE ()" |
1885 | .PD 0 |
1937 | .PD 0 |
1886 | .IP "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" 4 |
1938 | .IP "ev::TYPE::TYPE (struct ev_loop *)" 4 |
1887 | .IX Item "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" |
1939 | .IX Item "ev::TYPE::TYPE (struct ev_loop *)" |
1888 | .IP "ev::TYPE::~TYPE" 4 |
1940 | .IP "ev::TYPE::~TYPE" 4 |
1889 | .IX Item "ev::TYPE::~TYPE" |
1941 | .IX Item "ev::TYPE::~TYPE" |
1890 | .PD |
1942 | .PD |
1891 | The constructor takes a pointer to an object and a method pointer to |
1943 | The constructor (optionally) takes an event loop to associate the watcher |
1892 | the event handler callback to call in this class. The constructor calls |
1944 | with. 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 |
1945 | .Sp |
1894 | before starting it. If you do not specify a loop then the constructor |
1946 | The constructor calls \f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the |
1895 | automatically associates the default loop with this watcher. |
1947 | \&\f(CW\*(C`set\*(C'\fR method before starting it. |
|
|
1948 | .Sp |
|
|
1949 | It will not set a callback, however: You have to call the templated \f(CW\*(C`set\*(C'\fR |
|
|
1950 | method to set a callback before you can start the watcher. |
|
|
1951 | .Sp |
|
|
1952 | (The reason why you have to use a method is a limitation in \*(C+ which does |
|
|
1953 | not allow explicit template arguments for constructors). |
1896 | .Sp |
1954 | .Sp |
1897 | The destructor automatically stops the watcher if it is active. |
1955 | The destructor automatically stops the watcher if it is active. |
|
|
1956 | .IP "w\->set<class, &class::method> (object *)" 4 |
|
|
1957 | .IX Item "w->set<class, &class::method> (object *)" |
|
|
1958 | This method sets the callback method to call. The method has to have a |
|
|
1959 | signature of \f(CW\*(C`void (*)(ev_TYPE &, int)\*(C'\fR, it receives the watcher as |
|
|
1960 | first argument and the \f(CW\*(C`revents\*(C'\fR as second. The object must be given as |
|
|
1961 | parameter and is stored in the \f(CW\*(C`data\*(C'\fR member of the watcher. |
|
|
1962 | .Sp |
|
|
1963 | This method synthesizes efficient thunking code to call your method from |
|
|
1964 | the C callback that libev requires. If your compiler can inline your |
|
|
1965 | callback (i.e. it is visible to it at the place of the \f(CW\*(C`set\*(C'\fR call and |
|
|
1966 | your compiler is good :), then the method will be fully inlined into the |
|
|
1967 | thunking function, making it as fast as a direct C callback. |
|
|
1968 | .Sp |
|
|
1969 | Example: simple class declaration and watcher initialisation |
|
|
1970 | .Sp |
|
|
1971 | .Vb 4 |
|
|
1972 | \& struct myclass |
|
|
1973 | \& { |
|
|
1974 | \& void io_cb (ev::io &w, int revents) { } |
|
|
1975 | \& } |
|
|
1976 | .Ve |
|
|
1977 | .Sp |
|
|
1978 | .Vb 3 |
|
|
1979 | \& myclass obj; |
|
|
1980 | \& ev::io iow; |
|
|
1981 | \& iow.set <myclass, &myclass::io_cb> (&obj); |
|
|
1982 | .Ve |
|
|
1983 | .IP "w\->set (void (*function)(watcher &w, int), void *data = 0)" 4 |
|
|
1984 | .IX Item "w->set (void (*function)(watcher &w, int), void *data = 0)" |
|
|
1985 | Also sets a callback, but uses a static method or plain function as |
|
|
1986 | callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's |
|
|
1987 | \&\f(CW\*(C`data\*(C'\fR member and is free for you to use. |
|
|
1988 | .Sp |
|
|
1989 | See the method\-\f(CW\*(C`set\*(C'\fR above for more details. |
1898 | .IP "w\->set (struct ev_loop *)" 4 |
1990 | .IP "w\->set (struct ev_loop *)" 4 |
1899 | .IX Item "w->set (struct ev_loop *)" |
1991 | .IX Item "w->set (struct ev_loop *)" |
1900 | Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only |
1992 | Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only |
1901 | do this when the watcher is inactive (and not pending either). |
1993 | do this when the watcher is inactive (and not pending either). |
1902 | .IP "w\->set ([args])" 4 |
1994 | .IP "w\->set ([args])" 4 |
1903 | .IX Item "w->set ([args])" |
1995 | .IX Item "w->set ([args])" |
1904 | Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be |
1996 | Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be |
1905 | called at least once. Unlike the C counterpart, an active watcher gets |
1997 | called at least once. Unlike the C counterpart, an active watcher gets |
1906 | automatically stopped and restarted. |
1998 | automatically stopped and restarted when reconfiguring it with this |
|
|
1999 | method. |
1907 | .IP "w\->start ()" 4 |
2000 | .IP "w\->start ()" 4 |
1908 | .IX Item "w->start ()" |
2001 | .IX Item "w->start ()" |
1909 | Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument as the |
2002 | Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the |
1910 | constructor already takes the loop. |
2003 | constructor already stores the event loop. |
1911 | .IP "w\->stop ()" 4 |
2004 | .IP "w\->stop ()" 4 |
1912 | .IX Item "w->stop ()" |
2005 | .IX Item "w->stop ()" |
1913 | Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. |
2006 | Stops 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 |
2007 | .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 |
2008 | .el .IP "w\->again () \f(CWev::timer\fR, \f(CWev::periodic\fR only" 4 |
… | |
… | |
1941 | .Vb 2 |
2034 | .Vb 2 |
1942 | \& myclass (); |
2035 | \& myclass (); |
1943 | \& } |
2036 | \& } |
1944 | .Ve |
2037 | .Ve |
1945 | .PP |
2038 | .PP |
1946 | .Vb 6 |
2039 | .Vb 4 |
1947 | \& myclass::myclass (int fd) |
2040 | \& myclass::myclass (int fd) |
1948 | \& : io (this, &myclass::io_cb), |
|
|
1949 | \& idle (this, &myclass::idle_cb) |
|
|
1950 | \& { |
2041 | \& { |
|
|
2042 | \& io .set <myclass, &myclass::io_cb > (this); |
|
|
2043 | \& idle.set <myclass, &myclass::idle_cb> (this); |
|
|
2044 | .Ve |
|
|
2045 | .PP |
|
|
2046 | .Vb 2 |
1951 | \& io.start (fd, ev::READ); |
2047 | \& io.start (fd, ev::READ); |
1952 | \& } |
2048 | \& } |
1953 | .Ve |
2049 | .Ve |
1954 | .SH "MACRO MAGIC" |
2050 | .SH "MACRO MAGIC" |
1955 | .IX Header "MACRO MAGIC" |
2051 | .IX Header "MACRO MAGIC" |
1956 | Libev can be compiled with a variety of options, the most fundemantal is |
2052 | Libev 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 |
2053 | \&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) functions and |
1958 | callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. |
2054 | callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. |
1959 | .PP |
2055 | .PP |
1960 | To make it easier to write programs that cope with either variant, the |
2056 | To make it easier to write programs that cope with either variant, the |
1961 | following macros are defined: |
2057 | following macros are defined: |
1962 | .ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4 |
2058 | .ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4 |
… | |
… | |
1997 | .el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 |
2093 | .el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 |
1998 | .IX Item "EV_DEFAULT, EV_DEFAULT_" |
2094 | .IX Item "EV_DEFAULT, EV_DEFAULT_" |
1999 | Similar to the other two macros, this gives you the value of the default |
2095 | Similar to the other two macros, this gives you the value of the default |
2000 | loop, if multiple loops are supported (\*(L"ev loop default\*(R"). |
2096 | loop, if multiple loops are supported (\*(L"ev loop default\*(R"). |
2001 | .PP |
2097 | .PP |
2002 | Example: Declare and initialise a check watcher, working regardless of |
2098 | Example: Declare and initialise a check watcher, utilising the above |
2003 | wether multiple loops are supported or not. |
2099 | macros so it will work regardless of whether multiple loops are supported |
|
|
2100 | or not. |
2004 | .PP |
2101 | .PP |
2005 | .Vb 5 |
2102 | .Vb 5 |
2006 | \& static void |
2103 | \& static void |
2007 | \& check_cb (EV_P_ ev_timer *w, int revents) |
2104 | \& check_cb (EV_P_ ev_timer *w, int revents) |
2008 | \& { |
2105 | \& { |
… | |
… | |
2071 | .Vb 1 |
2168 | .Vb 1 |
2072 | \& ev_win32.c required on win32 platforms only |
2169 | \& ev_win32.c required on win32 platforms only |
2073 | .Ve |
2170 | .Ve |
2074 | .PP |
2171 | .PP |
2075 | .Vb 5 |
2172 | .Vb 5 |
2076 | \& ev_select.c only when select backend is enabled (which is by default) |
2173 | \& 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) |
2174 | \& 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) |
2175 | \& 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) |
2176 | \& 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) |
2177 | \& ev_port.c only when the solaris port backend is enabled (disabled by default) |
2081 | .Ve |
2178 | .Ve |
… | |
… | |
2234 | If undefined or defined to \f(CW1\fR, then all event-loop-specific functions |
2331 | If undefined or defined to \f(CW1\fR, then all event-loop-specific functions |
2235 | will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create |
2332 | will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create |
2236 | additional independent event loops. Otherwise there will be no support |
2333 | additional independent event loops. Otherwise there will be no support |
2237 | for multiple event loops and there is no first event loop pointer |
2334 | for multiple event loops and there is no first event loop pointer |
2238 | argument. Instead, all functions act on the single default loop. |
2335 | argument. Instead, all functions act on the single default loop. |
|
|
2336 | .IP "\s-1EV_MINPRI\s0" 4 |
|
|
2337 | .IX Item "EV_MINPRI" |
|
|
2338 | .PD 0 |
|
|
2339 | .IP "\s-1EV_MAXPRI\s0" 4 |
|
|
2340 | .IX Item "EV_MAXPRI" |
|
|
2341 | .PD |
|
|
2342 | The range of allowed priorities. \f(CW\*(C`EV_MINPRI\*(C'\fR must be smaller or equal to |
|
|
2343 | \&\f(CW\*(C`EV_MAXPRI\*(C'\fR, but otherwise there are no non-obvious limitations. You can |
|
|
2344 | provide for more priorities by overriding those symbols (usually defined |
|
|
2345 | to be \f(CW\*(C`\-2\*(C'\fR and \f(CW2\fR, respectively). |
|
|
2346 | .Sp |
|
|
2347 | When doing priority-based operations, libev usually has to linearly search |
|
|
2348 | all the priorities, so having many of them (hundreds) uses a lot of space |
|
|
2349 | and time, so using the defaults of five priorities (\-2 .. +2) is usually |
|
|
2350 | fine. |
|
|
2351 | .Sp |
|
|
2352 | If your embedding app does not need any priorities, defining these both to |
|
|
2353 | \&\f(CW0\fR will save some memory and cpu. |
2239 | .IP "\s-1EV_PERIODIC_ENABLE\s0" 4 |
2354 | .IP "\s-1EV_PERIODIC_ENABLE\s0" 4 |
2240 | .IX Item "EV_PERIODIC_ENABLE" |
2355 | .IX Item "EV_PERIODIC_ENABLE" |
2241 | If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If |
2356 | If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If |
|
|
2357 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
|
|
2358 | code. |
|
|
2359 | .IP "\s-1EV_IDLE_ENABLE\s0" 4 |
|
|
2360 | .IX Item "EV_IDLE_ENABLE" |
|
|
2361 | If undefined or defined to be \f(CW1\fR, then idle watchers are supported. If |
2242 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
2362 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
2243 | code. |
2363 | code. |
2244 | .IP "\s-1EV_EMBED_ENABLE\s0" 4 |
2364 | .IP "\s-1EV_EMBED_ENABLE\s0" 4 |
2245 | .IX Item "EV_EMBED_ENABLE" |
2365 | .IX Item "EV_EMBED_ENABLE" |
2246 | If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If |
2366 | If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If |
… | |
… | |
2308 | interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file |
2428 | interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file |
2309 | will be compiled. It is pretty complex because it provides its own header |
2429 | will be compiled. It is pretty complex because it provides its own header |
2310 | file. |
2430 | file. |
2311 | .Sp |
2431 | .Sp |
2312 | The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file |
2432 | The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file |
2313 | that everybody includes and which overrides some autoconf choices: |
2433 | that everybody includes and which overrides some configure choices: |
2314 | .Sp |
2434 | .Sp |
2315 | .Vb 4 |
2435 | .Vb 9 |
|
|
2436 | \& #define EV_MINIMAL 1 |
2316 | \& #define EV_USE_POLL 0 |
2437 | \& #define EV_USE_POLL 0 |
2317 | \& #define EV_MULTIPLICITY 0 |
2438 | \& #define EV_MULTIPLICITY 0 |
2318 | \& #define EV_PERIODICS 0 |
2439 | \& #define EV_PERIODIC_ENABLE 0 |
|
|
2440 | \& #define EV_STAT_ENABLE 0 |
|
|
2441 | \& #define EV_FORK_ENABLE 0 |
2319 | \& #define EV_CONFIG_H <config.h> |
2442 | \& #define EV_CONFIG_H <config.h> |
|
|
2443 | \& #define EV_MINPRI 0 |
|
|
2444 | \& #define EV_MAXPRI 0 |
2320 | .Ve |
2445 | .Ve |
2321 | .Sp |
2446 | .Sp |
2322 | .Vb 1 |
2447 | .Vb 1 |
2323 | \& #include "ev++.h" |
2448 | \& #include "ev++.h" |
2324 | .Ve |
2449 | .Ve |
… | |
… | |
2332 | .SH "COMPLEXITIES" |
2457 | .SH "COMPLEXITIES" |
2333 | .IX Header "COMPLEXITIES" |
2458 | .IX Header "COMPLEXITIES" |
2334 | In this section the complexities of (many of) the algorithms used inside |
2459 | In this section the complexities of (many of) the algorithms used inside |
2335 | libev will be explained. For complexity discussions about backends see the |
2460 | libev will be explained. For complexity discussions about backends see the |
2336 | documentation for \f(CW\*(C`ev_default_init\*(C'\fR. |
2461 | documentation for \f(CW\*(C`ev_default_init\*(C'\fR. |
|
|
2462 | .Sp |
|
|
2463 | All of the following are about amortised time: If an array needs to be |
|
|
2464 | extended, libev needs to realloc and move the whole array, but this |
|
|
2465 | happens asymptotically never with higher number of elements, so O(1) might |
|
|
2466 | mean it might do a lengthy realloc operation in rare cases, but on average |
|
|
2467 | it is much faster and asymptotically approaches constant time. |
2337 | .RS 4 |
2468 | .RS 4 |
2338 | .IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 |
2469 | .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)" |
2470 | .IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" |
2340 | .PD 0 |
2471 | This means that, when you have a watcher that triggers in one hour and |
|
|
2472 | there are 100 watchers that would trigger before that then inserting will |
|
|
2473 | have to skip those 100 watchers. |
2341 | .IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4 |
2474 | .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)" |
2475 | .IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" |
|
|
2476 | That means that for changing a timer costs less than removing/adding them |
|
|
2477 | as 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 |
2478 | .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)" |
2479 | .IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" |
2345 | .IP "Stopping check/prepare/idle watchers: O(1)" 4 |
2480 | These just add the watcher into an array or at the head of a list. |
2346 | .IX Item "Stopping check/prepare/idle watchers: O(1)" |
2481 | =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 |
2482 | .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))" |
2483 | .IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))" |
|
|
2484 | These watchers are stored in lists then need to be walked to find the |
|
|
2485 | correct watcher to remove. The lists are usually short (you don't usually |
|
|
2486 | have many watchers waiting for the same fd or signal). |
2349 | .IP "Finding the next timer per loop iteration: O(1)" 4 |
2487 | .IP "Finding the next timer per loop iteration: O(1)" 4 |
2350 | .IX Item "Finding the next timer per loop iteration: O(1)" |
2488 | .IX Item "Finding the next timer per loop iteration: O(1)" |
|
|
2489 | .PD 0 |
2351 | .IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 |
2490 | .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)" |
2491 | .IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" |
|
|
2492 | .PD |
|
|
2493 | A change means an I/O watcher gets started or stopped, which requires |
|
|
2494 | libev to recalculate its status (and possibly tell the kernel). |
2353 | .IP "Activating one watcher: O(1)" 4 |
2495 | .IP "Activating one watcher: O(1)" 4 |
2354 | .IX Item "Activating one watcher: O(1)" |
2496 | .IX Item "Activating one watcher: O(1)" |
|
|
2497 | .PD 0 |
|
|
2498 | .IP "Priority handling: O(number_of_priorities)" 4 |
|
|
2499 | .IX Item "Priority handling: O(number_of_priorities)" |
|
|
2500 | .PD |
|
|
2501 | Priorities are implemented by allocating some space for each |
|
|
2502 | priority. When doing priority-based operations, libev usually has to |
|
|
2503 | linearly search all the priorities. |
2355 | .RE |
2504 | .RE |
2356 | .RS 4 |
2505 | .RS 4 |
2357 | .PD |
|
|
2358 | .SH "AUTHOR" |
2506 | .SH "AUTHOR" |
2359 | .IX Header "AUTHOR" |
2507 | .IX Header "AUTHOR" |
2360 | Marc Lehmann <libev@schmorp.de>. |
2508 | Marc Lehmann <libev@schmorp.de>. |