| … | |
… | |
| 1536 | \& idle (this, &myclass::idle_cb) |
1536 | \& idle (this, &myclass::idle_cb) |
| 1537 | \& { |
1537 | \& { |
| 1538 | \& io.start (fd, ev::READ); |
1538 | \& io.start (fd, ev::READ); |
| 1539 | \& } |
1539 | \& } |
| 1540 | .Ve |
1540 | .Ve |
|
|
1541 | .SH "EMBEDDING" |
|
|
1542 | .IX Header "EMBEDDING" |
|
|
1543 | Libev can (and often is) directly embedded into host |
|
|
1544 | applications. Examples of applications that embed it include the Deliantra |
|
|
1545 | Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe) |
|
|
1546 | and rxvt\-unicode. |
|
|
1547 | .PP |
|
|
1548 | The goal is to enable you to just copy the neecssary files into your |
|
|
1549 | source directory without having to change even a single line in them, so |
|
|
1550 | you can easily upgrade by simply copying (or having a checked-out copy of |
|
|
1551 | libev somewhere in your source tree). |
|
|
1552 | .Sh "\s-1FILESETS\s0" |
|
|
1553 | .IX Subsection "FILESETS" |
|
|
1554 | Depending on what features you need you need to include one or more sets of files |
|
|
1555 | in your app. |
|
|
1556 | .PP |
|
|
1557 | \fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR |
|
|
1558 | .IX Subsection "CORE EVENT LOOP" |
|
|
1559 | .PP |
|
|
1560 | To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual |
|
|
1561 | configuration (no autoconf): |
|
|
1562 | .PP |
|
|
1563 | .Vb 2 |
|
|
1564 | \& #define EV_STANDALONE 1 |
|
|
1565 | \& #include "ev.c" |
|
|
1566 | .Ve |
|
|
1567 | .PP |
|
|
1568 | This will automatically include \fIev.h\fR, too, and should be done in a |
|
|
1569 | single C source file only to provide the function implementations. To use |
|
|
1570 | it, do the same for \fIev.h\fR in all files wishing to use this \s-1API\s0 (best |
|
|
1571 | done by writing a wrapper around \fIev.h\fR that you can include instead and |
|
|
1572 | where you can put other configuration options): |
|
|
1573 | .PP |
|
|
1574 | .Vb 2 |
|
|
1575 | \& #define EV_STANDALONE 1 |
|
|
1576 | \& #include "ev.h" |
|
|
1577 | .Ve |
|
|
1578 | .PP |
|
|
1579 | Both header files and implementation files can be compiled with a \*(C+ |
|
|
1580 | compiler (at least, thats a stated goal, and breakage will be treated |
|
|
1581 | as a bug). |
|
|
1582 | .PP |
|
|
1583 | You need the following files in your source tree, or in a directory |
|
|
1584 | in your include path (e.g. in libev/ when using \-Ilibev): |
|
|
1585 | .PP |
|
|
1586 | .Vb 4 |
|
|
1587 | \& ev.h |
|
|
1588 | \& ev.c |
|
|
1589 | \& ev_vars.h |
|
|
1590 | \& ev_wrap.h |
|
|
1591 | .Ve |
|
|
1592 | .PP |
|
|
1593 | .Vb 1 |
|
|
1594 | \& ev_win32.c required on win32 platforms only |
|
|
1595 | .Ve |
|
|
1596 | .PP |
|
|
1597 | .Vb 5 |
|
|
1598 | \& ev_select.c only when select backend is enabled (which is is by default) |
|
|
1599 | \& ev_poll.c only when poll backend is enabled (disabled by default) |
|
|
1600 | \& ev_epoll.c only when the epoll backend is enabled (disabled by default) |
|
|
1601 | \& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
|
|
1602 | \& ev_port.c only when the solaris port backend is enabled (disabled by default) |
|
|
1603 | .Ve |
|
|
1604 | .PP |
|
|
1605 | \&\fIev.c\fR includes the backend files directly when enabled, so you only need |
|
|
1606 | to compile a single file. |
|
|
1607 | .PP |
|
|
1608 | \fI\s-1LIBEVENT\s0 \s-1COMPATIBILITY\s0 \s-1API\s0\fR |
|
|
1609 | .IX Subsection "LIBEVENT COMPATIBILITY API" |
|
|
1610 | .PP |
|
|
1611 | To include the libevent compatibility \s-1API\s0, also include: |
|
|
1612 | .PP |
|
|
1613 | .Vb 1 |
|
|
1614 | \& #include "event.c" |
|
|
1615 | .Ve |
|
|
1616 | .PP |
|
|
1617 | in the file including \fIev.c\fR, and: |
|
|
1618 | .PP |
|
|
1619 | .Vb 1 |
|
|
1620 | \& #include "event.h" |
|
|
1621 | .Ve |
|
|
1622 | .PP |
|
|
1623 | in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR. |
|
|
1624 | .PP |
|
|
1625 | You need the following additional files for this: |
|
|
1626 | .PP |
|
|
1627 | .Vb 2 |
|
|
1628 | \& event.h |
|
|
1629 | \& event.c |
|
|
1630 | .Ve |
|
|
1631 | .PP |
|
|
1632 | \fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR |
|
|
1633 | .IX Subsection "AUTOCONF SUPPORT" |
|
|
1634 | .PP |
|
|
1635 | Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your config in |
|
|
1636 | whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your |
|
|
1637 | \&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR off. \fIev.c\fR will then include |
|
|
1638 | \&\fIconfig.h\fR and configure itself accordingly. |
|
|
1639 | .PP |
|
|
1640 | For this of course you need the m4 file: |
|
|
1641 | .PP |
|
|
1642 | .Vb 1 |
|
|
1643 | \& libev.m4 |
|
|
1644 | .Ve |
|
|
1645 | .Sh "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" |
|
|
1646 | .IX Subsection "PREPROCESSOR SYMBOLS/MACROS" |
|
|
1647 | Libev can be configured via a variety of preprocessor symbols you have to define |
|
|
1648 | before including any of its files. The default is not to build for multiplicity |
|
|
1649 | and only include the select backend. |
|
|
1650 | .IP "\s-1EV_STANDALONE\s0" 4 |
|
|
1651 | .IX Item "EV_STANDALONE" |
|
|
1652 | Must always be \f(CW1\fR if you do not use autoconf configuration, which |
|
|
1653 | keeps libev from including \fIconfig.h\fR, and it also defines dummy |
|
|
1654 | implementations for some libevent functions (such as logging, which is not |
|
|
1655 | supported). It will also not define any of the structs usually found in |
|
|
1656 | \&\fIevent.h\fR that are not directly supported by the libev core alone. |
|
|
1657 | .IP "\s-1EV_USE_MONOTONIC\s0" 4 |
|
|
1658 | .IX Item "EV_USE_MONOTONIC" |
|
|
1659 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
|
|
1660 | monotonic clock option at both compiletime and runtime. Otherwise no use |
|
|
1661 | of the monotonic clock option will be attempted. If you enable this, you |
|
|
1662 | usually have to link against librt or something similar. Enabling it when |
|
|
1663 | the functionality isn't available is safe, though, althoguh you have |
|
|
1664 | to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR |
|
|
1665 | function is hiding in (often \fI\-lrt\fR). |
|
|
1666 | .IP "\s-1EV_USE_REALTIME\s0" 4 |
|
|
1667 | .IX Item "EV_USE_REALTIME" |
|
|
1668 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
|
|
1669 | realtime clock option at compiletime (and assume its availability at |
|
|
1670 | runtime if successful). Otherwise no use of the realtime clock option will |
|
|
1671 | be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR by \f(CW\*(C`clock_get |
|
|
1672 | (CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect correctness. See tzhe note about libraries |
|
|
1673 | in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. |
|
|
1674 | .IP "\s-1EV_USE_SELECT\s0" 4 |
|
|
1675 | .IX Item "EV_USE_SELECT" |
|
|
1676 | If undefined or defined to be \f(CW1\fR, libev will compile in support for the |
|
|
1677 | \&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at autodetection will be done: if no |
|
|
1678 | other method takes over, select will be it. Otherwise the select backend |
|
|
1679 | will not be compiled in. |
|
|
1680 | .IP "\s-1EV_SELECT_USE_FD_SET\s0" 4 |
|
|
1681 | .IX Item "EV_SELECT_USE_FD_SET" |
|
|
1682 | If defined to \f(CW1\fR, then the select backend will use the system \f(CW\*(C`fd_set\*(C'\fR |
|
|
1683 | structure. This is useful if libev doesn't compile due to a missing |
|
|
1684 | \&\f(CW\*(C`NFDBITS\*(C'\fR or \f(CW\*(C`fd_mask\*(C'\fR definition or it misguesses the bitset layout on |
|
|
1685 | exotic systems. This usually limits the range of file descriptors to some |
|
|
1686 | low limit such as 1024 or might have other limitations (winsocket only |
|
|
1687 | allows 64 sockets). The \f(CW\*(C`FD_SETSIZE\*(C'\fR macro, set before compilation, might |
|
|
1688 | influence the size of the \f(CW\*(C`fd_set\*(C'\fR used. |
|
|
1689 | .IP "\s-1EV_SELECT_IS_WINSOCKET\s0" 4 |
|
|
1690 | .IX Item "EV_SELECT_IS_WINSOCKET" |
|
|
1691 | When defined to \f(CW1\fR, the select backend will assume that |
|
|
1692 | select/socket/connect etc. don't understand file descriptors but |
|
|
1693 | wants osf handles on win32 (this is the case when the select to |
|
|
1694 | be used is the winsock select). This means that it will call |
|
|
1695 | \&\f(CW\*(C`_get_osfhandle\*(C'\fR on the fd to convert it to an \s-1OS\s0 handle. Otherwise, |
|
|
1696 | it is assumed that all these functions actually work on fds, even |
|
|
1697 | on win32. Should not be defined on non\-win32 platforms. |
|
|
1698 | .IP "\s-1EV_USE_POLL\s0" 4 |
|
|
1699 | .IX Item "EV_USE_POLL" |
|
|
1700 | If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2) |
|
|
1701 | backend. Otherwise it will be enabled on non\-win32 platforms. It |
|
|
1702 | takes precedence over select. |
|
|
1703 | .IP "\s-1EV_USE_EPOLL\s0" 4 |
|
|
1704 | .IX Item "EV_USE_EPOLL" |
|
|
1705 | If defined to be \f(CW1\fR, libev will compile in support for the Linux |
|
|
1706 | \&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime, |
|
|
1707 | otherwise another method will be used as fallback. This is the |
|
|
1708 | preferred backend for GNU/Linux systems. |
|
|
1709 | .IP "\s-1EV_USE_KQUEUE\s0" 4 |
|
|
1710 | .IX Item "EV_USE_KQUEUE" |
|
|
1711 | If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style |
|
|
1712 | \&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime, |
|
|
1713 | otherwise another method will be used as fallback. This is the preferred |
|
|
1714 | backend for \s-1BSD\s0 and BSD-like systems, although on most BSDs kqueue only |
|
|
1715 | supports some types of fds correctly (the only platform we found that |
|
|
1716 | supports ptys for example was NetBSD), so kqueue might be compiled in, but |
|
|
1717 | not be used unless explicitly requested. The best way to use it is to find |
|
|
1718 | out wether kqueue supports your type of fd properly and use an embedded |
|
|
1719 | kqueue loop. |
|
|
1720 | .IP "\s-1EV_USE_PORT\s0" 4 |
|
|
1721 | .IX Item "EV_USE_PORT" |
|
|
1722 | If defined to be \f(CW1\fR, libev will compile in support for the Solaris |
|
|
1723 | 10 port style backend. Its availability will be detected at runtime, |
|
|
1724 | otherwise another method will be used as fallback. This is the preferred |
|
|
1725 | backend for Solaris 10 systems. |
|
|
1726 | .IP "\s-1EV_USE_DEVPOLL\s0" 4 |
|
|
1727 | .IX Item "EV_USE_DEVPOLL" |
|
|
1728 | reserved for future expansion, works like the \s-1USE\s0 symbols above. |
|
|
1729 | .IP "\s-1EV_H\s0" 4 |
|
|
1730 | .IX Item "EV_H" |
|
|
1731 | The name of the \fIev.h\fR header file used to include it. The default if |
|
|
1732 | undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This |
|
|
1733 | can be used to virtually rename the \fIev.h\fR header file in case of conflicts. |
|
|
1734 | .IP "\s-1EV_CONFIG_H\s0" 4 |
|
|
1735 | .IX Item "EV_CONFIG_H" |
|
|
1736 | If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override |
|
|
1737 | \&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to |
|
|
1738 | \&\f(CW\*(C`EV_H\*(C'\fR, above. |
|
|
1739 | .IP "\s-1EV_EVENT_H\s0" 4 |
|
|
1740 | .IX Item "EV_EVENT_H" |
|
|
1741 | Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea |
|
|
1742 | of how the \fIevent.h\fR header can be found. |
|
|
1743 | .IP "\s-1EV_PROTOTYPES\s0" 4 |
|
|
1744 | .IX Item "EV_PROTOTYPES" |
|
|
1745 | If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function |
|
|
1746 | prototypes, but still define all the structs and other symbols. This is |
|
|
1747 | occasionally useful if you want to provide your own wrapper functions |
|
|
1748 | around libev functions. |
|
|
1749 | .IP "\s-1EV_MULTIPLICITY\s0" 4 |
|
|
1750 | .IX Item "EV_MULTIPLICITY" |
|
|
1751 | If undefined or defined to \f(CW1\fR, then all event-loop-specific functions |
|
|
1752 | will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create |
|
|
1753 | additional independent event loops. Otherwise there will be no support |
|
|
1754 | for multiple event loops and there is no first event loop pointer |
|
|
1755 | argument. Instead, all functions act on the single default loop. |
|
|
1756 | .IP "\s-1EV_PERIODICS\s0" 4 |
|
|
1757 | .IX Item "EV_PERIODICS" |
|
|
1758 | If undefined or defined to be \f(CW1\fR, then periodic timers are supported, |
|
|
1759 | otherwise not. This saves a few kb of code. |
|
|
1760 | .IP "\s-1EV_COMMON\s0" 4 |
|
|
1761 | .IX Item "EV_COMMON" |
|
|
1762 | By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining |
|
|
1763 | this macro to a something else you can include more and other types of |
|
|
1764 | members. You have to define it each time you include one of the files, |
|
|
1765 | though, and it must be identical each time. |
|
|
1766 | .Sp |
|
|
1767 | For example, the perl \s-1EV\s0 module uses something like this: |
|
|
1768 | .Sp |
|
|
1769 | .Vb 3 |
|
|
1770 | \& #define EV_COMMON \e |
|
|
1771 | \& SV *self; /* contains this struct */ \e |
|
|
1772 | \& SV *cb_sv, *fh /* note no trailing ";" */ |
|
|
1773 | .Ve |
|
|
1774 | .IP "\s-1EV_CB_DECLARE\s0(type)" 4 |
|
|
1775 | .IX Item "EV_CB_DECLARE(type)" |
|
|
1776 | .PD 0 |
|
|
1777 | .IP "\s-1EV_CB_INVOKE\s0(watcher,revents)" 4 |
|
|
1778 | .IX Item "EV_CB_INVOKE(watcher,revents)" |
|
|
1779 | .IP "ev_set_cb(ev,cb)" 4 |
|
|
1780 | .IX Item "ev_set_cb(ev,cb)" |
|
|
1781 | .PD |
|
|
1782 | Can be used to change the callback member declaration in each watcher, |
|
|
1783 | and the way callbacks are invoked and set. Must expand to a struct member |
|
|
1784 | definition and a statement, respectively. See the \fIev.v\fR header file for |
|
|
1785 | their default definitions. One possible use for overriding these is to |
|
|
1786 | avoid the ev_loop pointer as first argument in all cases, or to use method |
|
|
1787 | calls instead of plain function calls in \*(C+. |
|
|
1788 | .Sh "\s-1EXAMPLES\s0" |
|
|
1789 | .IX Subsection "EXAMPLES" |
|
|
1790 | For a real-world example of a program the includes libev |
|
|
1791 | verbatim, you can have a look at the \s-1EV\s0 perl module |
|
|
1792 | (<http://software.schmorp.de/pkg/EV.html>). It has the libev files in |
|
|
1793 | the \fIlibev/\fR subdirectory and includes them in the \fI\s-1EV/EVAPI\s0.h\fR (public |
|
|
1794 | interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file |
|
|
1795 | will be compiled. It is pretty complex because it provides its own header |
|
|
1796 | file. |
|
|
1797 | .Sp |
|
|
1798 | The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file |
|
|
1799 | that everybody includes and which overrides some autoconf choices: |
|
|
1800 | .Sp |
|
|
1801 | .Vb 4 |
|
|
1802 | \& #define EV_USE_POLL 0 |
|
|
1803 | \& #define EV_MULTIPLICITY 0 |
|
|
1804 | \& #define EV_PERIODICS 0 |
|
|
1805 | \& #define EV_CONFIG_H <config.h> |
|
|
1806 | .Ve |
|
|
1807 | .Sp |
|
|
1808 | .Vb 1 |
|
|
1809 | \& #include "ev++.h" |
|
|
1810 | .Ve |
|
|
1811 | .Sp |
|
|
1812 | And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled: |
|
|
1813 | .Sp |
|
|
1814 | .Vb 1 |
|
|
1815 | \& #include "rxvttoolkit.h" |
|
|
1816 | .Ve |
|
|
1817 | .Sp |
|
|
1818 | .Vb 2 |
|
|
1819 | \& /* darwin has problems with its header files in C++, requiring this namespace juggling */ |
|
|
1820 | \& using namespace ev; |
|
|
1821 | .Ve |
|
|
1822 | .Sp |
|
|
1823 | .Vb 1 |
|
|
1824 | \& #include "ev.c" |
|
|
1825 | .Ve |
| 1541 | .SH "AUTHOR" |
1826 | .SH "AUTHOR" |
| 1542 | .IX Header "AUTHOR" |
1827 | .IX Header "AUTHOR" |
| 1543 | Marc Lehmann <libev@schmorp.de>. |
1828 | Marc Lehmann <libev@schmorp.de>. |
