… | |
… | |
486 | libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is |
486 | libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is |
487 | usually a better approach for this kind of thing. |
487 | usually a better approach for this kind of thing. |
488 | |
488 | |
489 | Here are the gory details of what C<ev_loop> does: |
489 | Here are the gory details of what C<ev_loop> does: |
490 | |
490 | |
|
|
491 | - Before the first iteration, call any pending watchers. |
491 | * If there are no active watchers (reference count is zero), return. |
492 | * If there are no active watchers (reference count is zero), return. |
492 | - Queue prepare watchers and then call all outstanding watchers. |
493 | - Queue all prepare watchers and then call all outstanding watchers. |
493 | - If we have been forked, recreate the kernel state. |
494 | - If we have been forked, recreate the kernel state. |
494 | - Update the kernel state with all outstanding changes. |
495 | - Update the kernel state with all outstanding changes. |
495 | - Update the "event loop time". |
496 | - Update the "event loop time". |
496 | - Calculate for how long to block. |
497 | - Calculate for how long to block. |
497 | - Block the process, waiting for any events. |
498 | - Block the process, waiting for any events. |
… | |
… | |
736 | =item bool ev_is_pending (ev_TYPE *watcher) |
737 | =item bool ev_is_pending (ev_TYPE *watcher) |
737 | |
738 | |
738 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
739 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
739 | events but its callback has not yet been invoked). As long as a watcher |
740 | events but its callback has not yet been invoked). As long as a watcher |
740 | is pending (but not active) you must not call an init function on it (but |
741 | is pending (but not active) you must not call an init function on it (but |
741 | C<ev_TYPE_set> is safe) and you must make sure the watcher is available to |
742 | C<ev_TYPE_set> is safe), you must not change its priority, and you must |
742 | libev (e.g. you cnanot C<free ()> it). |
743 | make sure the watcher is available to libev (e.g. you cannot C<free ()> |
|
|
744 | it). |
743 | |
745 | |
744 | =item callback ev_cb (ev_TYPE *watcher) |
746 | =item callback ev_cb (ev_TYPE *watcher) |
745 | |
747 | |
746 | Returns the callback currently set on the watcher. |
748 | Returns the callback currently set on the watcher. |
747 | |
749 | |
… | |
… | |
766 | watchers on the same event and make sure one is called first. |
768 | watchers on the same event and make sure one is called first. |
767 | |
769 | |
768 | If you need to suppress invocation when higher priority events are pending |
770 | If you need to suppress invocation when higher priority events are pending |
769 | you need to look at C<ev_idle> watchers, which provide this functionality. |
771 | you need to look at C<ev_idle> watchers, which provide this functionality. |
770 | |
772 | |
|
|
773 | You I<must not> change the priority of a watcher as long as it is active or |
|
|
774 | pending. |
|
|
775 | |
771 | The default priority used by watchers when no priority has been set is |
776 | The default priority used by watchers when no priority has been set is |
772 | always C<0>, which is supposed to not be too high and not be too low :). |
777 | always C<0>, which is supposed to not be too high and not be too low :). |
773 | |
778 | |
774 | Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is |
779 | Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is |
775 | fine, as long as you do not mind that the priority value you query might |
780 | fine, as long as you do not mind that the priority value you query might |
776 | or might not have been adjusted to be within valid range. |
781 | or might not have been adjusted to be within valid range. |
|
|
782 | |
|
|
783 | =item ev_invoke (loop, ev_TYPE *watcher, int revents) |
|
|
784 | |
|
|
785 | Invoke the C<watcher> with the given C<loop> and C<revents>. Neither |
|
|
786 | C<loop> nor C<revents> need to be valid as long as the watcher callback |
|
|
787 | can deal with that fact. |
|
|
788 | |
|
|
789 | =item int ev_clear_pending (loop, ev_TYPE *watcher) |
|
|
790 | |
|
|
791 | If the watcher is pending, this function returns clears its pending status |
|
|
792 | and returns its C<revents> bitset (as if its callback was invoked). If the |
|
|
793 | watcher isn't pending it does nothing and returns C<0>. |
777 | |
794 | |
778 | =back |
795 | =back |
779 | |
796 | |
780 | |
797 | |
781 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
798 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
… | |
… | |
1465 | with priority higher than or equal to the event loop and one coroutine |
1482 | with priority higher than or equal to the event loop and one coroutine |
1466 | of lower priority, but only once, using idle watchers to keep the event |
1483 | of lower priority, but only once, using idle watchers to keep the event |
1467 | loop from blocking if lower-priority coroutines are active, thus mapping |
1484 | loop from blocking if lower-priority coroutines are active, thus mapping |
1468 | low-priority coroutines to idle/background tasks). |
1485 | low-priority coroutines to idle/background tasks). |
1469 | |
1486 | |
|
|
1487 | It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) |
|
|
1488 | priority, to ensure that they are being run before any other watchers |
|
|
1489 | after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers, |
|
|
1490 | too) should not activate ("feed") events into libev. While libev fully |
|
|
1491 | supports this, they will be called before other C<ev_check> watchers did |
|
|
1492 | their job. As C<ev_check> watchers are often used to embed other event |
|
|
1493 | loops those other event loops might be in an unusable state until their |
|
|
1494 | C<ev_check> watcher ran (always remind yourself to coexist peacefully with |
|
|
1495 | others). |
|
|
1496 | |
1470 | =over 4 |
1497 | =over 4 |
1471 | |
1498 | |
1472 | =item ev_prepare_init (ev_prepare *, callback) |
1499 | =item ev_prepare_init (ev_prepare *, callback) |
1473 | |
1500 | |
1474 | =item ev_check_init (ev_check *, callback) |
1501 | =item ev_check_init (ev_check *, callback) |
… | |
… | |
1477 | parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> |
1504 | parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> |
1478 | macros, but using them is utterly, utterly and completely pointless. |
1505 | macros, but using them is utterly, utterly and completely pointless. |
1479 | |
1506 | |
1480 | =back |
1507 | =back |
1481 | |
1508 | |
1482 | Example: To include a library such as adns, you would add IO watchers |
1509 | There are a number of principal ways to embed other event loops or modules |
1483 | and a timeout watcher in a prepare handler, as required by libadns, and |
1510 | into libev. Here are some ideas on how to include libadns into libev |
|
|
1511 | (there is a Perl module named C<EV::ADNS> that does this, which you could |
|
|
1512 | use for an actually working example. Another Perl module named C<EV::Glib> |
|
|
1513 | embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV |
|
|
1514 | into the Glib event loop). |
|
|
1515 | |
|
|
1516 | Method 1: Add IO watchers and a timeout watcher in a prepare handler, |
1484 | in a check watcher, destroy them and call into libadns. What follows is |
1517 | and in a check watcher, destroy them and call into libadns. What follows |
1485 | pseudo-code only of course: |
1518 | is pseudo-code only of course. This requires you to either use a low |
|
|
1519 | priority for the check watcher or use C<ev_clear_pending> explicitly, as |
|
|
1520 | the callbacks for the IO/timeout watchers might not have been called yet. |
1486 | |
1521 | |
1487 | static ev_io iow [nfd]; |
1522 | static ev_io iow [nfd]; |
1488 | static ev_timer tw; |
1523 | static ev_timer tw; |
1489 | |
1524 | |
1490 | static void |
1525 | static void |
1491 | io_cb (ev_loop *loop, ev_io *w, int revents) |
1526 | io_cb (ev_loop *loop, ev_io *w, int revents) |
1492 | { |
1527 | { |
1493 | // set the relevant poll flags |
|
|
1494 | // could also call adns_processreadable etc. here |
|
|
1495 | struct pollfd *fd = (struct pollfd *)w->data; |
|
|
1496 | if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
|
|
1497 | if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
|
|
1498 | } |
1528 | } |
1499 | |
1529 | |
1500 | // create io watchers for each fd and a timer before blocking |
1530 | // create io watchers for each fd and a timer before blocking |
1501 | static void |
1531 | static void |
1502 | adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
1532 | adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
… | |
… | |
1508 | |
1538 | |
1509 | /* the callback is illegal, but won't be called as we stop during check */ |
1539 | /* the callback is illegal, but won't be called as we stop during check */ |
1510 | ev_timer_init (&tw, 0, timeout * 1e-3); |
1540 | ev_timer_init (&tw, 0, timeout * 1e-3); |
1511 | ev_timer_start (loop, &tw); |
1541 | ev_timer_start (loop, &tw); |
1512 | |
1542 | |
1513 | // create on ev_io per pollfd |
1543 | // create one ev_io per pollfd |
1514 | for (int i = 0; i < nfd; ++i) |
1544 | for (int i = 0; i < nfd; ++i) |
1515 | { |
1545 | { |
1516 | ev_io_init (iow + i, io_cb, fds [i].fd, |
1546 | ev_io_init (iow + i, io_cb, fds [i].fd, |
1517 | ((fds [i].events & POLLIN ? EV_READ : 0) |
1547 | ((fds [i].events & POLLIN ? EV_READ : 0) |
1518 | | (fds [i].events & POLLOUT ? EV_WRITE : 0))); |
1548 | | (fds [i].events & POLLOUT ? EV_WRITE : 0))); |
1519 | |
1549 | |
1520 | fds [i].revents = 0; |
1550 | fds [i].revents = 0; |
1521 | iow [i].data = fds + i; |
|
|
1522 | ev_io_start (loop, iow + i); |
1551 | ev_io_start (loop, iow + i); |
1523 | } |
1552 | } |
1524 | } |
1553 | } |
1525 | |
1554 | |
1526 | // stop all watchers after blocking |
1555 | // stop all watchers after blocking |
… | |
… | |
1528 | adns_check_cb (ev_loop *loop, ev_check *w, int revents) |
1557 | adns_check_cb (ev_loop *loop, ev_check *w, int revents) |
1529 | { |
1558 | { |
1530 | ev_timer_stop (loop, &tw); |
1559 | ev_timer_stop (loop, &tw); |
1531 | |
1560 | |
1532 | for (int i = 0; i < nfd; ++i) |
1561 | for (int i = 0; i < nfd; ++i) |
|
|
1562 | { |
|
|
1563 | // set the relevant poll flags |
|
|
1564 | // could also call adns_processreadable etc. here |
|
|
1565 | struct pollfd *fd = fds + i; |
|
|
1566 | int revents = ev_clear_pending (iow + i); |
|
|
1567 | if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
|
|
1568 | if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
|
|
1569 | |
|
|
1570 | // now stop the watcher |
1533 | ev_io_stop (loop, iow + i); |
1571 | ev_io_stop (loop, iow + i); |
|
|
1572 | } |
1534 | |
1573 | |
1535 | adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); |
1574 | adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); |
|
|
1575 | } |
|
|
1576 | |
|
|
1577 | Method 2: This would be just like method 1, but you run C<adns_afterpoll> |
|
|
1578 | in the prepare watcher and would dispose of the check watcher. |
|
|
1579 | |
|
|
1580 | Method 3: If the module to be embedded supports explicit event |
|
|
1581 | notification (adns does), you can also make use of the actual watcher |
|
|
1582 | callbacks, and only destroy/create the watchers in the prepare watcher. |
|
|
1583 | |
|
|
1584 | static void |
|
|
1585 | timer_cb (EV_P_ ev_timer *w, int revents) |
|
|
1586 | { |
|
|
1587 | adns_state ads = (adns_state)w->data; |
|
|
1588 | update_now (EV_A); |
|
|
1589 | |
|
|
1590 | adns_processtimeouts (ads, &tv_now); |
|
|
1591 | } |
|
|
1592 | |
|
|
1593 | static void |
|
|
1594 | io_cb (EV_P_ ev_io *w, int revents) |
|
|
1595 | { |
|
|
1596 | adns_state ads = (adns_state)w->data; |
|
|
1597 | update_now (EV_A); |
|
|
1598 | |
|
|
1599 | if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now); |
|
|
1600 | if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now); |
|
|
1601 | } |
|
|
1602 | |
|
|
1603 | // do not ever call adns_afterpoll |
|
|
1604 | |
|
|
1605 | Method 4: Do not use a prepare or check watcher because the module you |
|
|
1606 | want to embed is too inflexible to support it. Instead, youc na override |
|
|
1607 | their poll function. The drawback with this solution is that the main |
|
|
1608 | loop is now no longer controllable by EV. The C<Glib::EV> module does |
|
|
1609 | this. |
|
|
1610 | |
|
|
1611 | static gint |
|
|
1612 | event_poll_func (GPollFD *fds, guint nfds, gint timeout) |
|
|
1613 | { |
|
|
1614 | int got_events = 0; |
|
|
1615 | |
|
|
1616 | for (n = 0; n < nfds; ++n) |
|
|
1617 | // create/start io watcher that sets the relevant bits in fds[n] and increment got_events |
|
|
1618 | |
|
|
1619 | if (timeout >= 0) |
|
|
1620 | // create/start timer |
|
|
1621 | |
|
|
1622 | // poll |
|
|
1623 | ev_loop (EV_A_ 0); |
|
|
1624 | |
|
|
1625 | // stop timer again |
|
|
1626 | if (timeout >= 0) |
|
|
1627 | ev_timer_stop (EV_A_ &to); |
|
|
1628 | |
|
|
1629 | // stop io watchers again - their callbacks should have set |
|
|
1630 | for (n = 0; n < nfds; ++n) |
|
|
1631 | ev_io_stop (EV_A_ iow [n]); |
|
|
1632 | |
|
|
1633 | return got_events; |
1536 | } |
1634 | } |
1537 | |
1635 | |
1538 | |
1636 | |
1539 | =head2 C<ev_embed> - when one backend isn't enough... |
1637 | =head2 C<ev_embed> - when one backend isn't enough... |
1540 | |
1638 | |
… | |
… | |
1744 | |
1842 | |
1745 | To use it, |
1843 | To use it, |
1746 | |
1844 | |
1747 | #include <ev++.h> |
1845 | #include <ev++.h> |
1748 | |
1846 | |
1749 | (it is not installed by default). This automatically includes F<ev.h> |
1847 | This automatically includes F<ev.h> and puts all of its definitions (many |
1750 | and puts all of its definitions (many of them macros) into the global |
1848 | of them macros) into the global namespace. All C++ specific things are |
1751 | namespace. All C++ specific things are put into the C<ev> namespace. |
1849 | put into the C<ev> namespace. It should support all the same embedding |
|
|
1850 | options as F<ev.h>, most notably C<EV_MULTIPLICITY>. |
1752 | |
1851 | |
1753 | It should support all the same embedding options as F<ev.h>, most notably |
1852 | Care has been taken to keep the overhead low. The only data member the C++ |
1754 | C<EV_MULTIPLICITY>. |
1853 | classes add (compared to plain C-style watchers) is the event loop pointer |
|
|
1854 | that the watcher is associated with (or no additional members at all if |
|
|
1855 | you disable C<EV_MULTIPLICITY> when embedding libev). |
|
|
1856 | |
|
|
1857 | Currently, functions, and static and non-static member functions can be |
|
|
1858 | used as callbacks. Other types should be easy to add as long as they only |
|
|
1859 | need one additional pointer for context. If you need support for other |
|
|
1860 | types of functors please contact the author (preferably after implementing |
|
|
1861 | it). |
1755 | |
1862 | |
1756 | Here is a list of things available in the C<ev> namespace: |
1863 | Here is a list of things available in the C<ev> namespace: |
1757 | |
1864 | |
1758 | =over 4 |
1865 | =over 4 |
1759 | |
1866 | |
… | |
… | |
1775 | |
1882 | |
1776 | All of those classes have these methods: |
1883 | All of those classes have these methods: |
1777 | |
1884 | |
1778 | =over 4 |
1885 | =over 4 |
1779 | |
1886 | |
1780 | =item ev::TYPE::TYPE (object *, object::method *) |
1887 | =item ev::TYPE::TYPE () |
1781 | |
1888 | |
1782 | =item ev::TYPE::TYPE (object *, object::method *, struct ev_loop *) |
1889 | =item ev::TYPE::TYPE (struct ev_loop *) |
1783 | |
1890 | |
1784 | =item ev::TYPE::~TYPE |
1891 | =item ev::TYPE::~TYPE |
1785 | |
1892 | |
1786 | The constructor takes a pointer to an object and a method pointer to |
1893 | The constructor (optionally) takes an event loop to associate the watcher |
1787 | the event handler callback to call in this class. The constructor calls |
1894 | with. If it is omitted, it will use C<EV_DEFAULT>. |
1788 | C<ev_init> for you, which means you have to call the C<set> method |
1895 | |
1789 | before starting it. If you do not specify a loop then the constructor |
1896 | The constructor calls C<ev_init> for you, which means you have to call the |
1790 | automatically associates the default loop with this watcher. |
1897 | C<set> method before starting it. |
|
|
1898 | |
|
|
1899 | It will not set a callback, however: You have to call the templated C<set> |
|
|
1900 | method to set a callback before you can start the watcher. |
|
|
1901 | |
|
|
1902 | (The reason why you have to use a method is a limitation in C++ which does |
|
|
1903 | not allow explicit template arguments for constructors). |
1791 | |
1904 | |
1792 | The destructor automatically stops the watcher if it is active. |
1905 | The destructor automatically stops the watcher if it is active. |
|
|
1906 | |
|
|
1907 | =item w->set<class, &class::method> (object *) |
|
|
1908 | |
|
|
1909 | This method sets the callback method to call. The method has to have a |
|
|
1910 | signature of C<void (*)(ev_TYPE &, int)>, it receives the watcher as |
|
|
1911 | first argument and the C<revents> as second. The object must be given as |
|
|
1912 | parameter and is stored in the C<data> member of the watcher. |
|
|
1913 | |
|
|
1914 | This method synthesizes efficient thunking code to call your method from |
|
|
1915 | the C callback that libev requires. If your compiler can inline your |
|
|
1916 | callback (i.e. it is visible to it at the place of the C<set> call and |
|
|
1917 | your compiler is good :), then the method will be fully inlined into the |
|
|
1918 | thunking function, making it as fast as a direct C callback. |
|
|
1919 | |
|
|
1920 | Example: simple class declaration and watcher initialisation |
|
|
1921 | |
|
|
1922 | struct myclass |
|
|
1923 | { |
|
|
1924 | void io_cb (ev::io &w, int revents) { } |
|
|
1925 | } |
|
|
1926 | |
|
|
1927 | myclass obj; |
|
|
1928 | ev::io iow; |
|
|
1929 | iow.set <myclass, &myclass::io_cb> (&obj); |
|
|
1930 | |
|
|
1931 | =item w->set<function> (void *data = 0) |
|
|
1932 | |
|
|
1933 | Also sets a callback, but uses a static method or plain function as |
|
|
1934 | callback. The optional C<data> argument will be stored in the watcher's |
|
|
1935 | C<data> member and is free for you to use. |
|
|
1936 | |
|
|
1937 | The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>. |
|
|
1938 | |
|
|
1939 | See the method-C<set> above for more details. |
|
|
1940 | |
|
|
1941 | Example: |
|
|
1942 | |
|
|
1943 | static void io_cb (ev::io &w, int revents) { } |
|
|
1944 | iow.set <io_cb> (); |
1793 | |
1945 | |
1794 | =item w->set (struct ev_loop *) |
1946 | =item w->set (struct ev_loop *) |
1795 | |
1947 | |
1796 | Associates a different C<struct ev_loop> with this watcher. You can only |
1948 | Associates a different C<struct ev_loop> with this watcher. You can only |
1797 | do this when the watcher is inactive (and not pending either). |
1949 | do this when the watcher is inactive (and not pending either). |
1798 | |
1950 | |
1799 | =item w->set ([args]) |
1951 | =item w->set ([args]) |
1800 | |
1952 | |
1801 | Basically the same as C<ev_TYPE_set>, with the same args. Must be |
1953 | Basically the same as C<ev_TYPE_set>, with the same args. Must be |
1802 | called at least once. Unlike the C counterpart, an active watcher gets |
1954 | called at least once. Unlike the C counterpart, an active watcher gets |
1803 | automatically stopped and restarted. |
1955 | automatically stopped and restarted when reconfiguring it with this |
|
|
1956 | method. |
1804 | |
1957 | |
1805 | =item w->start () |
1958 | =item w->start () |
1806 | |
1959 | |
1807 | Starts the watcher. Note that there is no C<loop> argument as the |
1960 | Starts the watcher. Note that there is no C<loop> argument, as the |
1808 | constructor already takes the loop. |
1961 | constructor already stores the event loop. |
1809 | |
1962 | |
1810 | =item w->stop () |
1963 | =item w->stop () |
1811 | |
1964 | |
1812 | Stops the watcher if it is active. Again, no C<loop> argument. |
1965 | Stops the watcher if it is active. Again, no C<loop> argument. |
1813 | |
1966 | |
… | |
… | |
1838 | |
1991 | |
1839 | myclass (); |
1992 | myclass (); |
1840 | } |
1993 | } |
1841 | |
1994 | |
1842 | myclass::myclass (int fd) |
1995 | myclass::myclass (int fd) |
1843 | : io (this, &myclass::io_cb), |
|
|
1844 | idle (this, &myclass::idle_cb) |
|
|
1845 | { |
1996 | { |
|
|
1997 | io .set <myclass, &myclass::io_cb > (this); |
|
|
1998 | idle.set <myclass, &myclass::idle_cb> (this); |
|
|
1999 | |
1846 | io.start (fd, ev::READ); |
2000 | io.start (fd, ev::READ); |
1847 | } |
2001 | } |
1848 | |
2002 | |
1849 | |
2003 | |
1850 | =head1 MACRO MAGIC |
2004 | =head1 MACRO MAGIC |