… | |
… | |
260 | flags. If that is troubling you, check C<ev_backend ()> afterwards). |
260 | flags. If that is troubling you, check C<ev_backend ()> afterwards). |
261 | |
261 | |
262 | If you don't know what event loop to use, use the one returned from this |
262 | If you don't know what event loop to use, use the one returned from this |
263 | function. |
263 | function. |
264 | |
264 | |
|
|
265 | The default loop is the only loop that can handle C<ev_signal> and |
|
|
266 | C<ev_child> watchers, and to do this, it always registers a handler |
|
|
267 | for C<SIGCHLD>. If this is a problem for your app you can either |
|
|
268 | create a dynamic loop with C<ev_loop_new> that doesn't do that, or you |
|
|
269 | can simply overwrite the C<SIGCHLD> signal handler I<after> calling |
|
|
270 | C<ev_default_init>. |
|
|
271 | |
265 | The flags argument can be used to specify special behaviour or specific |
272 | The flags argument can be used to specify special behaviour or specific |
266 | backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>). |
273 | backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>). |
267 | |
274 | |
268 | The following flags are supported: |
275 | The following flags are supported: |
269 | |
276 | |
… | |
… | |
403 | While this backend scales well, it requires one system call per active |
410 | While this backend scales well, it requires one system call per active |
404 | file descriptor per loop iteration. For small and medium numbers of file |
411 | file descriptor per loop iteration. For small and medium numbers of file |
405 | descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend |
412 | descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend |
406 | might perform better. |
413 | might perform better. |
407 | |
414 | |
|
|
415 | On the positive side, ignoring the spurious readyness notifications, this |
|
|
416 | backend actually performed to specification in all tests and is fully |
|
|
417 | embeddable, which is a rare feat among the OS-specific backends. |
|
|
418 | |
408 | =item C<EVBACKEND_ALL> |
419 | =item C<EVBACKEND_ALL> |
409 | |
420 | |
410 | Try all backends (even potentially broken ones that wouldn't be tried |
421 | Try all backends (even potentially broken ones that wouldn't be tried |
411 | with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as |
422 | with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as |
412 | C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>. |
423 | C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>. |
… | |
… | |
414 | It is definitely not recommended to use this flag. |
425 | It is definitely not recommended to use this flag. |
415 | |
426 | |
416 | =back |
427 | =back |
417 | |
428 | |
418 | If one or more of these are ored into the flags value, then only these |
429 | If one or more of these are ored into the flags value, then only these |
419 | backends will be tried (in the reverse order as given here). If none are |
430 | backends will be tried (in the reverse order as listed here). If none are |
420 | specified, most compiled-in backend will be tried, usually in reverse |
431 | specified, all backends in C<ev_recommended_backends ()> will be tried. |
421 | order of their flag values :) |
|
|
422 | |
432 | |
423 | The most typical usage is like this: |
433 | The most typical usage is like this: |
424 | |
434 | |
425 | if (!ev_default_loop (0)) |
435 | if (!ev_default_loop (0)) |
426 | fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
436 | fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
… | |
… | |
473 | Like C<ev_default_destroy>, but destroys an event loop created by an |
483 | Like C<ev_default_destroy>, but destroys an event loop created by an |
474 | earlier call to C<ev_loop_new>. |
484 | earlier call to C<ev_loop_new>. |
475 | |
485 | |
476 | =item ev_default_fork () |
486 | =item ev_default_fork () |
477 | |
487 | |
|
|
488 | This function sets a flag that causes subsequent C<ev_loop> iterations |
478 | This function reinitialises the kernel state for backends that have |
489 | to reinitialise the kernel state for backends that have one. Despite the |
479 | one. Despite the name, you can call it anytime, but it makes most sense |
490 | name, you can call it anytime, but it makes most sense after forking, in |
480 | after forking, in either the parent or child process (or both, but that |
491 | the child process (or both child and parent, but that again makes little |
481 | again makes little sense). |
492 | sense). You I<must> call it in the child before using any of the libev |
|
|
493 | functions, and it will only take effect at the next C<ev_loop> iteration. |
482 | |
494 | |
483 | You I<must> call this function in the child process after forking if and |
495 | On the other hand, you only need to call this function in the child |
484 | only if you want to use the event library in both processes. If you just |
496 | process if and only if you want to use the event library in the child. If |
485 | fork+exec, you don't have to call it. |
497 | you just fork+exec, you don't have to call it at all. |
486 | |
498 | |
487 | The function itself is quite fast and it's usually not a problem to call |
499 | The function itself is quite fast and it's usually not a problem to call |
488 | it just in case after a fork. To make this easy, the function will fit in |
500 | it just in case after a fork. To make this easy, the function will fit in |
489 | quite nicely into a call to C<pthread_atfork>: |
501 | quite nicely into a call to C<pthread_atfork>: |
490 | |
502 | |
491 | pthread_atfork (0, 0, ev_default_fork); |
503 | pthread_atfork (0, 0, ev_default_fork); |
492 | |
|
|
493 | At the moment, C<EVBACKEND_SELECT> and C<EVBACKEND_POLL> are safe to use |
|
|
494 | without calling this function, so if you force one of those backends you |
|
|
495 | do not need to care. |
|
|
496 | |
504 | |
497 | =item ev_loop_fork (loop) |
505 | =item ev_loop_fork (loop) |
498 | |
506 | |
499 | Like C<ev_default_fork>, but acts on an event loop created by |
507 | Like C<ev_default_fork>, but acts on an event loop created by |
500 | C<ev_loop_new>. Yes, you have to call this on every allocated event loop |
508 | C<ev_loop_new>. Yes, you have to call this on every allocated event loop |
… | |
… | |
575 | be handled here by queueing them when their watcher gets executed. |
583 | be handled here by queueing them when their watcher gets executed. |
576 | - If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
584 | - If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
577 | were used, or there are no active watchers, return, otherwise |
585 | were used, or there are no active watchers, return, otherwise |
578 | continue with step *. |
586 | continue with step *. |
579 | |
587 | |
580 | Example: Queue some jobs and then loop until no events are outsanding |
588 | Example: Queue some jobs and then loop until no events are outstanding |
581 | anymore. |
589 | anymore. |
582 | |
590 | |
583 | ... queue jobs here, make sure they register event watchers as long |
591 | ... queue jobs here, make sure they register event watchers as long |
584 | ... as they still have work to do (even an idle watcher will do..) |
592 | ... as they still have work to do (even an idle watcher will do..) |
585 | ev_loop (my_loop, 0); |
593 | ev_loop (my_loop, 0); |
… | |
… | |
589 | |
597 | |
590 | Can be used to make a call to C<ev_loop> return early (but only after it |
598 | Can be used to make a call to C<ev_loop> return early (but only after it |
591 | has processed all outstanding events). The C<how> argument must be either |
599 | has processed all outstanding events). The C<how> argument must be either |
592 | C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or |
600 | C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or |
593 | C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. |
601 | C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. |
|
|
602 | |
|
|
603 | This "unloop state" will be cleared when entering C<ev_loop> again. |
594 | |
604 | |
595 | =item ev_ref (loop) |
605 | =item ev_ref (loop) |
596 | |
606 | |
597 | =item ev_unref (loop) |
607 | =item ev_unref (loop) |
598 | |
608 | |
… | |
… | |
603 | returning, ev_unref() after starting, and ev_ref() before stopping it. For |
613 | returning, ev_unref() after starting, and ev_ref() before stopping it. For |
604 | example, libev itself uses this for its internal signal pipe: It is not |
614 | example, libev itself uses this for its internal signal pipe: It is not |
605 | visible to the libev user and should not keep C<ev_loop> from exiting if |
615 | visible to the libev user and should not keep C<ev_loop> from exiting if |
606 | no event watchers registered by it are active. It is also an excellent |
616 | no event watchers registered by it are active. It is also an excellent |
607 | way to do this for generic recurring timers or from within third-party |
617 | way to do this for generic recurring timers or from within third-party |
608 | libraries. Just remember to I<unref after start> and I<ref before stop>. |
618 | libraries. Just remember to I<unref after start> and I<ref before stop> |
|
|
619 | (but only if the watcher wasn't active before, or was active before, |
|
|
620 | respectively). |
609 | |
621 | |
610 | Example: Create a signal watcher, but keep it from keeping C<ev_loop> |
622 | Example: Create a signal watcher, but keep it from keeping C<ev_loop> |
611 | running when nothing else is active. |
623 | running when nothing else is active. |
612 | |
624 | |
613 | struct ev_signal exitsig; |
625 | struct ev_signal exitsig; |
… | |
… | |
2549 | be detected at runtime. |
2561 | be detected at runtime. |
2550 | |
2562 | |
2551 | =item EV_H |
2563 | =item EV_H |
2552 | |
2564 | |
2553 | The name of the F<ev.h> header file used to include it. The default if |
2565 | The name of the F<ev.h> header file used to include it. The default if |
2554 | undefined is C<"ev.h"> in F<event.h> and F<ev.c>. This can be used to |
2566 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
2555 | virtually rename the F<ev.h> header file in case of conflicts. |
2567 | used to virtually rename the F<ev.h> header file in case of conflicts. |
2556 | |
2568 | |
2557 | =item EV_CONFIG_H |
2569 | =item EV_CONFIG_H |
2558 | |
2570 | |
2559 | If C<EV_STANDALONE> isn't C<1>, this variable can be used to override |
2571 | If C<EV_STANDALONE> isn't C<1>, this variable can be used to override |
2560 | F<ev.c>'s idea of where to find the F<config.h> file, similarly to |
2572 | F<ev.c>'s idea of where to find the F<config.h> file, similarly to |
2561 | C<EV_H>, above. |
2573 | C<EV_H>, above. |
2562 | |
2574 | |
2563 | =item EV_EVENT_H |
2575 | =item EV_EVENT_H |
2564 | |
2576 | |
2565 | Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea |
2577 | Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea |
2566 | of how the F<event.h> header can be found, the dfeault is C<"event.h">. |
2578 | of how the F<event.h> header can be found, the default is C<"event.h">. |
2567 | |
2579 | |
2568 | =item EV_PROTOTYPES |
2580 | =item EV_PROTOTYPES |
2569 | |
2581 | |
2570 | If defined to be C<0>, then F<ev.h> will not define any function |
2582 | If defined to be C<0>, then F<ev.h> will not define any function |
2571 | prototypes, but still define all the structs and other symbols. This is |
2583 | prototypes, but still define all the structs and other symbols. This is |