… | |
… | |
4 | <head> |
4 | <head> |
5 | <title>libev</title> |
5 | <title>libev</title> |
6 | <meta name="description" content="Pod documentation for libev" /> |
6 | <meta name="description" content="Pod documentation for libev" /> |
7 | <meta name="inputfile" content="<standard input>" /> |
7 | <meta name="inputfile" content="<standard input>" /> |
8 | <meta name="outputfile" content="<standard output>" /> |
8 | <meta name="outputfile" content="<standard output>" /> |
9 | <meta name="created" content="Sat Nov 24 11:15:15 2007" /> |
9 | <meta name="created" content="Tue Nov 27 09:20:40 2007" /> |
10 | <meta name="generator" content="Pod::Xhtml 1.57" /> |
10 | <meta name="generator" content="Pod::Xhtml 1.57" /> |
11 | <link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head> |
11 | <link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head> |
12 | <body> |
12 | <body> |
13 | <div class="pod"> |
13 | <div class="pod"> |
14 | <!-- INDEX START --> |
14 | <!-- INDEX START --> |
… | |
… | |
21 | <li><a href="#CONVENTIONS">CONVENTIONS</a></li> |
21 | <li><a href="#CONVENTIONS">CONVENTIONS</a></li> |
22 | <li><a href="#TIME_REPRESENTATION">TIME REPRESENTATION</a></li> |
22 | <li><a href="#TIME_REPRESENTATION">TIME REPRESENTATION</a></li> |
23 | <li><a href="#GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</a></li> |
23 | <li><a href="#GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</a></li> |
24 | <li><a href="#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</a></li> |
24 | <li><a href="#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</a></li> |
25 | <li><a href="#ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</a> |
25 | <li><a href="#ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</a> |
26 | <ul><li><a href="#SUMMARY_OF_GENERIC_WATCHER_FUNCTIONS">SUMMARY OF GENERIC WATCHER FUNCTIONS</a></li> |
26 | <ul><li><a href="#GENERIC_WATCHER_FUNCTIONS">GENERIC WATCHER FUNCTIONS</a></li> |
27 | <li><a href="#ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</a></li> |
27 | <li><a href="#ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</a></li> |
28 | </ul> |
28 | </ul> |
29 | </li> |
29 | </li> |
30 | <li><a href="#WATCHER_TYPES">WATCHER TYPES</a> |
30 | <li><a href="#WATCHER_TYPES">WATCHER TYPES</a> |
31 | <ul><li><a href="#code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable</a></li> |
31 | <ul><li><a href="#code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable?</a></li> |
32 | <li><a href="#code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</a></li> |
32 | <li><a href="#code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally repeating timeouts</a></li> |
33 | <li><a href="#code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron</a></li> |
33 | <li><a href="#code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron?</a></li> |
34 | <li><a href="#code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled</a></li> |
34 | <li><a href="#code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled!</a></li> |
35 | <li><a href="#code_ev_child_code_wait_for_pid_stat"><code>ev_child</code> - wait for pid status changes</a></li> |
35 | <li><a href="#code_ev_child_code_watch_out_for_pro"><code>ev_child</code> - watch out for process status changes</a></li> |
|
|
36 | <li><a href="#code_ev_stat_code_did_the_file_attri"><code>ev_stat</code> - did the file attributes just change?</a></li> |
36 | <li><a href="#code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do</a></li> |
37 | <li><a href="#code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do...</a></li> |
37 | <li><a href="#code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</a></li> |
38 | <li><a href="#code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop!</a></li> |
38 | <li><a href="#code_ev_embed_code_when_one_backend_"><code>ev_embed</code> - when one backend isn't enough</a></li> |
39 | <li><a href="#code_ev_embed_code_when_one_backend_"><code>ev_embed</code> - when one backend isn't enough...</a></li> |
39 | </ul> |
40 | </ul> |
40 | </li> |
41 | </li> |
41 | <li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li> |
42 | <li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li> |
42 | <li><a href="#LIBEVENT_EMULATION">LIBEVENT EMULATION</a></li> |
43 | <li><a href="#LIBEVENT_EMULATION">LIBEVENT EMULATION</a></li> |
43 | <li><a href="#C_SUPPORT">C++ SUPPORT</a></li> |
44 | <li><a href="#C_SUPPORT">C++ SUPPORT</a></li> |
… | |
… | |
50 | </li> |
51 | </li> |
51 | <li><a href="#PREPROCESSOR_SYMBOLS_MACROS">PREPROCESSOR SYMBOLS/MACROS</a></li> |
52 | <li><a href="#PREPROCESSOR_SYMBOLS_MACROS">PREPROCESSOR SYMBOLS/MACROS</a></li> |
52 | <li><a href="#EXAMPLES">EXAMPLES</a></li> |
53 | <li><a href="#EXAMPLES">EXAMPLES</a></li> |
53 | </ul> |
54 | </ul> |
54 | </li> |
55 | </li> |
|
|
56 | <li><a href="#COMPLEXITIES">COMPLEXITIES</a></li> |
55 | <li><a href="#AUTHOR">AUTHOR</a> |
57 | <li><a href="#AUTHOR">AUTHOR</a> |
56 | </li> |
58 | </li> |
57 | </ul><hr /> |
59 | </ul><hr /> |
58 | <!-- INDEX END --> |
60 | <!-- INDEX END --> |
59 | |
61 | |
… | |
… | |
513 | |
515 | |
514 | </pre> |
516 | </pre> |
515 | </dd> |
517 | </dd> |
516 | </dl> |
518 | </dl> |
517 | |
519 | |
|
|
520 | |
|
|
521 | |
|
|
522 | |
|
|
523 | |
518 | </div> |
524 | </div> |
519 | <h1 id="ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</h1><p><a href="#TOP" class="toplink">Top</a></p> |
525 | <h1 id="ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</h1><p><a href="#TOP" class="toplink">Top</a></p> |
520 | <div id="ANATOMY_OF_A_WATCHER_CONTENT"> |
526 | <div id="ANATOMY_OF_A_WATCHER_CONTENT"> |
521 | <p>A watcher is a structure that you create and register to record your |
527 | <p>A watcher is a structure that you create and register to record your |
522 | interest in some event. For instance, if you want to wait for STDIN to |
528 | interest in some event. For instance, if you want to wait for STDIN to |
… | |
… | |
581 | </dd> |
587 | </dd> |
582 | <dt><code>EV_CHILD</code></dt> |
588 | <dt><code>EV_CHILD</code></dt> |
583 | <dd> |
589 | <dd> |
584 | <p>The pid specified in the <code>ev_child</code> watcher has received a status change.</p> |
590 | <p>The pid specified in the <code>ev_child</code> watcher has received a status change.</p> |
585 | </dd> |
591 | </dd> |
|
|
592 | <dt><code>EV_STAT</code></dt> |
|
|
593 | <dd> |
|
|
594 | <p>The path specified in the <code>ev_stat</code> watcher changed its attributes somehow.</p> |
|
|
595 | </dd> |
586 | <dt><code>EV_IDLE</code></dt> |
596 | <dt><code>EV_IDLE</code></dt> |
587 | <dd> |
597 | <dd> |
588 | <p>The <code>ev_idle</code> watcher has determined that you have nothing better to do.</p> |
598 | <p>The <code>ev_idle</code> watcher has determined that you have nothing better to do.</p> |
589 | </dd> |
599 | </dd> |
590 | <dt><code>EV_PREPARE</code></dt> |
600 | <dt><code>EV_PREPARE</code></dt> |
… | |
… | |
612 | programs, though, so beware.</p> |
622 | programs, though, so beware.</p> |
613 | </dd> |
623 | </dd> |
614 | </dl> |
624 | </dl> |
615 | |
625 | |
616 | </div> |
626 | </div> |
617 | <h2 id="SUMMARY_OF_GENERIC_WATCHER_FUNCTIONS">SUMMARY OF GENERIC WATCHER FUNCTIONS</h2> |
627 | <h2 id="GENERIC_WATCHER_FUNCTIONS">GENERIC WATCHER FUNCTIONS</h2> |
618 | <div id="SUMMARY_OF_GENERIC_WATCHER_FUNCTIONS-2"> |
628 | <div id="GENERIC_WATCHER_FUNCTIONS_CONTENT"> |
619 | <p>In the following description, <code>TYPE</code> stands for the watcher type, |
629 | <p>In the following description, <code>TYPE</code> stands for the watcher type, |
620 | e.g. <code>timer</code> for <code>ev_timer</code> watchers and <code>io</code> for <code>ev_io</code> watchers.</p> |
630 | e.g. <code>timer</code> for <code>ev_timer</code> watchers and <code>io</code> for <code>ev_io</code> watchers.</p> |
621 | <dl> |
631 | <dl> |
622 | <dt><code>ev_init</code> (ev_TYPE *watcher, callback)</dt> |
632 | <dt><code>ev_init</code> (ev_TYPE *watcher, callback)</dt> |
623 | <dd> |
633 | <dd> |
… | |
… | |
627 | the type-specific <code>ev_TYPE_set</code> macro afterwards to initialise the |
637 | the type-specific <code>ev_TYPE_set</code> macro afterwards to initialise the |
628 | type-specific parts. For each type there is also a <code>ev_TYPE_init</code> macro |
638 | type-specific parts. For each type there is also a <code>ev_TYPE_init</code> macro |
629 | which rolls both calls into one.</p> |
639 | which rolls both calls into one.</p> |
630 | <p>You can reinitialise a watcher at any time as long as it has been stopped |
640 | <p>You can reinitialise a watcher at any time as long as it has been stopped |
631 | (or never started) and there are no pending events outstanding.</p> |
641 | (or never started) and there are no pending events outstanding.</p> |
632 | <p>The callbakc is always of type <code>void (*)(ev_loop *loop, ev_TYPE *watcher, |
642 | <p>The callback is always of type <code>void (*)(ev_loop *loop, ev_TYPE *watcher, |
633 | int revents)</code>.</p> |
643 | int revents)</code>.</p> |
634 | </dd> |
644 | </dd> |
635 | <dt><code>ev_TYPE_set</code> (ev_TYPE *, [args])</dt> |
645 | <dt><code>ev_TYPE_set</code> (ev_TYPE *, [args])</dt> |
636 | <dd> |
646 | <dd> |
637 | <p>This macro initialises the type-specific parts of a watcher. You need to |
647 | <p>This macro initialises the type-specific parts of a watcher. You need to |
… | |
… | |
727 | |
737 | |
728 | </div> |
738 | </div> |
729 | <h1 id="WATCHER_TYPES">WATCHER TYPES</h1><p><a href="#TOP" class="toplink">Top</a></p> |
739 | <h1 id="WATCHER_TYPES">WATCHER TYPES</h1><p><a href="#TOP" class="toplink">Top</a></p> |
730 | <div id="WATCHER_TYPES_CONTENT"> |
740 | <div id="WATCHER_TYPES_CONTENT"> |
731 | <p>This section describes each watcher in detail, but will not repeat |
741 | <p>This section describes each watcher in detail, but will not repeat |
732 | information given in the last section.</p> |
742 | information given in the last section. Any initialisation/set macros, |
|
|
743 | functions and members specific to the watcher type are explained.</p> |
|
|
744 | <p>Members are additionally marked with either <i>[read-only]</i>, meaning that, |
|
|
745 | while the watcher is active, you can look at the member and expect some |
|
|
746 | sensible content, but you must not modify it (you can modify it while the |
|
|
747 | watcher is stopped to your hearts content), or <i>[read-write]</i>, which |
|
|
748 | means you can expect it to have some sensible content while the watcher |
|
|
749 | is active, but you can also modify it. Modifying it may not do something |
|
|
750 | sensible or take immediate effect (or do anything at all), but libev will |
|
|
751 | not crash or malfunction in any way.</p> |
733 | |
752 | |
734 | |
753 | |
735 | |
754 | |
736 | |
755 | |
737 | |
756 | |
738 | </div> |
757 | </div> |
739 | <h2 id="code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable</h2> |
758 | <h2 id="code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable?</h2> |
740 | <div id="code_ev_io_code_is_this_file_descrip-2"> |
759 | <div id="code_ev_io_code_is_this_file_descrip-2"> |
741 | <p>I/O watchers check whether a file descriptor is readable or writable |
760 | <p>I/O watchers check whether a file descriptor is readable or writable |
742 | in each iteration of the event loop (This behaviour is called |
761 | in each iteration of the event loop, or, more precisely, when reading |
743 | level-triggering because you keep receiving events as long as the |
762 | would not block the process and writing would at least be able to write |
744 | condition persists. Remember you can stop the watcher if you don't want to |
763 | some data. This behaviour is called level-triggering because you keep |
745 | act on the event and neither want to receive future events).</p> |
764 | receiving events as long as the condition persists. Remember you can stop |
|
|
765 | the watcher if you don't want to act on the event and neither want to |
|
|
766 | receive future events.</p> |
746 | <p>In general you can register as many read and/or write event watchers per |
767 | <p>In general you can register as many read and/or write event watchers per |
747 | fd as you want (as long as you don't confuse yourself). Setting all file |
768 | fd as you want (as long as you don't confuse yourself). Setting all file |
748 | descriptors to non-blocking mode is also usually a good idea (but not |
769 | descriptors to non-blocking mode is also usually a good idea (but not |
749 | required if you know what you are doing).</p> |
770 | required if you know what you are doing).</p> |
750 | <p>You have to be careful with dup'ed file descriptors, though. Some backends |
771 | <p>You have to be careful with dup'ed file descriptors, though. Some backends |
751 | (the linux epoll backend is a notable example) cannot handle dup'ed file |
772 | (the linux epoll backend is a notable example) cannot handle dup'ed file |
752 | descriptors correctly if you register interest in two or more fds pointing |
773 | descriptors correctly if you register interest in two or more fds pointing |
753 | to the same underlying file/socket etc. description (that is, they share |
774 | to the same underlying file/socket/etc. description (that is, they share |
754 | the same underlying "file open").</p> |
775 | the same underlying "file open").</p> |
755 | <p>If you must do this, then force the use of a known-to-be-good backend |
776 | <p>If you must do this, then force the use of a known-to-be-good backend |
756 | (at the time of this writing, this includes only <code>EVBACKEND_SELECT</code> and |
777 | (at the time of this writing, this includes only <code>EVBACKEND_SELECT</code> and |
757 | <code>EVBACKEND_POLL</code>).</p> |
778 | <code>EVBACKEND_POLL</code>).</p> |
|
|
779 | <p>Another thing you have to watch out for is that it is quite easy to |
|
|
780 | receive "spurious" readyness notifications, that is your callback might |
|
|
781 | be called with <code>EV_READ</code> but a subsequent <code>read</code>(2) will actually block |
|
|
782 | because there is no data. Not only are some backends known to create a |
|
|
783 | lot of those (for example solaris ports), it is very easy to get into |
|
|
784 | this situation even with a relatively standard program structure. Thus |
|
|
785 | it is best to always use non-blocking I/O: An extra <code>read</code>(2) returning |
|
|
786 | <code>EAGAIN</code> is far preferable to a program hanging until some data arrives.</p> |
|
|
787 | <p>If you cannot run the fd in non-blocking mode (for example you should not |
|
|
788 | play around with an Xlib connection), then you have to seperately re-test |
|
|
789 | wether a file descriptor is really ready with a known-to-be good interface |
|
|
790 | such as poll (fortunately in our Xlib example, Xlib already does this on |
|
|
791 | its own, so its quite safe to use).</p> |
758 | <dl> |
792 | <dl> |
759 | <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt> |
793 | <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt> |
760 | <dt>ev_io_set (ev_io *, int fd, int events)</dt> |
794 | <dt>ev_io_set (ev_io *, int fd, int events)</dt> |
761 | <dd> |
795 | <dd> |
762 | <p>Configures an <code>ev_io</code> watcher. The fd is the file descriptor to rceeive |
796 | <p>Configures an <code>ev_io</code> watcher. The <code>fd</code> is the file descriptor to |
763 | events for and events is either <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_READ | |
797 | rceeive events for and events is either <code>EV_READ</code>, <code>EV_WRITE</code> or |
764 | EV_WRITE</code> to receive the given events.</p> |
798 | <code>EV_READ | EV_WRITE</code> to receive the given events.</p> |
765 | <p>Please note that most of the more scalable backend mechanisms (for example |
799 | </dd> |
766 | epoll and solaris ports) can result in spurious readyness notifications |
800 | <dt>int fd [read-only]</dt> |
767 | for file descriptors, so you practically need to use non-blocking I/O (and |
801 | <dd> |
768 | treat callback invocation as hint only), or retest separately with a safe |
802 | <p>The file descriptor being watched.</p> |
769 | interface before doing I/O (XLib can do this), or force the use of either |
803 | </dd> |
770 | <code>EVBACKEND_SELECT</code> or <code>EVBACKEND_POLL</code>, which don't suffer from this |
804 | <dt>int events [read-only]</dt> |
771 | problem. Also note that it is quite easy to have your callback invoked |
805 | <dd> |
772 | when the readyness condition is no longer valid even when employing |
806 | <p>The events being watched.</p> |
773 | typical ways of handling events, so its a good idea to use non-blocking |
|
|
774 | I/O unconditionally.</p> |
|
|
775 | </dd> |
807 | </dd> |
776 | </dl> |
808 | </dl> |
777 | <p>Example: call <code>stdin_readable_cb</code> when STDIN_FILENO has become, well |
809 | <p>Example: call <code>stdin_readable_cb</code> when STDIN_FILENO has become, well |
778 | readable, but only once. Since it is likely line-buffered, you could |
810 | readable, but only once. Since it is likely line-buffered, you could |
779 | attempt to read a whole line in the callback:</p> |
811 | attempt to read a whole line in the callback:</p> |
… | |
… | |
795 | |
827 | |
796 | |
828 | |
797 | </pre> |
829 | </pre> |
798 | |
830 | |
799 | </div> |
831 | </div> |
800 | <h2 id="code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</h2> |
832 | <h2 id="code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally repeating timeouts</h2> |
801 | <div id="code_ev_timer_code_relative_and_opti-2"> |
833 | <div id="code_ev_timer_code_relative_and_opti-2"> |
802 | <p>Timer watchers are simple relative timers that generate an event after a |
834 | <p>Timer watchers are simple relative timers that generate an event after a |
803 | given time, and optionally repeating in regular intervals after that.</p> |
835 | given time, and optionally repeating in regular intervals after that.</p> |
804 | <p>The timers are based on real time, that is, if you register an event that |
836 | <p>The timers are based on real time, that is, if you register an event that |
805 | times out after an hour and you reset your system clock to last years |
837 | times out after an hour and you reset your system clock to last years |
… | |
… | |
837 | repeating. The exact semantics are:</p> |
869 | repeating. The exact semantics are:</p> |
838 | <p>If the timer is started but nonrepeating, stop it.</p> |
870 | <p>If the timer is started but nonrepeating, stop it.</p> |
839 | <p>If the timer is repeating, either start it if necessary (with the repeat |
871 | <p>If the timer is repeating, either start it if necessary (with the repeat |
840 | value), or reset the running timer to the repeat value.</p> |
872 | value), or reset the running timer to the repeat value.</p> |
841 | <p>This sounds a bit complicated, but here is a useful and typical |
873 | <p>This sounds a bit complicated, but here is a useful and typical |
842 | example: Imagine you have a tcp connection and you want a so-called idle |
874 | example: Imagine you have a tcp connection and you want a so-called |
843 | timeout, that is, you want to be called when there have been, say, 60 |
875 | idle timeout, that is, you want to be called when there have been, |
844 | seconds of inactivity on the socket. The easiest way to do this is to |
876 | say, 60 seconds of inactivity on the socket. The easiest way to do |
845 | configure an <code>ev_timer</code> with after=repeat=60 and calling ev_timer_again each |
877 | this is to configure an <code>ev_timer</code> with <code>after</code>=<code>repeat</code>=<code>60</code> and calling |
846 | time you successfully read or write some data. If you go into an idle |
878 | <code>ev_timer_again</code> each time you successfully read or write some data. If |
847 | state where you do not expect data to travel on the socket, you can stop |
879 | you go into an idle state where you do not expect data to travel on the |
848 | the timer, and again will automatically restart it if need be.</p> |
880 | socket, you can stop the timer, and again will automatically restart it if |
|
|
881 | need be.</p> |
|
|
882 | <p>You can also ignore the <code>after</code> value and <code>ev_timer_start</code> altogether |
|
|
883 | and only ever use the <code>repeat</code> value:</p> |
|
|
884 | <pre> ev_timer_init (timer, callback, 0., 5.); |
|
|
885 | ev_timer_again (loop, timer); |
|
|
886 | ... |
|
|
887 | timer->again = 17.; |
|
|
888 | ev_timer_again (loop, timer); |
|
|
889 | ... |
|
|
890 | timer->again = 10.; |
|
|
891 | ev_timer_again (loop, timer); |
|
|
892 | |
|
|
893 | </pre> |
|
|
894 | <p>This is more efficient then stopping/starting the timer eahc time you want |
|
|
895 | to modify its timeout value.</p> |
|
|
896 | </dd> |
|
|
897 | <dt>ev_tstamp repeat [read-write]</dt> |
|
|
898 | <dd> |
|
|
899 | <p>The current <code>repeat</code> value. Will be used each time the watcher times out |
|
|
900 | or <code>ev_timer_again</code> is called and determines the next timeout (if any), |
|
|
901 | which is also when any modifications are taken into account.</p> |
849 | </dd> |
902 | </dd> |
850 | </dl> |
903 | </dl> |
851 | <p>Example: create a timer that fires after 60 seconds.</p> |
904 | <p>Example: create a timer that fires after 60 seconds.</p> |
852 | <pre> static void |
905 | <pre> static void |
853 | one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
906 | one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
… | |
… | |
881 | |
934 | |
882 | |
935 | |
883 | </pre> |
936 | </pre> |
884 | |
937 | |
885 | </div> |
938 | </div> |
886 | <h2 id="code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron</h2> |
939 | <h2 id="code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron?</h2> |
887 | <div id="code_ev_periodic_code_to_cron_or_not-2"> |
940 | <div id="code_ev_periodic_code_to_cron_or_not-2"> |
888 | <p>Periodic watchers are also timers of a kind, but they are very versatile |
941 | <p>Periodic watchers are also timers of a kind, but they are very versatile |
889 | (and unfortunately a bit complex).</p> |
942 | (and unfortunately a bit complex).</p> |
890 | <p>Unlike <code>ev_timer</code>'s, they are not based on real time (or relative time) |
943 | <p>Unlike <code>ev_timer</code>'s, they are not based on real time (or relative time) |
891 | but on wallclock time (absolute time). You can tell a periodic watcher |
944 | but on wallclock time (absolute time). You can tell a periodic watcher |
… | |
… | |
971 | <p>Simply stops and restarts the periodic watcher again. This is only useful |
1024 | <p>Simply stops and restarts the periodic watcher again. This is only useful |
972 | when you changed some parameters or the reschedule callback would return |
1025 | when you changed some parameters or the reschedule callback would return |
973 | a different time than the last time it was called (e.g. in a crond like |
1026 | a different time than the last time it was called (e.g. in a crond like |
974 | program when the crontabs have changed).</p> |
1027 | program when the crontabs have changed).</p> |
975 | </dd> |
1028 | </dd> |
|
|
1029 | <dt>ev_tstamp interval [read-write]</dt> |
|
|
1030 | <dd> |
|
|
1031 | <p>The current interval value. Can be modified any time, but changes only |
|
|
1032 | take effect when the periodic timer fires or <code>ev_periodic_again</code> is being |
|
|
1033 | called.</p> |
|
|
1034 | </dd> |
|
|
1035 | <dt>ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]</dt> |
|
|
1036 | <dd> |
|
|
1037 | <p>The current reschedule callback, or <code>0</code>, if this functionality is |
|
|
1038 | switched off. Can be changed any time, but changes only take effect when |
|
|
1039 | the periodic timer fires or <code>ev_periodic_again</code> is being called.</p> |
|
|
1040 | </dd> |
976 | </dl> |
1041 | </dl> |
977 | <p>Example: call a callback every hour, or, more precisely, whenever the |
1042 | <p>Example: call a callback every hour, or, more precisely, whenever the |
978 | system clock is divisible by 3600. The callback invocation times have |
1043 | system clock is divisible by 3600. The callback invocation times have |
979 | potentially a lot of jittering, but good long-term stability.</p> |
1044 | potentially a lot of jittering, but good long-term stability.</p> |
980 | <pre> static void |
1045 | <pre> static void |
… | |
… | |
1010 | |
1075 | |
1011 | |
1076 | |
1012 | </pre> |
1077 | </pre> |
1013 | |
1078 | |
1014 | </div> |
1079 | </div> |
1015 | <h2 id="code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled</h2> |
1080 | <h2 id="code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled!</h2> |
1016 | <div id="code_ev_signal_code_signal_me_when_a-2"> |
1081 | <div id="code_ev_signal_code_signal_me_when_a-2"> |
1017 | <p>Signal watchers will trigger an event when the process receives a specific |
1082 | <p>Signal watchers will trigger an event when the process receives a specific |
1018 | signal one or more times. Even though signals are very asynchronous, libev |
1083 | signal one or more times. Even though signals are very asynchronous, libev |
1019 | will try it's best to deliver signals synchronously, i.e. as part of the |
1084 | will try it's best to deliver signals synchronously, i.e. as part of the |
1020 | normal event processing, like any other event.</p> |
1085 | normal event processing, like any other event.</p> |
… | |
… | |
1029 | <dt>ev_signal_set (ev_signal *, int signum)</dt> |
1094 | <dt>ev_signal_set (ev_signal *, int signum)</dt> |
1030 | <dd> |
1095 | <dd> |
1031 | <p>Configures the watcher to trigger on the given signal number (usually one |
1096 | <p>Configures the watcher to trigger on the given signal number (usually one |
1032 | of the <code>SIGxxx</code> constants).</p> |
1097 | of the <code>SIGxxx</code> constants).</p> |
1033 | </dd> |
1098 | </dd> |
|
|
1099 | <dt>int signum [read-only]</dt> |
|
|
1100 | <dd> |
|
|
1101 | <p>The signal the watcher watches out for.</p> |
|
|
1102 | </dd> |
1034 | </dl> |
1103 | </dl> |
1035 | |
1104 | |
1036 | |
1105 | |
1037 | |
1106 | |
1038 | |
1107 | |
1039 | |
1108 | |
1040 | </div> |
1109 | </div> |
1041 | <h2 id="code_ev_child_code_wait_for_pid_stat"><code>ev_child</code> - wait for pid status changes</h2> |
1110 | <h2 id="code_ev_child_code_watch_out_for_pro"><code>ev_child</code> - watch out for process status changes</h2> |
1042 | <div id="code_ev_child_code_wait_for_pid_stat-2"> |
1111 | <div id="code_ev_child_code_watch_out_for_pro-2"> |
1043 | <p>Child watchers trigger when your process receives a SIGCHLD in response to |
1112 | <p>Child watchers trigger when your process receives a SIGCHLD in response to |
1044 | some child status changes (most typically when a child of yours dies).</p> |
1113 | some child status changes (most typically when a child of yours dies).</p> |
1045 | <dl> |
1114 | <dl> |
1046 | <dt>ev_child_init (ev_child *, callback, int pid)</dt> |
1115 | <dt>ev_child_init (ev_child *, callback, int pid)</dt> |
1047 | <dt>ev_child_set (ev_child *, int pid)</dt> |
1116 | <dt>ev_child_set (ev_child *, int pid)</dt> |
… | |
… | |
1050 | <i>any</i> process if <code>pid</code> is specified as <code>0</code>). The callback can look |
1119 | <i>any</i> process if <code>pid</code> is specified as <code>0</code>). The callback can look |
1051 | at the <code>rstatus</code> member of the <code>ev_child</code> watcher structure to see |
1120 | at the <code>rstatus</code> member of the <code>ev_child</code> watcher structure to see |
1052 | the status word (use the macros from <code>sys/wait.h</code> and see your systems |
1121 | the status word (use the macros from <code>sys/wait.h</code> and see your systems |
1053 | <code>waitpid</code> documentation). The <code>rpid</code> member contains the pid of the |
1122 | <code>waitpid</code> documentation). The <code>rpid</code> member contains the pid of the |
1054 | process causing the status change.</p> |
1123 | process causing the status change.</p> |
|
|
1124 | </dd> |
|
|
1125 | <dt>int pid [read-only]</dt> |
|
|
1126 | <dd> |
|
|
1127 | <p>The process id this watcher watches out for, or <code>0</code>, meaning any process id.</p> |
|
|
1128 | </dd> |
|
|
1129 | <dt>int rpid [read-write]</dt> |
|
|
1130 | <dd> |
|
|
1131 | <p>The process id that detected a status change.</p> |
|
|
1132 | </dd> |
|
|
1133 | <dt>int rstatus [read-write]</dt> |
|
|
1134 | <dd> |
|
|
1135 | <p>The process exit/trace status caused by <code>rpid</code> (see your systems |
|
|
1136 | <code>waitpid</code> and <code>sys/wait.h</code> documentation for details).</p> |
1055 | </dd> |
1137 | </dd> |
1056 | </dl> |
1138 | </dl> |
1057 | <p>Example: try to exit cleanly on SIGINT and SIGTERM.</p> |
1139 | <p>Example: try to exit cleanly on SIGINT and SIGTERM.</p> |
1058 | <pre> static void |
1140 | <pre> static void |
1059 | sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
1141 | sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
… | |
… | |
1069 | |
1151 | |
1070 | |
1152 | |
1071 | </pre> |
1153 | </pre> |
1072 | |
1154 | |
1073 | </div> |
1155 | </div> |
|
|
1156 | <h2 id="code_ev_stat_code_did_the_file_attri"><code>ev_stat</code> - did the file attributes just change?</h2> |
|
|
1157 | <div id="code_ev_stat_code_did_the_file_attri-2"> |
|
|
1158 | <p>This watches a filesystem path for attribute changes. That is, it calls |
|
|
1159 | <code>stat</code> regularly (or when the OS says it changed) and sees if it changed |
|
|
1160 | compared to the last time, invoking the callback if it did.</p> |
|
|
1161 | <p>The path does not need to exist: changing from "path exists" to "path does |
|
|
1162 | not exist" is a status change like any other. The condition "path does |
|
|
1163 | not exist" is signified by the <code>st_nlink</code> field being zero (which is |
|
|
1164 | otherwise always forced to be at least one) and all the other fields of |
|
|
1165 | the stat buffer having unspecified contents.</p> |
|
|
1166 | <p>Since there is no standard to do this, the portable implementation simply |
|
|
1167 | calls <code>stat (2)</code> regulalry on the path to see if it changed somehow. You |
|
|
1168 | can specify a recommended polling interval for this case. If you specify |
|
|
1169 | a polling interval of <code>0</code> (highly recommended!) then a <i>suitable, |
|
|
1170 | unspecified default</i> value will be used (which you can expect to be around |
|
|
1171 | five seconds, although this might change dynamically). Libev will also |
|
|
1172 | impose a minimum interval which is currently around <code>0.1</code>, but thats |
|
|
1173 | usually overkill.</p> |
|
|
1174 | <p>This watcher type is not meant for massive numbers of stat watchers, |
|
|
1175 | as even with OS-supported change notifications, this can be |
|
|
1176 | resource-intensive.</p> |
|
|
1177 | <p>At the time of this writing, no specific OS backends are implemented, but |
|
|
1178 | if demand increases, at least a kqueue and inotify backend will be added.</p> |
|
|
1179 | <dl> |
|
|
1180 | <dt>ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)</dt> |
|
|
1181 | <dt>ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)</dt> |
|
|
1182 | <dd> |
|
|
1183 | <p>Configures the watcher to wait for status changes of the given |
|
|
1184 | <code>path</code>. The <code>interval</code> is a hint on how quickly a change is expected to |
|
|
1185 | be detected and should normally be specified as <code>0</code> to let libev choose |
|
|
1186 | a suitable value. The memory pointed to by <code>path</code> must point to the same |
|
|
1187 | path for as long as the watcher is active.</p> |
|
|
1188 | <p>The callback will be receive <code>EV_STAT</code> when a change was detected, |
|
|
1189 | relative to the attributes at the time the watcher was started (or the |
|
|
1190 | last change was detected).</p> |
|
|
1191 | </dd> |
|
|
1192 | <dt>ev_stat_stat (ev_stat *)</dt> |
|
|
1193 | <dd> |
|
|
1194 | <p>Updates the stat buffer immediately with new values. If you change the |
|
|
1195 | watched path in your callback, you could call this fucntion to avoid |
|
|
1196 | detecting this change (while introducing a race condition). Can also be |
|
|
1197 | useful simply to find out the new values.</p> |
|
|
1198 | </dd> |
|
|
1199 | <dt>ev_statdata attr [read-only]</dt> |
|
|
1200 | <dd> |
|
|
1201 | <p>The most-recently detected attributes of the file. Although the type is of |
|
|
1202 | <code>ev_statdata</code>, this is usually the (or one of the) <code>struct stat</code> types |
|
|
1203 | suitable for your system. If the <code>st_nlink</code> member is <code>0</code>, then there |
|
|
1204 | was some error while <code>stat</code>ing the file.</p> |
|
|
1205 | </dd> |
|
|
1206 | <dt>ev_statdata prev [read-only]</dt> |
|
|
1207 | <dd> |
|
|
1208 | <p>The previous attributes of the file. The callback gets invoked whenever |
|
|
1209 | <code>prev</code> != <code>attr</code>.</p> |
|
|
1210 | </dd> |
|
|
1211 | <dt>ev_tstamp interval [read-only]</dt> |
|
|
1212 | <dd> |
|
|
1213 | <p>The specified interval.</p> |
|
|
1214 | </dd> |
|
|
1215 | <dt>const char *path [read-only]</dt> |
|
|
1216 | <dd> |
|
|
1217 | <p>The filesystem path that is being watched.</p> |
|
|
1218 | </dd> |
|
|
1219 | </dl> |
|
|
1220 | <p>Example: Watch <code>/etc/passwd</code> for attribute changes.</p> |
|
|
1221 | <pre> static void |
|
|
1222 | passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) |
|
|
1223 | { |
|
|
1224 | /* /etc/passwd changed in some way */ |
|
|
1225 | if (w->attr.st_nlink) |
|
|
1226 | { |
|
|
1227 | printf ("passwd current size %ld\n", (long)w->attr.st_size); |
|
|
1228 | printf ("passwd current atime %ld\n", (long)w->attr.st_mtime); |
|
|
1229 | printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime); |
|
|
1230 | } |
|
|
1231 | else |
|
|
1232 | /* you shalt not abuse printf for puts */ |
|
|
1233 | puts ("wow, /etc/passwd is not there, expect problems. " |
|
|
1234 | "if this is windows, they already arrived\n"); |
|
|
1235 | } |
|
|
1236 | |
|
|
1237 | ... |
|
|
1238 | ev_stat passwd; |
|
|
1239 | |
|
|
1240 | ev_stat_init (&passwd, passwd_cb, "/etc/passwd"); |
|
|
1241 | ev_stat_start (loop, &passwd); |
|
|
1242 | |
|
|
1243 | |
|
|
1244 | |
|
|
1245 | |
|
|
1246 | </pre> |
|
|
1247 | |
|
|
1248 | </div> |
1074 | <h2 id="code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do</h2> |
1249 | <h2 id="code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do...</h2> |
1075 | <div id="code_ev_idle_code_when_you_ve_got_no-2"> |
1250 | <div id="code_ev_idle_code_when_you_ve_got_no-2"> |
1076 | <p>Idle watchers trigger events when there are no other events are pending |
1251 | <p>Idle watchers trigger events when there are no other events are pending |
1077 | (prepare, check and other idle watchers do not count). That is, as long |
1252 | (prepare, check and other idle watchers do not count). That is, as long |
1078 | as your process is busy handling sockets or timeouts (or even signals, |
1253 | as your process is busy handling sockets or timeouts (or even signals, |
1079 | imagine) it will not be triggered. But when your process is idle all idle |
1254 | imagine) it will not be triggered. But when your process is idle all idle |
… | |
… | |
1112 | |
1287 | |
1113 | |
1288 | |
1114 | </pre> |
1289 | </pre> |
1115 | |
1290 | |
1116 | </div> |
1291 | </div> |
1117 | <h2 id="code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</h2> |
1292 | <h2 id="code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop!</h2> |
1118 | <div id="code_ev_prepare_code_and_code_ev_che-2"> |
1293 | <div id="code_ev_prepare_code_and_code_ev_che-2"> |
1119 | <p>Prepare and check watchers are usually (but not always) used in tandem: |
1294 | <p>Prepare and check watchers are usually (but not always) used in tandem: |
1120 | prepare watchers get invoked before the process blocks and check watchers |
1295 | prepare watchers get invoked before the process blocks and check watchers |
1121 | afterwards.</p> |
1296 | afterwards.</p> |
|
|
1297 | <p>You <i>must not</i> call <code>ev_loop</code> or similar functions that enter |
|
|
1298 | the current event loop from either <code>ev_prepare</code> or <code>ev_check</code> |
|
|
1299 | watchers. Other loops than the current one are fine, however. The |
|
|
1300 | rationale behind this is that you do not need to check for recursion in |
|
|
1301 | those watchers, i.e. the sequence will always be <code>ev_prepare</code>, blocking, |
|
|
1302 | <code>ev_check</code> so if you have one watcher of each kind they will always be |
|
|
1303 | called in pairs bracketing the blocking call.</p> |
1122 | <p>Their main purpose is to integrate other event mechanisms into libev and |
1304 | <p>Their main purpose is to integrate other event mechanisms into libev and |
1123 | their use is somewhat advanced. This could be used, for example, to track |
1305 | their use is somewhat advanced. This could be used, for example, to track |
1124 | variable changes, implement your own watchers, integrate net-snmp or a |
1306 | variable changes, implement your own watchers, integrate net-snmp or a |
1125 | coroutine library and lots more.</p> |
1307 | coroutine library and lots more. They are also occasionally useful if |
|
|
1308 | you cache some data and want to flush it before blocking (for example, |
|
|
1309 | in X programs you might want to do an <code>XFlush ()</code> in an <code>ev_prepare</code> |
|
|
1310 | watcher).</p> |
1126 | <p>This is done by examining in each prepare call which file descriptors need |
1311 | <p>This is done by examining in each prepare call which file descriptors need |
1127 | to be watched by the other library, registering <code>ev_io</code> watchers for |
1312 | to be watched by the other library, registering <code>ev_io</code> watchers for |
1128 | them and starting an <code>ev_timer</code> watcher for any timeouts (many libraries |
1313 | them and starting an <code>ev_timer</code> watcher for any timeouts (many libraries |
1129 | provide just this functionality). Then, in the check watcher you check for |
1314 | provide just this functionality). Then, in the check watcher you check for |
1130 | any events that occured (by checking the pending status of all watchers |
1315 | any events that occured (by checking the pending status of all watchers |
… | |
… | |
1146 | <p>Initialises and configures the prepare or check watcher - they have no |
1331 | <p>Initialises and configures the prepare or check watcher - they have no |
1147 | parameters of any kind. There are <code>ev_prepare_set</code> and <code>ev_check_set</code> |
1332 | parameters of any kind. There are <code>ev_prepare_set</code> and <code>ev_check_set</code> |
1148 | macros, but using them is utterly, utterly and completely pointless.</p> |
1333 | macros, but using them is utterly, utterly and completely pointless.</p> |
1149 | </dd> |
1334 | </dd> |
1150 | </dl> |
1335 | </dl> |
1151 | <p>Example: *TODO*.</p> |
1336 | <p>Example: To include a library such as adns, you would add IO watchers |
|
|
1337 | and a timeout watcher in a prepare handler, as required by libadns, and |
|
|
1338 | in a check watcher, destroy them and call into libadns. What follows is |
|
|
1339 | pseudo-code only of course:</p> |
|
|
1340 | <pre> static ev_io iow [nfd]; |
|
|
1341 | static ev_timer tw; |
1152 | |
1342 | |
|
|
1343 | static void |
|
|
1344 | io_cb (ev_loop *loop, ev_io *w, int revents) |
|
|
1345 | { |
|
|
1346 | // set the relevant poll flags |
|
|
1347 | // could also call adns_processreadable etc. here |
|
|
1348 | struct pollfd *fd = (struct pollfd *)w->data; |
|
|
1349 | if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
|
|
1350 | if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
|
|
1351 | } |
1153 | |
1352 | |
|
|
1353 | // create io watchers for each fd and a timer before blocking |
|
|
1354 | static void |
|
|
1355 | adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
|
|
1356 | { |
|
|
1357 | int timeout = 3600000;truct pollfd fds [nfd]; |
|
|
1358 | // actual code will need to loop here and realloc etc. |
|
|
1359 | adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
1154 | |
1360 | |
|
|
1361 | /* the callback is illegal, but won't be called as we stop during check */ |
|
|
1362 | ev_timer_init (&tw, 0, timeout * 1e-3); |
|
|
1363 | ev_timer_start (loop, &tw); |
1155 | |
1364 | |
|
|
1365 | // create on ev_io per pollfd |
|
|
1366 | for (int i = 0; i < nfd; ++i) |
|
|
1367 | { |
|
|
1368 | ev_io_init (iow + i, io_cb, fds [i].fd, |
|
|
1369 | ((fds [i].events & POLLIN ? EV_READ : 0) |
|
|
1370 | | (fds [i].events & POLLOUT ? EV_WRITE : 0))); |
1156 | |
1371 | |
|
|
1372 | fds [i].revents = 0; |
|
|
1373 | iow [i].data = fds + i; |
|
|
1374 | ev_io_start (loop, iow + i); |
|
|
1375 | } |
|
|
1376 | } |
|
|
1377 | |
|
|
1378 | // stop all watchers after blocking |
|
|
1379 | static void |
|
|
1380 | adns_check_cb (ev_loop *loop, ev_check *w, int revents) |
|
|
1381 | { |
|
|
1382 | ev_timer_stop (loop, &tw); |
|
|
1383 | |
|
|
1384 | for (int i = 0; i < nfd; ++i) |
|
|
1385 | ev_io_stop (loop, iow + i); |
|
|
1386 | |
|
|
1387 | adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); |
|
|
1388 | } |
|
|
1389 | |
|
|
1390 | |
|
|
1391 | |
|
|
1392 | |
|
|
1393 | </pre> |
|
|
1394 | |
1157 | </div> |
1395 | </div> |
1158 | <h2 id="code_ev_embed_code_when_one_backend_"><code>ev_embed</code> - when one backend isn't enough</h2> |
1396 | <h2 id="code_ev_embed_code_when_one_backend_"><code>ev_embed</code> - when one backend isn't enough...</h2> |
1159 | <div id="code_ev_embed_code_when_one_backend_-2"> |
1397 | <div id="code_ev_embed_code_when_one_backend_-2"> |
1160 | <p>This is a rather advanced watcher type that lets you embed one event loop |
1398 | <p>This is a rather advanced watcher type that lets you embed one event loop |
1161 | into another (currently only <code>ev_io</code> events are supported in the embedded |
1399 | into another (currently only <code>ev_io</code> events are supported in the embedded |
1162 | loop, other types of watchers might be handled in a delayed or incorrect |
1400 | loop, other types of watchers might be handled in a delayed or incorrect |
1163 | fashion and must not be used).</p> |
1401 | fashion and must not be used).</p> |
… | |
… | |
1230 | <dt>ev_embed_sweep (loop, ev_embed *)</dt> |
1468 | <dt>ev_embed_sweep (loop, ev_embed *)</dt> |
1231 | <dd> |
1469 | <dd> |
1232 | <p>Make a single, non-blocking sweep over the embedded loop. This works |
1470 | <p>Make a single, non-blocking sweep over the embedded loop. This works |
1233 | similarly to <code>ev_loop (embedded_loop, EVLOOP_NONBLOCK)</code>, but in the most |
1471 | similarly to <code>ev_loop (embedded_loop, EVLOOP_NONBLOCK)</code>, but in the most |
1234 | apropriate way for embedded loops.</p> |
1472 | apropriate way for embedded loops.</p> |
|
|
1473 | </dd> |
|
|
1474 | <dt>struct ev_loop *loop [read-only]</dt> |
|
|
1475 | <dd> |
|
|
1476 | <p>The embedded event loop.</p> |
1235 | </dd> |
1477 | </dd> |
1236 | </dl> |
1478 | </dl> |
1237 | |
1479 | |
1238 | |
1480 | |
1239 | |
1481 | |
… | |
… | |
1389 | </dd> |
1631 | </dd> |
1390 | <dt>w->sweep () <code>ev::embed</code> only</dt> |
1632 | <dt>w->sweep () <code>ev::embed</code> only</dt> |
1391 | <dd> |
1633 | <dd> |
1392 | <p>Invokes <code>ev_embed_sweep</code>.</p> |
1634 | <p>Invokes <code>ev_embed_sweep</code>.</p> |
1393 | </dd> |
1635 | </dd> |
|
|
1636 | <dt>w->update () <code>ev::stat</code> only</dt> |
|
|
1637 | <dd> |
|
|
1638 | <p>Invokes <code>ev_stat_stat</code>.</p> |
|
|
1639 | </dd> |
1394 | </dl> |
1640 | </dl> |
1395 | </p> |
1641 | </p> |
1396 | </dd> |
1642 | </dd> |
1397 | </dl> |
1643 | </dl> |
1398 | <p>Example: Define a class with an IO and idle watcher, start one of them in |
1644 | <p>Example: Define a class with an IO and idle watcher, start one of them in |
… | |
… | |
1460 | ev_vars.h |
1706 | ev_vars.h |
1461 | ev_wrap.h |
1707 | ev_wrap.h |
1462 | |
1708 | |
1463 | ev_win32.c required on win32 platforms only |
1709 | ev_win32.c required on win32 platforms only |
1464 | |
1710 | |
1465 | ev_select.c only when select backend is enabled (which is is by default) |
1711 | ev_select.c only when select backend is enabled (which is by default) |
1466 | ev_poll.c only when poll backend is enabled (disabled by default) |
1712 | ev_poll.c only when poll backend is enabled (disabled by default) |
1467 | ev_epoll.c only when the epoll backend is enabled (disabled by default) |
1713 | ev_epoll.c only when the epoll backend is enabled (disabled by default) |
1468 | ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
1714 | ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
1469 | ev_port.c only when the solaris port backend is enabled (disabled by default) |
1715 | ev_port.c only when the solaris port backend is enabled (disabled by default) |
1470 | |
1716 | |
1471 | </pre> |
1717 | </pre> |
1472 | <p><cite>ev.c</cite> includes the backend files directly when enabled, so you only need |
1718 | <p><cite>ev.c</cite> includes the backend files directly when enabled, so you only need |
1473 | to compile a single file.</p> |
1719 | to compile this single file.</p> |
1474 | |
1720 | |
1475 | </div> |
1721 | </div> |
1476 | <h3 id="LIBEVENT_COMPATIBILITY_API">LIBEVENT COMPATIBILITY API</h3> |
1722 | <h3 id="LIBEVENT_COMPATIBILITY_API">LIBEVENT COMPATIBILITY API</h3> |
1477 | <div id="LIBEVENT_COMPATIBILITY_API_CONTENT"> |
1723 | <div id="LIBEVENT_COMPATIBILITY_API_CONTENT"> |
1478 | <p>To include the libevent compatibility API, also include:</p> |
1724 | <p>To include the libevent compatibility API, also include:</p> |
… | |
… | |
1493 | </div> |
1739 | </div> |
1494 | <h3 id="AUTOCONF_SUPPORT">AUTOCONF SUPPORT</h3> |
1740 | <h3 id="AUTOCONF_SUPPORT">AUTOCONF SUPPORT</h3> |
1495 | <div id="AUTOCONF_SUPPORT_CONTENT"> |
1741 | <div id="AUTOCONF_SUPPORT_CONTENT"> |
1496 | <p>Instead of using <code>EV_STANDALONE=1</code> and providing your config in |
1742 | <p>Instead of using <code>EV_STANDALONE=1</code> and providing your config in |
1497 | whatever way you want, you can also <code>m4_include([libev.m4])</code> in your |
1743 | whatever way you want, you can also <code>m4_include([libev.m4])</code> in your |
1498 | <cite>configure.ac</cite> and leave <code>EV_STANDALONE</code> off. <cite>ev.c</cite> will then include |
1744 | <cite>configure.ac</cite> and leave <code>EV_STANDALONE</code> undefined. <cite>ev.c</cite> will then |
1499 | <cite>config.h</cite> and configure itself accordingly.</p> |
1745 | include <cite>config.h</cite> and configure itself accordingly.</p> |
1500 | <p>For this of course you need the m4 file:</p> |
1746 | <p>For this of course you need the m4 file:</p> |
1501 | <pre> libev.m4 |
1747 | <pre> libev.m4 |
1502 | |
1748 | |
1503 | </pre> |
1749 | </pre> |
1504 | |
1750 | |
… | |
… | |
1583 | otherwise another method will be used as fallback. This is the preferred |
1829 | otherwise another method will be used as fallback. This is the preferred |
1584 | backend for BSD and BSD-like systems, although on most BSDs kqueue only |
1830 | backend for BSD and BSD-like systems, although on most BSDs kqueue only |
1585 | supports some types of fds correctly (the only platform we found that |
1831 | supports some types of fds correctly (the only platform we found that |
1586 | supports ptys for example was NetBSD), so kqueue might be compiled in, but |
1832 | supports ptys for example was NetBSD), so kqueue might be compiled in, but |
1587 | not be used unless explicitly requested. The best way to use it is to find |
1833 | not be used unless explicitly requested. The best way to use it is to find |
1588 | out wether kqueue supports your type of fd properly and use an embedded |
1834 | out whether kqueue supports your type of fd properly and use an embedded |
1589 | kqueue loop.</p> |
1835 | kqueue loop.</p> |
1590 | </dd> |
1836 | </dd> |
1591 | <dt>EV_USE_PORT</dt> |
1837 | <dt>EV_USE_PORT</dt> |
1592 | <dd> |
1838 | <dd> |
1593 | <p>If defined to be <code>1</code>, libev will compile in support for the Solaris |
1839 | <p>If defined to be <code>1</code>, libev will compile in support for the Solaris |
… | |
… | |
1629 | will have the <code>struct ev_loop *</code> as first argument, and you can create |
1875 | will have the <code>struct ev_loop *</code> as first argument, and you can create |
1630 | additional independent event loops. Otherwise there will be no support |
1876 | additional independent event loops. Otherwise there will be no support |
1631 | for multiple event loops and there is no first event loop pointer |
1877 | for multiple event loops and there is no first event loop pointer |
1632 | argument. Instead, all functions act on the single default loop.</p> |
1878 | argument. Instead, all functions act on the single default loop.</p> |
1633 | </dd> |
1879 | </dd> |
1634 | <dt>EV_PERIODICS</dt> |
1880 | <dt>EV_PERIODIC_ENABLE</dt> |
1635 | <dd> |
1881 | <dd> |
1636 | <p>If undefined or defined to be <code>1</code>, then periodic timers are supported, |
1882 | <p>If undefined or defined to be <code>1</code>, then periodic timers are supported. If |
1637 | otherwise not. This saves a few kb of code.</p> |
1883 | defined to be <code>0</code>, then they are not. Disabling them saves a few kB of |
|
|
1884 | code.</p> |
|
|
1885 | </dd> |
|
|
1886 | <dt>EV_EMBED_ENABLE</dt> |
|
|
1887 | <dd> |
|
|
1888 | <p>If undefined or defined to be <code>1</code>, then embed watchers are supported. If |
|
|
1889 | defined to be <code>0</code>, then they are not.</p> |
|
|
1890 | </dd> |
|
|
1891 | <dt>EV_STAT_ENABLE</dt> |
|
|
1892 | <dd> |
|
|
1893 | <p>If undefined or defined to be <code>1</code>, then stat watchers are supported. If |
|
|
1894 | defined to be <code>0</code>, then they are not.</p> |
|
|
1895 | </dd> |
|
|
1896 | <dt>EV_MINIMAL</dt> |
|
|
1897 | <dd> |
|
|
1898 | <p>If you need to shave off some kilobytes of code at the expense of some |
|
|
1899 | speed, define this symbol to <code>1</code>. Currently only used for gcc to override |
|
|
1900 | some inlining decisions, saves roughly 30% codesize of amd64.</p> |
1638 | </dd> |
1901 | </dd> |
1639 | <dt>EV_COMMON</dt> |
1902 | <dt>EV_COMMON</dt> |
1640 | <dd> |
1903 | <dd> |
1641 | <p>By default, all watchers have a <code>void *data</code> member. By redefining |
1904 | <p>By default, all watchers have a <code>void *data</code> member. By redefining |
1642 | this macro to a something else you can include more and other types of |
1905 | this macro to a something else you can include more and other types of |
… | |
… | |
1647 | SV *self; /* contains this struct */ \ |
1910 | SV *self; /* contains this struct */ \ |
1648 | SV *cb_sv, *fh /* note no trailing ";" */ |
1911 | SV *cb_sv, *fh /* note no trailing ";" */ |
1649 | |
1912 | |
1650 | </pre> |
1913 | </pre> |
1651 | </dd> |
1914 | </dd> |
1652 | <dt>EV_CB_DECLARE(type)</dt> |
1915 | <dt>EV_CB_DECLARE (type)</dt> |
1653 | <dt>EV_CB_INVOKE(watcher,revents)</dt> |
1916 | <dt>EV_CB_INVOKE (watcher, revents)</dt> |
1654 | <dt>ev_set_cb(ev,cb)</dt> |
1917 | <dt>ev_set_cb (ev, cb)</dt> |
1655 | <dd> |
1918 | <dd> |
1656 | <p>Can be used to change the callback member declaration in each watcher, |
1919 | <p>Can be used to change the callback member declaration in each watcher, |
1657 | and the way callbacks are invoked and set. Must expand to a struct member |
1920 | and the way callbacks are invoked and set. Must expand to a struct member |
1658 | definition and a statement, respectively. See the <cite>ev.v</cite> header file for |
1921 | definition and a statement, respectively. See the <cite>ev.v</cite> header file for |
1659 | their default definitions. One possible use for overriding these is to |
1922 | their default definitions. One possible use for overriding these is to |
1660 | avoid the ev_loop pointer as first argument in all cases, or to use method |
1923 | avoid the <code>struct ev_loop *</code> as first argument in all cases, or to use |
1661 | calls instead of plain function calls in C++.</p> |
1924 | method calls instead of plain function calls in C++.</p> |
1662 | |
1925 | |
1663 | </div> |
1926 | </div> |
1664 | <h2 id="EXAMPLES">EXAMPLES</h2> |
1927 | <h2 id="EXAMPLES">EXAMPLES</h2> |
1665 | <div id="EXAMPLES_CONTENT"> |
1928 | <div id="EXAMPLES_CONTENT"> |
1666 | <p>For a real-world example of a program the includes libev |
1929 | <p>For a real-world example of a program the includes libev |
… | |
… | |
1682 | </pre> |
1945 | </pre> |
1683 | <p>And a <cite>ev_cpp.C</cite> implementation file that contains libev proper and is compiled:</p> |
1946 | <p>And a <cite>ev_cpp.C</cite> implementation file that contains libev proper and is compiled:</p> |
1684 | <pre> #include "ev_cpp.h" |
1947 | <pre> #include "ev_cpp.h" |
1685 | #include "ev.c" |
1948 | #include "ev.c" |
1686 | |
1949 | |
|
|
1950 | |
|
|
1951 | |
|
|
1952 | |
1687 | </pre> |
1953 | </pre> |
|
|
1954 | |
|
|
1955 | </div> |
|
|
1956 | <h1 id="COMPLEXITIES">COMPLEXITIES</h1><p><a href="#TOP" class="toplink">Top</a></p> |
|
|
1957 | <div id="COMPLEXITIES_CONTENT"> |
|
|
1958 | <p>In this section the complexities of (many of) the algorithms used inside |
|
|
1959 | libev will be explained. For complexity discussions about backends see the |
|
|
1960 | documentation for <code>ev_default_init</code>.</p> |
|
|
1961 | <p> |
|
|
1962 | <dl> |
|
|
1963 | <dt>Starting and stopping timer/periodic watchers: O(log skipped_other_timers)</dt> |
|
|
1964 | <dt>Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)</dt> |
|
|
1965 | <dt>Starting io/check/prepare/idle/signal/child watchers: O(1)</dt> |
|
|
1966 | <dt>Stopping check/prepare/idle watchers: O(1)</dt> |
|
|
1967 | <dt>Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))</dt> |
|
|
1968 | <dt>Finding the next timer per loop iteration: O(1)</dt> |
|
|
1969 | <dt>Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)</dt> |
|
|
1970 | <dt>Activating one watcher: O(1)</dt> |
|
|
1971 | </dl> |
|
|
1972 | </p> |
|
|
1973 | |
|
|
1974 | |
|
|
1975 | |
|
|
1976 | |
1688 | |
1977 | |
1689 | </div> |
1978 | </div> |
1690 | <h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p> |
1979 | <h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p> |
1691 | <div id="AUTHOR_CONTENT"> |
1980 | <div id="AUTHOR_CONTENT"> |
1692 | <p>Marc Lehmann <libev@schmorp.de>.</p> |
1981 | <p>Marc Lehmann <libev@schmorp.de>.</p> |