… | |
… | |
82 | |
82 | |
83 | =head1 WHAT TO READ WHEN IN A HURRY |
83 | =head1 WHAT TO READ WHEN IN A HURRY |
84 | |
84 | |
85 | This manual tries to be very detailed, but unfortunately, this also makes |
85 | This manual tries to be very detailed, but unfortunately, this also makes |
86 | it very long. If you just want to know the basics of libev, I suggest |
86 | it very long. If you just want to know the basics of libev, I suggest |
87 | reading L</ANATOMY OF A WATCHER>, then the L<E/XAMPLE PROGRAM> above and |
87 | reading L</ANATOMY OF A WATCHER>, then the L</EXAMPLE PROGRAM> above and |
88 | look up the missing functions in L</GLOBAL FUNCTIONS> and the C<ev_io> and |
88 | look up the missing functions in L</GLOBAL FUNCTIONS> and the C<ev_io> and |
89 | C<ev_timer> sections in L</WATCHER TYPES>. |
89 | C<ev_timer> sections in L</WATCHER TYPES>. |
90 | |
90 | |
91 | =head1 ABOUT LIBEV |
91 | =head1 ABOUT LIBEV |
92 | |
92 | |
… | |
… | |
2858 | |
2858 | |
2859 | This mode of operation can be useful together with an C<ev_check> watcher, |
2859 | This mode of operation can be useful together with an C<ev_check> watcher, |
2860 | to do something on each event loop iteration - for example to balance load |
2860 | to do something on each event loop iteration - for example to balance load |
2861 | between different connections. |
2861 | between different connections. |
2862 | |
2862 | |
2863 | See L<< /Abusing an C<ev_check> watcher for its side-effect >> for a longer |
2863 | See L</Abusing an ev_check watcher for its side-effect> for a longer |
2864 | example. |
2864 | example. |
2865 | |
2865 | |
2866 | =head3 Watcher-Specific Functions and Data Members |
2866 | =head3 Watcher-Specific Functions and Data Members |
2867 | |
2867 | |
2868 | =over 4 |
2868 | =over 4 |
… | |
… | |
3950 | libev sources can be compiled as C++. Therefore, code that uses the C API |
3950 | libev sources can be compiled as C++. Therefore, code that uses the C API |
3951 | will work fine. |
3951 | will work fine. |
3952 | |
3952 | |
3953 | Proper exception specifications might have to be added to callbacks passed |
3953 | Proper exception specifications might have to be added to callbacks passed |
3954 | to libev: exceptions may be thrown only from watcher callbacks, all |
3954 | to libev: exceptions may be thrown only from watcher callbacks, all |
3955 | other callbacks (allocator, syserr, loop acquire/release and periodioc |
3955 | other callbacks (allocator, syserr, loop acquire/release and periodic |
3956 | reschedule callbacks) must not throw exceptions, and might need a C<throw |
3956 | reschedule callbacks) must not throw exceptions, and might need a C<throw |
3957 | ()> specification. If you have code that needs to be compiled as both C |
3957 | ()> specification. If you have code that needs to be compiled as both C |
3958 | and C++ you can use the C<EV_THROW> macro for this: |
3958 | and C++ you can use the C<EV_THROW> macro for this: |
3959 | |
3959 | |
3960 | static void |
3960 | static void |
… | |
… | |
4121 | Associates a different C<struct ev_loop> with this watcher. You can only |
4121 | Associates a different C<struct ev_loop> with this watcher. You can only |
4122 | do this when the watcher is inactive (and not pending either). |
4122 | do this when the watcher is inactive (and not pending either). |
4123 | |
4123 | |
4124 | =item w->set ([arguments]) |
4124 | =item w->set ([arguments]) |
4125 | |
4125 | |
4126 | Basically the same as C<ev_TYPE_set>, with the same arguments. Either this |
4126 | Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>), |
4127 | method or a suitable start method must be called at least once. Unlike the |
4127 | with the same arguments. Either this method or a suitable start method |
4128 | C counterpart, an active watcher gets automatically stopped and restarted |
4128 | must be called at least once. Unlike the C counterpart, an active watcher |
4129 | when reconfiguring it with this method. |
4129 | gets automatically stopped and restarted when reconfiguring it with this |
|
|
4130 | method. |
|
|
4131 | |
|
|
4132 | For C<ev::embed> watchers this method is called C<set_embed>, to avoid |
|
|
4133 | clashing with the C<set (loop)> method. |
4130 | |
4134 | |
4131 | =item w->start () |
4135 | =item w->start () |
4132 | |
4136 | |
4133 | Starts the watcher. Note that there is no C<loop> argument, as the |
4137 | Starts the watcher. Note that there is no C<loop> argument, as the |
4134 | constructor already stores the event loop. |
4138 | constructor already stores the event loop. |
… | |
… | |
4237 | =item Lua |
4241 | =item Lua |
4238 | |
4242 | |
4239 | Brian Maher has written a partial interface to libev for lua (at the |
4243 | Brian Maher has written a partial interface to libev for lua (at the |
4240 | time of this writing, only C<ev_io> and C<ev_timer>), to be found at |
4244 | time of this writing, only C<ev_io> and C<ev_timer>), to be found at |
4241 | L<http://github.com/brimworks/lua-ev>. |
4245 | L<http://github.com/brimworks/lua-ev>. |
|
|
4246 | |
|
|
4247 | =item Javascript |
|
|
4248 | |
|
|
4249 | Node.js (L<http://nodejs.org>) uses libev as the underlying event library. |
|
|
4250 | |
|
|
4251 | =item Others |
|
|
4252 | |
|
|
4253 | There are others, and I stopped counting. |
4242 | |
4254 | |
4243 | =back |
4255 | =back |
4244 | |
4256 | |
4245 | |
4257 | |
4246 | =head1 MACRO MAGIC |
4258 | =head1 MACRO MAGIC |
… | |
… | |
4545 | |
4557 | |
4546 | If programs implement their own fd to handle mapping on win32, then this |
4558 | If programs implement their own fd to handle mapping on win32, then this |
4547 | macro can be used to override the C<close> function, useful to unregister |
4559 | macro can be used to override the C<close> function, useful to unregister |
4548 | file descriptors again. Note that the replacement function has to close |
4560 | file descriptors again. Note that the replacement function has to close |
4549 | the underlying OS handle. |
4561 | the underlying OS handle. |
|
|
4562 | |
|
|
4563 | =item EV_USE_WSASOCKET |
|
|
4564 | |
|
|
4565 | If defined to be C<1>, libev will use C<WSASocket> to create its internal |
|
|
4566 | communication socket, which works better in some environments. Otherwise, |
|
|
4567 | the normal C<socket> function will be used, which works better in other |
|
|
4568 | environments. |
4550 | |
4569 | |
4551 | =item EV_USE_POLL |
4570 | =item EV_USE_POLL |
4552 | |
4571 | |
4553 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
4572 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
4554 | backend. Otherwise it will be enabled on non-win32 platforms. It |
4573 | backend. Otherwise it will be enabled on non-win32 platforms. It |