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

Comparing libev/ev.pod (file contents):
Revision 1.144 by root, Mon Apr 7 12:33:29 2008 UTC vs.
Revision 1.148 by root, Thu Apr 24 01:42:11 2008 UTC

196See the description of C<ev_embed> watchers for more info. 196See the description of C<ev_embed> watchers for more info.
197 197
198=item ev_set_allocator (void *(*cb)(void *ptr, long size)) 198=item ev_set_allocator (void *(*cb)(void *ptr, long size))
199 199
200Sets the allocation function to use (the prototype is similar - the 200Sets the allocation function to use (the prototype is similar - the
201semantics is identical - to the realloc C function). It is used to 201semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
202allocate and free memory (no surprises here). If it returns zero when 202used to allocate and free memory (no surprises here). If it returns zero
203memory needs to be allocated, the library might abort or take some 203when memory needs to be allocated (C<size != 0>), the library might abort
204potentially destructive action. The default is your system realloc 204or take some potentially destructive action.
205function. 205
206Since some systems (at least OpenBSD and Darwin) fail to implement
207correct C<realloc> semantics, libev will use a wrapper around the system
208C<realloc> and C<free> functions by default.
206 209
207You could override this function in high-availability programs to, say, 210You could override this function in high-availability programs to, say,
208free some memory if it cannot allocate memory, to use a special allocator, 211free some memory if it cannot allocate memory, to use a special allocator,
209or even to sleep a while and retry until some memory is available. 212or even to sleep a while and retry until some memory is available.
210 213
211Example: Replace the libev allocator with one that waits a bit and then 214Example: Replace the libev allocator with one that waits a bit and then
212retries). 215retries (example requires a standards-compliant C<realloc>).
213 216
214 static void * 217 static void *
215 persistent_realloc (void *ptr, size_t size) 218 persistent_realloc (void *ptr, size_t size)
216 { 219 {
217 for (;;) 220 for (;;)
1631When C<inotify (7)> support has been compiled into libev (generally only 1634When C<inotify (7)> support has been compiled into libev (generally only
1632available on Linux) and present at runtime, it will be used to speed up 1635available on Linux) and present at runtime, it will be used to speed up
1633change detection where possible. The inotify descriptor will be created lazily 1636change detection where possible. The inotify descriptor will be created lazily
1634when the first C<ev_stat> watcher is being started. 1637when the first C<ev_stat> watcher is being started.
1635 1638
1636Inotify presense does not change the semantics of C<ev_stat> watchers 1639Inotify presence does not change the semantics of C<ev_stat> watchers
1637except that changes might be detected earlier, and in some cases, to avoid 1640except that changes might be detected earlier, and in some cases, to avoid
1638making regular C<stat> calls. Even in the presense of inotify support 1641making regular C<stat> calls. Even in the presence of inotify support
1639there are many cases where libev has to resort to regular C<stat> polling. 1642there are many cases where libev has to resort to regular C<stat> polling.
1640 1643
1641(There is no support for kqueue, as apparently it cannot be used to 1644(There is no support for kqueue, as apparently it cannot be used to
1642implement this functionality, due to the requirement of having a file 1645implement this functionality, due to the requirement of having a file
1643descriptor open on the object at all times). 1646descriptor open on the object at all times).
2375 2378
2376=item * Priorities are not currently supported. Initialising priorities 2379=item * Priorities are not currently supported. Initialising priorities
2377will fail and all watchers will have the same priority, even though there 2380will fail and all watchers will have the same priority, even though there
2378is an ev_pri field. 2381is an ev_pri field.
2379 2382
2383=item * In libevent, the last base created gets the signals, in libev, the
2384first base created (== the default loop) gets the signals.
2385
2380=item * Other members are not supported. 2386=item * Other members are not supported.
2381 2387
2382=item * The libev emulation is I<not> ABI compatible to libevent, you need 2388=item * The libev emulation is I<not> ABI compatible to libevent, you need
2383to use the libev header file and library. 2389to use the libev header file and library.
2384 2390
3254calling select (O(n²)) will likely make this unworkable. 3260calling select (O(n²)) will likely make this unworkable.
3255 3261
3256=back 3262=back
3257 3263
3258 3264
3265=head1 PORTABILITY REQUIREMENTS
3266
3267In addition to a working ISO-C implementation, libev relies on a few
3268additional extensions:
3269
3270=over 4
3271
3272=item C<sig_atomic_t volatile> must be thread-atomic as well
3273
3274The type C<sig_atomic_t volatile> (or whatever is defined as
3275C<EV_ATOMIC_T>) must be atomic w.r.t. accesses from different
3276threads. This is not part of the specification for C<sig_atomic_t>, but is
3277believed to be sufficiently portable.
3278
3279=item C<sigprocmask> must work in a threaded environment
3280
3281Libev uses C<sigprocmask> to temporarily block signals. This is not
3282allowed in a threaded program (C<pthread_sigmask> has to be used). Typical
3283pthread implementations will either allow C<sigprocmask> in the "main
3284thread" or will block signals process-wide, both behaviours would
3285be compatible with libev. Interaction between C<sigprocmask> and
3286C<pthread_sigmask> could complicate things, however.
3287
3288The most portable way to handle signals is to block signals in all threads
3289except the initial one, and run the default loop in the initial thread as
3290well.
3291
3292=back
3293
3294If you know of other additional requirements drop me a note.
3295
3296
3259=head1 AUTHOR 3297=head1 AUTHOR
3260 3298
3261Marc Lehmann <libev@schmorp.de>. 3299Marc Lehmann <libev@schmorp.de>.
3262 3300

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines