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

Comparing libev/ev.pod (file contents):
Revision 1.413 by root, Fri May 4 20:50:02 2012 UTC vs.
Revision 1.420 by root, Sun Jul 1 19:58:12 2012 UTC

… …
82 82
83=head1 WHAT TO READ WHEN IN A HURRY 83=head1 WHAT TO READ WHEN IN A HURRY
84 84
85This manual tries to be very detailed, but unfortunately, this also makes 85This manual tries to be very detailed, but unfortunately, this also makes
86it very long. If you just want to know the basics of libev, I suggest 86it very long. If you just want to know the basics of libev, I suggest
87reading L</ANATOMY OF A WATCHER>, then the L<E/XAMPLE PROGRAM> above and 87reading L</ANATOMY OF A WATCHER>, then the L</EXAMPLE PROGRAM> above and
88look up the missing functions in L</GLOBAL FUNCTIONS> and the C<ev_io> and 88look up the missing functions in L</GLOBAL FUNCTIONS> and the C<ev_io> and
89C<ev_timer> sections in L</WATCHER TYPES>. 89C<ev_timer> sections in L</WATCHER TYPES>.
90 90
91=head1 ABOUT LIBEV 91=head1 ABOUT LIBEV
92 92
… …
2858 2858
2859This mode of operation can be useful together with an C<ev_check> watcher, 2859This mode of operation can be useful together with an C<ev_check> watcher,
2860to do something on each event loop iteration - for example to balance load 2860to do something on each event loop iteration - for example to balance load
2861between different connections. 2861between different connections.
2862 2862
2863See L<< /Abusing an C<ev_check> watcher for its side-effect >> for a longer 2863See L</Abusing an ev_check watcher for its side-effect> for a longer
2864example. 2864example.
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
… …
3950libev sources can be compiled as C++. Therefore, code that uses the C API 3950libev sources can be compiled as C++. Therefore, code that uses the C API
3951will work fine. 3951will work fine.
3952 3952
3953Proper exception specifications might have to be added to callbacks passed 3953Proper exception specifications might have to be added to callbacks passed
3954to libev: exceptions may be thrown only from watcher callbacks, all 3954to libev: exceptions may be thrown only from watcher callbacks, all
3955other callbacks (allocator, syserr, loop acquire/release and periodioc 3955other callbacks (allocator, syserr, loop acquire/release and periodic
3956reschedule callbacks) must not throw exceptions, and might need a C<throw 3956reschedule 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
3958and C++ you can use the C<EV_THROW> macro for this: 3958and C++ you can use the C<EV_THROW> macro for this:
3959 3959
3960 static void 3960 static void
… …
4121Associates a different C<struct ev_loop> with this watcher. You can only 4121Associates a different C<struct ev_loop> with this watcher. You can only
4122do this when the watcher is inactive (and not pending either). 4122do this when the watcher is inactive (and not pending either).
4123 4123
4124=item w->set ([arguments]) 4124=item w->set ([arguments])
4125 4125
4126Basically the same as C<ev_TYPE_set>, with the same arguments. Either this 4126Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>),
4127method or a suitable start method must be called at least once. Unlike the 4127with the same arguments. Either this method or a suitable start method
4128C counterpart, an active watcher gets automatically stopped and restarted 4128must be called at least once. Unlike the C counterpart, an active watcher
4129when reconfiguring it with this method. 4129gets automatically stopped and restarted when reconfiguring it with this
4130method.
4131
4132For C<ev::embed> watchers this method is called C<set_embed>, to avoid
4133clashing with the C<set (loop)> method.
4130 4134
4131=item w->start () 4135=item w->start ()
4132 4136
4133Starts the watcher. Note that there is no C<loop> argument, as the 4137Starts the watcher. Note that there is no C<loop> argument, as the
4134constructor already stores the event loop. 4138constructor already stores the event loop.
… …
4237=item Lua 4241=item Lua
4238 4242
4239Brian Maher has written a partial interface to libev for lua (at the 4243Brian Maher has written a partial interface to libev for lua (at the
4240time of this writing, only C<ev_io> and C<ev_timer>), to be found at 4244time of this writing, only C<ev_io> and C<ev_timer>), to be found at
4241L<http://github.com/brimworks/lua-ev>. 4245L<http://github.com/brimworks/lua-ev>.
4246
4247=item Javascript
4248
4249Node.js (L<http://nodejs.org>) uses libev as the underlying event library.
4250
4251=item Others
4252
4253There 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
4546If programs implement their own fd to handle mapping on win32, then this 4558If programs implement their own fd to handle mapping on win32, then this
4547macro can be used to override the C<close> function, useful to unregister 4559macro can be used to override the C<close> function, useful to unregister
4548file descriptors again. Note that the replacement function has to close 4560file descriptors again. Note that the replacement function has to close
4549the underlying OS handle. 4561the underlying OS handle.
4562
4563=item EV_USE_WSASOCKET
4564
4565If defined to be C<1>, libev will use C<WSASocket> to create its internal
4566communication socket, which works better in some environments. Otherwise,
4567the normal C<socket> function will be used, which works better in other
4568environments.
4550 4569
4551=item EV_USE_POLL 4570=item EV_USE_POLL
4552 4571
4553If defined to be C<1>, libev will compile in support for the C<poll>(2) 4572If defined to be C<1>, libev will compile in support for the C<poll>(2)
4554backend. Otherwise it will be enabled on non-win32 platforms. It 4573backend. Otherwise it will be enabled on non-win32 platforms. It
… …
4606above. This reduces dependencies and makes libev faster. 4625above. This reduces dependencies and makes libev faster.
4607 4626
4608=item EV_ATOMIC_T 4627=item EV_ATOMIC_T
4609 4628
4610Libev requires an integer type (suitable for storing C<0> or C<1>) whose 4629Libev requires an integer type (suitable for storing C<0> or C<1>) whose
4611access is atomic and serialised with respect to other threads or signal 4630access is atomic with respect to other threads or signal contexts. No
4612contexts. No such type is easily found in the C language, so you can 4631such type is easily found in the C language, so you can provide your own
4613provide your own type that you know is safe for your purposes. It is used 4632type that you know is safe for your purposes. It is used both for signal
4614both for signal handler "locking" as well as for signal and thread safety 4633handler "locking" as well as for signal and thread safety in C<ev_async>
4615in C<ev_async> watchers. 4634watchers.
4616 4635
4617In the absence of this define, libev will use C<sig_atomic_t volatile> 4636In the absence of this define, libev will use C<sig_atomic_t volatile>
4618(from F<signal.h>), which is usually good enough on most platforms, 4637(from F<signal.h>), which is usually good enough on most platforms.
4619although strictly speaking using a type that also implies a memory fence
4620is required.
4621 4638
4622=item EV_H (h) 4639=item EV_H (h)
4623 4640
4624The name of the F<ev.h> header file used to include it. The default if 4641The name of the F<ev.h> header file used to include it. The default if
4625undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be 4642undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines