… | |
… | |
685 | C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or |
685 | C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or |
686 | C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. |
686 | C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. |
687 | |
687 | |
688 | This "unloop state" will be cleared when entering C<ev_loop> again. |
688 | This "unloop state" will be cleared when entering C<ev_loop> again. |
689 | |
689 | |
|
|
690 | It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls. |
|
|
691 | |
690 | =item ev_ref (loop) |
692 | =item ev_ref (loop) |
691 | |
693 | |
692 | =item ev_unref (loop) |
694 | =item ev_unref (loop) |
693 | |
695 | |
694 | Ref/unref can be used to add or remove a reference count on the event |
696 | Ref/unref can be used to add or remove a reference count on the event |
… | |
… | |
967 | |
969 | |
968 | ev_io_start (EV_DEFAULT_UC, &w); |
970 | ev_io_start (EV_DEFAULT_UC, &w); |
969 | |
971 | |
970 | =item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher) |
972 | =item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher) |
971 | |
973 | |
972 | Stops the given watcher again (if active) and clears the pending |
974 | Stops the given watcher if active, and clears the pending status (whether |
|
|
975 | the watcher was active or not). |
|
|
976 | |
973 | status. It is possible that stopped watchers are pending (for example, |
977 | It is possible that stopped watchers are pending - for example, |
974 | non-repeating timers are being stopped when they become pending), but |
978 | non-repeating timers are being stopped when they become pending - but |
975 | C<ev_TYPE_stop> ensures that the watcher is neither active nor pending. If |
979 | calling C<ev_TYPE_stop> ensures that the watcher is neither active nor |
976 | you want to free or reuse the memory used by the watcher it is therefore a |
980 | pending. If you want to free or reuse the memory used by the watcher it is |
977 | good idea to always call its C<ev_TYPE_stop> function. |
981 | therefore a good idea to always call its C<ev_TYPE_stop> function. |
978 | |
982 | |
979 | =item bool ev_is_active (ev_TYPE *watcher) |
983 | =item bool ev_is_active (ev_TYPE *watcher) |
980 | |
984 | |
981 | Returns a true value iff the watcher is active (i.e. it has been started |
985 | Returns a true value iff the watcher is active (i.e. it has been started |
982 | and not yet been stopped). As long as a watcher is active you must not modify |
986 | and not yet been stopped). As long as a watcher is active you must not modify |
… | |
… | |
2384 | =over 4 |
2388 | =over 4 |
2385 | |
2389 | |
2386 | =item queueing from a signal handler context |
2390 | =item queueing from a signal handler context |
2387 | |
2391 | |
2388 | To implement race-free queueing, you simply add to the queue in the signal |
2392 | To implement race-free queueing, you simply add to the queue in the signal |
2389 | handler but you block the signal handler in the watcher callback. Here is an example that does that for |
2393 | handler but you block the signal handler in the watcher callback. Here is |
2390 | some fictitious SIGUSR1 handler: |
2394 | an example that does that for some fictitious SIGUSR1 handler: |
2391 | |
2395 | |
2392 | static ev_async mysig; |
2396 | static ev_async mysig; |
2393 | |
2397 | |
2394 | static void |
2398 | static void |
2395 | sigusr1_handler (void) |
2399 | sigusr1_handler (void) |
… | |
… | |
2502 | =over 4 |
2506 | =over 4 |
2503 | |
2507 | |
2504 | =item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) |
2508 | =item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) |
2505 | |
2509 | |
2506 | This function combines a simple timer and an I/O watcher, calls your |
2510 | This function combines a simple timer and an I/O watcher, calls your |
2507 | callback on whichever event happens first and automatically stop both |
2511 | callback on whichever event happens first and automatically stops both |
2508 | watchers. This is useful if you want to wait for a single event on an fd |
2512 | watchers. This is useful if you want to wait for a single event on an fd |
2509 | or timeout without having to allocate/configure/start/stop/free one or |
2513 | or timeout without having to allocate/configure/start/stop/free one or |
2510 | more watchers yourself. |
2514 | more watchers yourself. |
2511 | |
2515 | |
2512 | If C<fd> is less than 0, then no I/O watcher will be started and events |
2516 | If C<fd> is less than 0, then no I/O watcher will be started and the |
2513 | is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and |
2517 | C<events> argument is being ignored. Otherwise, an C<ev_io> watcher for |
2514 | C<events> set will be created and started. |
2518 | the given C<fd> and C<events> set will be created and started. |
2515 | |
2519 | |
2516 | If C<timeout> is less than 0, then no timeout watcher will be |
2520 | If C<timeout> is less than 0, then no timeout watcher will be |
2517 | started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and |
2521 | started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and |
2518 | repeat = 0) will be started. While C<0> is a valid timeout, it is of |
2522 | repeat = 0) will be started. C<0> is a valid timeout. |
2519 | dubious value. |
|
|
2520 | |
2523 | |
2521 | The callback has the type C<void (*cb)(int revents, void *arg)> and gets |
2524 | The callback has the type C<void (*cb)(int revents, void *arg)> and gets |
2522 | passed an C<revents> set like normal event callbacks (a combination of |
2525 | passed an C<revents> set like normal event callbacks (a combination of |
2523 | C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg> |
2526 | C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg> |
2524 | value passed to C<ev_once>: |
2527 | value passed to C<ev_once>. Note that it is possible to receive I<both> |
|
|
2528 | a timeout and an io event at the same time - you probably should give io |
|
|
2529 | events precedence. |
|
|
2530 | |
|
|
2531 | Example: wait up to ten seconds for data to appear on STDIN_FILENO. |
2525 | |
2532 | |
2526 | static void stdin_ready (int revents, void *arg) |
2533 | static void stdin_ready (int revents, void *arg) |
2527 | { |
2534 | { |
|
|
2535 | if (revents & EV_READ) |
|
|
2536 | /* stdin might have data for us, joy! */; |
2528 | if (revents & EV_TIMEOUT) |
2537 | else if (revents & EV_TIMEOUT) |
2529 | /* doh, nothing entered */; |
2538 | /* doh, nothing entered */; |
2530 | else if (revents & EV_READ) |
|
|
2531 | /* stdin might have data for us, joy! */; |
|
|
2532 | } |
2539 | } |
2533 | |
2540 | |
2534 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
2541 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
2535 | |
2542 | |
2536 | =item ev_feed_event (ev_loop *, watcher *, int revents) |
2543 | =item ev_feed_event (ev_loop *, watcher *, int revents) |
… | |
… | |
3313 | =head2 THREADS AND COROUTINES |
3320 | =head2 THREADS AND COROUTINES |
3314 | |
3321 | |
3315 | =head3 THREADS |
3322 | =head3 THREADS |
3316 | |
3323 | |
3317 | All libev functions are reentrant and thread-safe unless explicitly |
3324 | All libev functions are reentrant and thread-safe unless explicitly |
3318 | documented otherwise, but it uses no locking itself. This means that you |
3325 | documented otherwise, but libev implements no locking itself. This means |
3319 | can use as many loops as you want in parallel, as long as there are no |
3326 | that you can use as many loops as you want in parallel, as long as there |
3320 | concurrent calls into any libev function with the same loop parameter |
3327 | are no concurrent calls into any libev function with the same loop |
3321 | (C<ev_default_*> calls have an implicit default loop parameter, of |
3328 | parameter (C<ev_default_*> calls have an implicit default loop parameter, |
3322 | course): libev guarantees that different event loops share no data |
3329 | of course): libev guarantees that different event loops share no data |
3323 | structures that need any locking. |
3330 | structures that need any locking. |
3324 | |
3331 | |
3325 | Or to put it differently: calls with different loop parameters can be done |
3332 | Or to put it differently: calls with different loop parameters can be done |
3326 | concurrently from multiple threads, calls with the same loop parameter |
3333 | concurrently from multiple threads, calls with the same loop parameter |
3327 | must be done serially (but can be done from different threads, as long as |
3334 | must be done serially (but can be done from different threads, as long as |
… | |
… | |
3369 | |
3376 | |
3370 | =back |
3377 | =back |
3371 | |
3378 | |
3372 | =head3 COROUTINES |
3379 | =head3 COROUTINES |
3373 | |
3380 | |
3374 | Libev is much more accommodating to coroutines ("cooperative threads"): |
3381 | Libev is very accommodating to coroutines ("cooperative threads"): |
3375 | libev fully supports nesting calls to it's functions from different |
3382 | libev fully supports nesting calls to its functions from different |
3376 | coroutines (e.g. you can call C<ev_loop> on the same loop from two |
3383 | coroutines (e.g. you can call C<ev_loop> on the same loop from two |
3377 | different coroutines and switch freely between both coroutines running the |
3384 | different coroutines, and switch freely between both coroutines running the |
3378 | loop, as long as you don't confuse yourself). The only exception is that |
3385 | loop, as long as you don't confuse yourself). The only exception is that |
3379 | you must not do this from C<ev_periodic> reschedule callbacks. |
3386 | you must not do this from C<ev_periodic> reschedule callbacks. |
3380 | |
3387 | |
3381 | Care has been taken to ensure that libev does not keep local state inside |
3388 | Care has been taken to ensure that libev does not keep local state inside |
3382 | C<ev_loop>, and other calls do not usually allow coroutine switches. |
3389 | C<ev_loop>, and other calls do not usually allow for coroutine switches as |
|
|
3390 | they do not clal any callbacks. |
3383 | |
3391 | |
3384 | =head2 COMPILER WARNINGS |
3392 | =head2 COMPILER WARNINGS |
3385 | |
3393 | |
3386 | Depending on your compiler and compiler settings, you might get no or a |
3394 | Depending on your compiler and compiler settings, you might get no or a |
3387 | lot of warnings when compiling libev code. Some people are apparently |
3395 | lot of warnings when compiling libev code. Some people are apparently |
… | |
… | |
3439 | annoyed when you get a brisk "this is no bug" answer and take the chance |
3447 | annoyed when you get a brisk "this is no bug" answer and take the chance |
3440 | of learning how to interpret valgrind properly. |
3448 | of learning how to interpret valgrind properly. |
3441 | |
3449 | |
3442 | If you need, for some reason, empty reports from valgrind for your project |
3450 | If you need, for some reason, empty reports from valgrind for your project |
3443 | I suggest using suppression lists. |
3451 | I suggest using suppression lists. |
3444 | |
|
|
3445 | |
|
|
3446 | |
|
|
3447 | =head1 COMPLEXITIES |
|
|
3448 | |
|
|
3449 | In this section the complexities of (many of) the algorithms used inside |
|
|
3450 | libev will be explained. For complexity discussions about backends see the |
|
|
3451 | documentation for C<ev_default_init>. |
|
|
3452 | |
|
|
3453 | All of the following are about amortised time: If an array needs to be |
|
|
3454 | extended, libev needs to realloc and move the whole array, but this |
|
|
3455 | happens asymptotically never with higher number of elements, so O(1) might |
|
|
3456 | mean it might do a lengthy realloc operation in rare cases, but on average |
|
|
3457 | it is much faster and asymptotically approaches constant time. |
|
|
3458 | |
|
|
3459 | =over 4 |
|
|
3460 | |
|
|
3461 | =item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) |
|
|
3462 | |
|
|
3463 | This means that, when you have a watcher that triggers in one hour and |
|
|
3464 | there are 100 watchers that would trigger before that then inserting will |
|
|
3465 | have to skip roughly seven (C<ld 100>) of these watchers. |
|
|
3466 | |
|
|
3467 | =item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers) |
|
|
3468 | |
|
|
3469 | That means that changing a timer costs less than removing/adding them |
|
|
3470 | as only the relative motion in the event queue has to be paid for. |
|
|
3471 | |
|
|
3472 | =item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1) |
|
|
3473 | |
|
|
3474 | These just add the watcher into an array or at the head of a list. |
|
|
3475 | |
|
|
3476 | =item Stopping check/prepare/idle/fork/async watchers: O(1) |
|
|
3477 | |
|
|
3478 | =item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) |
|
|
3479 | |
|
|
3480 | These watchers are stored in lists then need to be walked to find the |
|
|
3481 | correct watcher to remove. The lists are usually short (you don't usually |
|
|
3482 | have many watchers waiting for the same fd or signal). |
|
|
3483 | |
|
|
3484 | =item Finding the next timer in each loop iteration: O(1) |
|
|
3485 | |
|
|
3486 | By virtue of using a binary or 4-heap, the next timer is always found at a |
|
|
3487 | fixed position in the storage array. |
|
|
3488 | |
|
|
3489 | =item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) |
|
|
3490 | |
|
|
3491 | A change means an I/O watcher gets started or stopped, which requires |
|
|
3492 | libev to recalculate its status (and possibly tell the kernel, depending |
|
|
3493 | on backend and whether C<ev_io_set> was used). |
|
|
3494 | |
|
|
3495 | =item Activating one watcher (putting it into the pending state): O(1) |
|
|
3496 | |
|
|
3497 | =item Priority handling: O(number_of_priorities) |
|
|
3498 | |
|
|
3499 | Priorities are implemented by allocating some space for each |
|
|
3500 | priority. When doing priority-based operations, libev usually has to |
|
|
3501 | linearly search all the priorities, but starting/stopping and activating |
|
|
3502 | watchers becomes O(1) with respect to priority handling. |
|
|
3503 | |
|
|
3504 | =item Sending an ev_async: O(1) |
|
|
3505 | |
|
|
3506 | =item Processing ev_async_send: O(number_of_async_watchers) |
|
|
3507 | |
|
|
3508 | =item Processing signals: O(max_signal_number) |
|
|
3509 | |
|
|
3510 | Sending involves a system call I<iff> there were no other C<ev_async_send> |
|
|
3511 | calls in the current loop iteration. Checking for async and signal events |
|
|
3512 | involves iterating over all running async watchers or all signal numbers. |
|
|
3513 | |
|
|
3514 | =back |
|
|
3515 | |
3452 | |
3516 | |
3453 | |
3517 | =head1 PORTABILITY NOTES |
3454 | =head1 PORTABILITY NOTES |
3518 | |
3455 | |
3519 | =head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS |
3456 | =head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS |
… | |
… | |
3667 | =back |
3604 | =back |
3668 | |
3605 | |
3669 | If you know of other additional requirements drop me a note. |
3606 | If you know of other additional requirements drop me a note. |
3670 | |
3607 | |
3671 | |
3608 | |
|
|
3609 | =head1 ALGORITHMIC COMPLEXITIES |
|
|
3610 | |
|
|
3611 | In this section the complexities of (many of) the algorithms used inside |
|
|
3612 | libev will be documented. For complexity discussions about backends see |
|
|
3613 | the documentation for C<ev_default_init>. |
|
|
3614 | |
|
|
3615 | All of the following are about amortised time: If an array needs to be |
|
|
3616 | extended, libev needs to realloc and move the whole array, but this |
|
|
3617 | happens asymptotically rarer with higher number of elements, so O(1) might |
|
|
3618 | mean that libev does a lengthy realloc operation in rare cases, but on |
|
|
3619 | average it is much faster and asymptotically approaches constant time. |
|
|
3620 | |
|
|
3621 | =over 4 |
|
|
3622 | |
|
|
3623 | =item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) |
|
|
3624 | |
|
|
3625 | This means that, when you have a watcher that triggers in one hour and |
|
|
3626 | there are 100 watchers that would trigger before that, then inserting will |
|
|
3627 | have to skip roughly seven (C<ld 100>) of these watchers. |
|
|
3628 | |
|
|
3629 | =item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers) |
|
|
3630 | |
|
|
3631 | That means that changing a timer costs less than removing/adding them, |
|
|
3632 | as only the relative motion in the event queue has to be paid for. |
|
|
3633 | |
|
|
3634 | =item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1) |
|
|
3635 | |
|
|
3636 | These just add the watcher into an array or at the head of a list. |
|
|
3637 | |
|
|
3638 | =item Stopping check/prepare/idle/fork/async watchers: O(1) |
|
|
3639 | |
|
|
3640 | =item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) |
|
|
3641 | |
|
|
3642 | These watchers are stored in lists, so they need to be walked to find the |
|
|
3643 | correct watcher to remove. The lists are usually short (you don't usually |
|
|
3644 | have many watchers waiting for the same fd or signal: one is typical, two |
|
|
3645 | is rare). |
|
|
3646 | |
|
|
3647 | =item Finding the next timer in each loop iteration: O(1) |
|
|
3648 | |
|
|
3649 | By virtue of using a binary or 4-heap, the next timer is always found at a |
|
|
3650 | fixed position in the storage array. |
|
|
3651 | |
|
|
3652 | =item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) |
|
|
3653 | |
|
|
3654 | A change means an I/O watcher gets started or stopped, which requires |
|
|
3655 | libev to recalculate its status (and possibly tell the kernel, depending |
|
|
3656 | on backend and whether C<ev_io_set> was used). |
|
|
3657 | |
|
|
3658 | =item Activating one watcher (putting it into the pending state): O(1) |
|
|
3659 | |
|
|
3660 | =item Priority handling: O(number_of_priorities) |
|
|
3661 | |
|
|
3662 | Priorities are implemented by allocating some space for each |
|
|
3663 | priority. When doing priority-based operations, libev usually has to |
|
|
3664 | linearly search all the priorities, but starting/stopping and activating |
|
|
3665 | watchers becomes O(1) with respect to priority handling. |
|
|
3666 | |
|
|
3667 | =item Sending an ev_async: O(1) |
|
|
3668 | |
|
|
3669 | =item Processing ev_async_send: O(number_of_async_watchers) |
|
|
3670 | |
|
|
3671 | =item Processing signals: O(max_signal_number) |
|
|
3672 | |
|
|
3673 | Sending involves a system call I<iff> there were no other C<ev_async_send> |
|
|
3674 | calls in the current loop iteration. Checking for async and signal events |
|
|
3675 | involves iterating over all running async watchers or all signal numbers. |
|
|
3676 | |
|
|
3677 | =back |
|
|
3678 | |
|
|
3679 | |
3672 | =head1 AUTHOR |
3680 | =head1 AUTHOR |
3673 | |
3681 | |
3674 | Marc Lehmann <libev@schmorp.de>. |
3682 | Marc Lehmann <libev@schmorp.de>. |
3675 | |
3683 | |