| … | |
… | |
| 127 | .\} |
127 | .\} |
| 128 | .rm #[ #] #H #V #F C |
128 | .rm #[ #] #H #V #F C |
| 129 | .\" ======================================================================== |
129 | .\" ======================================================================== |
| 130 | .\" |
130 | .\" |
| 131 | .IX Title ""<STANDARD INPUT>" 1" |
131 | .IX Title ""<STANDARD INPUT>" 1" |
| 132 | .TH "<STANDARD INPUT>" 1 "2007-11-24" "perl v5.8.8" "User Contributed Perl Documentation" |
132 | .TH "<STANDARD INPUT>" 1 "2007-11-26" "perl v5.8.8" "User Contributed Perl Documentation" |
| 133 | .SH "NAME" |
133 | .SH "NAME" |
| 134 | libev \- a high performance full\-featured event loop written in C |
134 | libev \- a high performance full\-featured event loop written in C |
| 135 | .SH "SYNOPSIS" |
135 | .SH "SYNOPSIS" |
| 136 | .IX Header "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
| 137 | .Vb 1 |
137 | .Vb 1 |
| … | |
… | |
| 458 | \& fatal ("no epoll found here, maybe it hides under your chair"); |
458 | \& fatal ("no epoll found here, maybe it hides under your chair"); |
| 459 | .Ve |
459 | .Ve |
| 460 | .IP "ev_default_destroy ()" 4 |
460 | .IP "ev_default_destroy ()" 4 |
| 461 | .IX Item "ev_default_destroy ()" |
461 | .IX Item "ev_default_destroy ()" |
| 462 | Destroys the default loop again (frees all memory and kernel state |
462 | Destroys the default loop again (frees all memory and kernel state |
| 463 | etc.). This stops all registered event watchers (by not touching them in |
463 | etc.). None of the active event watchers will be stopped in the normal |
| 464 | any way whatsoever, although you cannot rely on this :). |
464 | sense, so e.g. \f(CW\*(C`ev_is_active\*(C'\fR might still return true. It is your |
|
|
465 | responsibility to either stop all watchers cleanly yoursef \fIbefore\fR |
|
|
466 | calling this function, or cope with the fact afterwards (which is usually |
|
|
467 | the easiest thing, youc na just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them |
|
|
468 | for example). |
| 465 | .IP "ev_loop_destroy (loop)" 4 |
469 | .IP "ev_loop_destroy (loop)" 4 |
| 466 | .IX Item "ev_loop_destroy (loop)" |
470 | .IX Item "ev_loop_destroy (loop)" |
| 467 | Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an |
471 | Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an |
| 468 | earlier call to \f(CW\*(C`ev_loop_new\*(C'\fR. |
472 | earlier call to \f(CW\*(C`ev_loop_new\*(C'\fR. |
| 469 | .IP "ev_default_fork ()" 4 |
473 | .IP "ev_default_fork ()" 4 |
| … | |
… | |
| 713 | Libev will usually signal a few \*(L"dummy\*(R" events together with an error, |
717 | Libev will usually signal a few \*(L"dummy\*(R" events together with an error, |
| 714 | for example it might indicate that a fd is readable or writable, and if |
718 | for example it might indicate that a fd is readable or writable, and if |
| 715 | your callbacks is well-written it can just attempt the operation and cope |
719 | your callbacks is well-written it can just attempt the operation and cope |
| 716 | with the error from \fIread()\fR or \fIwrite()\fR. This will not work in multithreaded |
720 | with the error from \fIread()\fR or \fIwrite()\fR. This will not work in multithreaded |
| 717 | programs, though, so beware. |
721 | programs, though, so beware. |
| 718 | .Sh "\s-1SUMMARY\s0 \s-1OF\s0 \s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0" |
722 | .Sh "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0" |
| 719 | .IX Subsection "SUMMARY OF GENERIC WATCHER FUNCTIONS" |
723 | .IX Subsection "GENERIC WATCHER FUNCTIONS" |
| 720 | In the following description, \f(CW\*(C`TYPE\*(C'\fR stands for the watcher type, |
724 | In the following description, \f(CW\*(C`TYPE\*(C'\fR stands for the watcher type, |
| 721 | e.g. \f(CW\*(C`timer\*(C'\fR for \f(CW\*(C`ev_timer\*(C'\fR watchers and \f(CW\*(C`io\*(C'\fR for \f(CW\*(C`ev_io\*(C'\fR watchers. |
725 | e.g. \f(CW\*(C`timer\*(C'\fR for \f(CW\*(C`ev_timer\*(C'\fR watchers and \f(CW\*(C`io\*(C'\fR for \f(CW\*(C`ev_io\*(C'\fR watchers. |
| 722 | .ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4 |
726 | .ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4 |
| 723 | .el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4 |
727 | .el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4 |
| 724 | .IX Item "ev_init (ev_TYPE *watcher, callback)" |
728 | .IX Item "ev_init (ev_TYPE *watcher, callback)" |
| … | |
… | |
| 730 | which rolls both calls into one. |
734 | which rolls both calls into one. |
| 731 | .Sp |
735 | .Sp |
| 732 | You can reinitialise a watcher at any time as long as it has been stopped |
736 | You can reinitialise a watcher at any time as long as it has been stopped |
| 733 | (or never started) and there are no pending events outstanding. |
737 | (or never started) and there are no pending events outstanding. |
| 734 | .Sp |
738 | .Sp |
| 735 | The callbakc is always of type \f(CW\*(C`void (*)(ev_loop *loop, ev_TYPE *watcher, |
739 | The callback is always of type \f(CW\*(C`void (*)(ev_loop *loop, ev_TYPE *watcher, |
| 736 | int revents)\*(C'\fR. |
740 | int revents)\*(C'\fR. |
| 737 | .ie n .IP """ev_TYPE_set"" (ev_TYPE *, [args])" 4 |
741 | .ie n .IP """ev_TYPE_set"" (ev_TYPE *, [args])" 4 |
| 738 | .el .IP "\f(CWev_TYPE_set\fR (ev_TYPE *, [args])" 4 |
742 | .el .IP "\f(CWev_TYPE_set\fR (ev_TYPE *, [args])" 4 |
| 739 | .IX Item "ev_TYPE_set (ev_TYPE *, [args])" |
743 | .IX Item "ev_TYPE_set (ev_TYPE *, [args])" |
| 740 | This macro initialises the type-specific parts of a watcher. You need to |
744 | This macro initialises the type-specific parts of a watcher. You need to |
| … | |
… | |
| 818 | have been omitted.... |
822 | have been omitted.... |
| 819 | .SH "WATCHER TYPES" |
823 | .SH "WATCHER TYPES" |
| 820 | .IX Header "WATCHER TYPES" |
824 | .IX Header "WATCHER TYPES" |
| 821 | This section describes each watcher in detail, but will not repeat |
825 | This section describes each watcher in detail, but will not repeat |
| 822 | information given in the last section. |
826 | information given in the last section. |
| 823 | .ie n .Sh """ev_io"" \- is this file descriptor readable or writable" |
827 | .ie n .Sh """ev_io"" \- is this file descriptor readable or writable?" |
| 824 | .el .Sh "\f(CWev_io\fP \- is this file descriptor readable or writable" |
828 | .el .Sh "\f(CWev_io\fP \- is this file descriptor readable or writable?" |
| 825 | .IX Subsection "ev_io - is this file descriptor readable or writable" |
829 | .IX Subsection "ev_io - is this file descriptor readable or writable?" |
| 826 | I/O watchers check whether a file descriptor is readable or writable |
830 | I/O watchers check whether a file descriptor is readable or writable |
| 827 | in each iteration of the event loop (This behaviour is called |
831 | in each iteration of the event loop, or, more precisely, when reading |
| 828 | level-triggering because you keep receiving events as long as the |
832 | would not block the process and writing would at least be able to write |
| 829 | condition persists. Remember you can stop the watcher if you don't want to |
833 | some data. This behaviour is called level-triggering because you keep |
| 830 | act on the event and neither want to receive future events). |
834 | receiving events as long as the condition persists. Remember you can stop |
|
|
835 | the watcher if you don't want to act on the event and neither want to |
|
|
836 | receive future events. |
| 831 | .PP |
837 | .PP |
| 832 | In general you can register as many read and/or write event watchers per |
838 | In general you can register as many read and/or write event watchers per |
| 833 | fd as you want (as long as you don't confuse yourself). Setting all file |
839 | fd as you want (as long as you don't confuse yourself). Setting all file |
| 834 | descriptors to non-blocking mode is also usually a good idea (but not |
840 | descriptors to non-blocking mode is also usually a good idea (but not |
| 835 | required if you know what you are doing). |
841 | required if you know what you are doing). |
| 836 | .PP |
842 | .PP |
| 837 | You have to be careful with dup'ed file descriptors, though. Some backends |
843 | You have to be careful with dup'ed file descriptors, though. Some backends |
| 838 | (the linux epoll backend is a notable example) cannot handle dup'ed file |
844 | (the linux epoll backend is a notable example) cannot handle dup'ed file |
| 839 | descriptors correctly if you register interest in two or more fds pointing |
845 | descriptors correctly if you register interest in two or more fds pointing |
| 840 | to the same underlying file/socket etc. description (that is, they share |
846 | to the same underlying file/socket/etc. description (that is, they share |
| 841 | the same underlying \*(L"file open\*(R"). |
847 | the same underlying \*(L"file open\*(R"). |
| 842 | .PP |
848 | .PP |
| 843 | If you must do this, then force the use of a known-to-be-good backend |
849 | If you must do this, then force the use of a known-to-be-good backend |
| 844 | (at the time of this writing, this includes only \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and |
850 | (at the time of this writing, this includes only \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and |
| 845 | \&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR). |
851 | \&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR). |
|
|
852 | .PP |
|
|
853 | Another thing you have to watch out for is that it is quite easy to |
|
|
854 | receive \*(L"spurious\*(R" readyness notifications, that is your callback might |
|
|
855 | be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block |
|
|
856 | because there is no data. Not only are some backends known to create a |
|
|
857 | lot of those (for example solaris ports), it is very easy to get into |
|
|
858 | this situation even with a relatively standard program structure. Thus |
|
|
859 | it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning |
|
|
860 | \&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives. |
|
|
861 | .PP |
|
|
862 | If you cannot run the fd in non-blocking mode (for example you should not |
|
|
863 | play around with an Xlib connection), then you have to seperately re-test |
|
|
864 | wether a file descriptor is really ready with a known-to-be good interface |
|
|
865 | such as poll (fortunately in our Xlib example, Xlib already does this on |
|
|
866 | its own, so its quite safe to use). |
| 846 | .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 |
867 | .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 |
| 847 | .IX Item "ev_io_init (ev_io *, callback, int fd, int events)" |
868 | .IX Item "ev_io_init (ev_io *, callback, int fd, int events)" |
| 848 | .PD 0 |
869 | .PD 0 |
| 849 | .IP "ev_io_set (ev_io *, int fd, int events)" 4 |
870 | .IP "ev_io_set (ev_io *, int fd, int events)" 4 |
| 850 | .IX Item "ev_io_set (ev_io *, int fd, int events)" |
871 | .IX Item "ev_io_set (ev_io *, int fd, int events)" |
| 851 | .PD |
872 | .PD |
| 852 | Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The fd is the file descriptor to rceeive |
873 | Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to |
| 853 | events for and events is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or \f(CW\*(C`EV_READ | |
874 | rceeive events for and events is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or |
| 854 | EV_WRITE\*(C'\fR to receive the given events. |
875 | \&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR to receive the given events. |
| 855 | .Sp |
|
|
| 856 | Please note that most of the more scalable backend mechanisms (for example |
|
|
| 857 | epoll and solaris ports) can result in spurious readyness notifications |
|
|
| 858 | for file descriptors, so you practically need to use non-blocking I/O (and |
|
|
| 859 | treat callback invocation as hint only), or retest separately with a safe |
|
|
| 860 | interface before doing I/O (XLib can do this), or force the use of either |
|
|
| 861 | \&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR, which don't suffer from this |
|
|
| 862 | problem. Also note that it is quite easy to have your callback invoked |
|
|
| 863 | when the readyness condition is no longer valid even when employing |
|
|
| 864 | typical ways of handling events, so its a good idea to use non-blocking |
|
|
| 865 | I/O unconditionally. |
|
|
| 866 | .PP |
876 | .PP |
| 867 | Example: call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well |
877 | Example: call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well |
| 868 | readable, but only once. Since it is likely line\-buffered, you could |
878 | readable, but only once. Since it is likely line\-buffered, you could |
| 869 | attempt to read a whole line in the callback: |
879 | attempt to read a whole line in the callback: |
| 870 | .PP |
880 | .PP |
| … | |
… | |
| 883 | \& struct ev_io stdin_readable; |
893 | \& struct ev_io stdin_readable; |
| 884 | \& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); |
894 | \& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); |
| 885 | \& ev_io_start (loop, &stdin_readable); |
895 | \& ev_io_start (loop, &stdin_readable); |
| 886 | \& ev_loop (loop, 0); |
896 | \& ev_loop (loop, 0); |
| 887 | .Ve |
897 | .Ve |
| 888 | .ie n .Sh """ev_timer"" \- relative and optionally recurring timeouts" |
898 | .ie n .Sh """ev_timer"" \- relative and optionally repeating timeouts" |
| 889 | .el .Sh "\f(CWev_timer\fP \- relative and optionally recurring timeouts" |
899 | .el .Sh "\f(CWev_timer\fP \- relative and optionally repeating timeouts" |
| 890 | .IX Subsection "ev_timer - relative and optionally recurring timeouts" |
900 | .IX Subsection "ev_timer - relative and optionally repeating timeouts" |
| 891 | Timer watchers are simple relative timers that generate an event after a |
901 | Timer watchers are simple relative timers that generate an event after a |
| 892 | given time, and optionally repeating in regular intervals after that. |
902 | given time, and optionally repeating in regular intervals after that. |
| 893 | .PP |
903 | .PP |
| 894 | The timers are based on real time, that is, if you register an event that |
904 | The timers are based on real time, that is, if you register an event that |
| 895 | times out after an hour and you reset your system clock to last years |
905 | times out after an hour and you reset your system clock to last years |
| … | |
… | |
| 982 | .Vb 3 |
992 | .Vb 3 |
| 983 | \& // and in some piece of code that gets executed on any "activity": |
993 | \& // and in some piece of code that gets executed on any "activity": |
| 984 | \& // reset the timeout to start ticking again at 10 seconds |
994 | \& // reset the timeout to start ticking again at 10 seconds |
| 985 | \& ev_timer_again (&mytimer); |
995 | \& ev_timer_again (&mytimer); |
| 986 | .Ve |
996 | .Ve |
| 987 | .ie n .Sh """ev_periodic"" \- to cron or not to cron" |
997 | .ie n .Sh """ev_periodic"" \- to cron or not to cron?" |
| 988 | .el .Sh "\f(CWev_periodic\fP \- to cron or not to cron" |
998 | .el .Sh "\f(CWev_periodic\fP \- to cron or not to cron?" |
| 989 | .IX Subsection "ev_periodic - to cron or not to cron" |
999 | .IX Subsection "ev_periodic - to cron or not to cron?" |
| 990 | Periodic watchers are also timers of a kind, but they are very versatile |
1000 | Periodic watchers are also timers of a kind, but they are very versatile |
| 991 | (and unfortunately a bit complex). |
1001 | (and unfortunately a bit complex). |
| 992 | .PP |
1002 | .PP |
| 993 | Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time) |
1003 | Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time) |
| 994 | but on wallclock time (absolute time). You can tell a periodic watcher |
1004 | but on wallclock time (absolute time). You can tell a periodic watcher |
| 995 | to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a |
1005 | to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a |
| 996 | periodic watcher to trigger in 10 seconds (by specifiying e.g. c<ev_now () |
1006 | periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now () |
| 997 | + 10.>) and then reset your system clock to the last year, then it will |
1007 | + 10.\*(C'\fR) and then reset your system clock to the last year, then it will |
| 998 | take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger |
1008 | take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger |
| 999 | roughly 10 seconds later and of course not if you reset your system time |
1009 | roughly 10 seconds later and of course not if you reset your system time |
| 1000 | again). |
1010 | again). |
| 1001 | .PP |
1011 | .PP |
| 1002 | They can also be used to implement vastly more complex timers, such as |
1012 | They can also be used to implement vastly more complex timers, such as |
| … | |
… | |
| 1128 | \& struct ev_periodic hourly_tick; |
1138 | \& struct ev_periodic hourly_tick; |
| 1129 | \& ev_periodic_init (&hourly_tick, clock_cb, |
1139 | \& ev_periodic_init (&hourly_tick, clock_cb, |
| 1130 | \& fmod (ev_now (loop), 3600.), 3600., 0); |
1140 | \& fmod (ev_now (loop), 3600.), 3600., 0); |
| 1131 | \& ev_periodic_start (loop, &hourly_tick); |
1141 | \& ev_periodic_start (loop, &hourly_tick); |
| 1132 | .Ve |
1142 | .Ve |
| 1133 | .ie n .Sh """ev_signal"" \- signal me when a signal gets signalled" |
1143 | .ie n .Sh """ev_signal"" \- signal me when a signal gets signalled!" |
| 1134 | .el .Sh "\f(CWev_signal\fP \- signal me when a signal gets signalled" |
1144 | .el .Sh "\f(CWev_signal\fP \- signal me when a signal gets signalled!" |
| 1135 | .IX Subsection "ev_signal - signal me when a signal gets signalled" |
1145 | .IX Subsection "ev_signal - signal me when a signal gets signalled!" |
| 1136 | Signal watchers will trigger an event when the process receives a specific |
1146 | Signal watchers will trigger an event when the process receives a specific |
| 1137 | signal one or more times. Even though signals are very asynchronous, libev |
1147 | signal one or more times. Even though signals are very asynchronous, libev |
| 1138 | will try it's best to deliver signals synchronously, i.e. as part of the |
1148 | will try it's best to deliver signals synchronously, i.e. as part of the |
| 1139 | normal event processing, like any other event. |
1149 | normal event processing, like any other event. |
| 1140 | .PP |
1150 | .PP |
| … | |
… | |
| 1150 | .IP "ev_signal_set (ev_signal *, int signum)" 4 |
1160 | .IP "ev_signal_set (ev_signal *, int signum)" 4 |
| 1151 | .IX Item "ev_signal_set (ev_signal *, int signum)" |
1161 | .IX Item "ev_signal_set (ev_signal *, int signum)" |
| 1152 | .PD |
1162 | .PD |
| 1153 | Configures the watcher to trigger on the given signal number (usually one |
1163 | Configures the watcher to trigger on the given signal number (usually one |
| 1154 | of the \f(CW\*(C`SIGxxx\*(C'\fR constants). |
1164 | of the \f(CW\*(C`SIGxxx\*(C'\fR constants). |
| 1155 | .ie n .Sh """ev_child"" \- wait for pid status changes" |
1165 | .ie n .Sh """ev_child"" \- watch out for process status changes" |
| 1156 | .el .Sh "\f(CWev_child\fP \- wait for pid status changes" |
1166 | .el .Sh "\f(CWev_child\fP \- watch out for process status changes" |
| 1157 | .IX Subsection "ev_child - wait for pid status changes" |
1167 | .IX Subsection "ev_child - watch out for process status changes" |
| 1158 | Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to |
1168 | Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to |
| 1159 | some child status changes (most typically when a child of yours dies). |
1169 | some child status changes (most typically when a child of yours dies). |
| 1160 | .IP "ev_child_init (ev_child *, callback, int pid)" 4 |
1170 | .IP "ev_child_init (ev_child *, callback, int pid)" 4 |
| 1161 | .IX Item "ev_child_init (ev_child *, callback, int pid)" |
1171 | .IX Item "ev_child_init (ev_child *, callback, int pid)" |
| 1162 | .PD 0 |
1172 | .PD 0 |
| … | |
… | |
| 1183 | .Vb 3 |
1193 | .Vb 3 |
| 1184 | \& struct ev_signal signal_watcher; |
1194 | \& struct ev_signal signal_watcher; |
| 1185 | \& ev_signal_init (&signal_watcher, sigint_cb, SIGINT); |
1195 | \& ev_signal_init (&signal_watcher, sigint_cb, SIGINT); |
| 1186 | \& ev_signal_start (loop, &sigint_cb); |
1196 | \& ev_signal_start (loop, &sigint_cb); |
| 1187 | .Ve |
1197 | .Ve |
| 1188 | .ie n .Sh """ev_idle"" \- when you've got nothing better to do" |
1198 | .ie n .Sh """ev_idle"" \- when you've got nothing better to do..." |
| 1189 | .el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do" |
1199 | .el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." |
| 1190 | .IX Subsection "ev_idle - when you've got nothing better to do" |
1200 | .IX Subsection "ev_idle - when you've got nothing better to do..." |
| 1191 | Idle watchers trigger events when there are no other events are pending |
1201 | Idle watchers trigger events when there are no other events are pending |
| 1192 | (prepare, check and other idle watchers do not count). That is, as long |
1202 | (prepare, check and other idle watchers do not count). That is, as long |
| 1193 | as your process is busy handling sockets or timeouts (or even signals, |
1203 | as your process is busy handling sockets or timeouts (or even signals, |
| 1194 | imagine) it will not be triggered. But when your process is idle all idle |
1204 | imagine) it will not be triggered. But when your process is idle all idle |
| 1195 | watchers are being called again and again, once per event loop iteration \- |
1205 | watchers are being called again and again, once per event loop iteration \- |
| … | |
… | |
| 1225 | .Vb 3 |
1235 | .Vb 3 |
| 1226 | \& struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); |
1236 | \& struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); |
| 1227 | \& ev_idle_init (idle_watcher, idle_cb); |
1237 | \& ev_idle_init (idle_watcher, idle_cb); |
| 1228 | \& ev_idle_start (loop, idle_cb); |
1238 | \& ev_idle_start (loop, idle_cb); |
| 1229 | .Ve |
1239 | .Ve |
| 1230 | .ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop" |
1240 | .ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop!" |
| 1231 | .el .Sh "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop" |
1241 | .el .Sh "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!" |
| 1232 | .IX Subsection "ev_prepare and ev_check - customise your event loop" |
1242 | .IX Subsection "ev_prepare and ev_check - customise your event loop!" |
| 1233 | Prepare and check watchers are usually (but not always) used in tandem: |
1243 | Prepare and check watchers are usually (but not always) used in tandem: |
| 1234 | prepare watchers get invoked before the process blocks and check watchers |
1244 | prepare watchers get invoked before the process blocks and check watchers |
| 1235 | afterwards. |
1245 | afterwards. |
| 1236 | .PP |
1246 | .PP |
|
|
1247 | You \fImust not\fR call \f(CW\*(C`ev_loop\*(C'\fR or similar functions that enter |
|
|
1248 | the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR |
|
|
1249 | watchers. Other loops than the current one are fine, however. The |
|
|
1250 | rationale behind this is that you do not need to check for recursion in |
|
|
1251 | those watchers, i.e. the sequence will always be \f(CW\*(C`ev_prepare\*(C'\fR, blocking, |
|
|
1252 | \&\f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each kind they will always be |
|
|
1253 | called in pairs bracketing the blocking call. |
|
|
1254 | .PP |
| 1237 | Their main purpose is to integrate other event mechanisms into libev and |
1255 | Their main purpose is to integrate other event mechanisms into libev and |
| 1238 | their use is somewhat advanced. This could be used, for example, to track |
1256 | their use is somewhat advanced. This could be used, for example, to track |
| 1239 | variable changes, implement your own watchers, integrate net-snmp or a |
1257 | variable changes, implement your own watchers, integrate net-snmp or a |
| 1240 | coroutine library and lots more. |
1258 | coroutine library and lots more. They are also occasionally useful if |
|
|
1259 | you cache some data and want to flush it before blocking (for example, |
|
|
1260 | in X programs you might want to do an \f(CW\*(C`XFlush ()\*(C'\fR in an \f(CW\*(C`ev_prepare\*(C'\fR |
|
|
1261 | watcher). |
| 1241 | .PP |
1262 | .PP |
| 1242 | This is done by examining in each prepare call which file descriptors need |
1263 | This is done by examining in each prepare call which file descriptors need |
| 1243 | to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers for |
1264 | to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers for |
| 1244 | them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many libraries |
1265 | them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many libraries |
| 1245 | provide just this functionality). Then, in the check watcher you check for |
1266 | provide just this functionality). Then, in the check watcher you check for |
| … | |
… | |
| 1264 | .PD |
1285 | .PD |
| 1265 | Initialises and configures the prepare or check watcher \- they have no |
1286 | Initialises and configures the prepare or check watcher \- they have no |
| 1266 | parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR |
1287 | parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR |
| 1267 | macros, but using them is utterly, utterly and completely pointless. |
1288 | macros, but using them is utterly, utterly and completely pointless. |
| 1268 | .PP |
1289 | .PP |
| 1269 | Example: *TODO*. |
1290 | Example: To include a library such as adns, you would add \s-1IO\s0 watchers |
|
|
1291 | and a timeout watcher in a prepare handler, as required by libadns, and |
|
|
1292 | in a check watcher, destroy them and call into libadns. What follows is |
|
|
1293 | pseudo-code only of course: |
|
|
1294 | .PP |
|
|
1295 | .Vb 2 |
|
|
1296 | \& static ev_io iow [nfd]; |
|
|
1297 | \& static ev_timer tw; |
|
|
1298 | .Ve |
|
|
1299 | .PP |
|
|
1300 | .Vb 8 |
|
|
1301 | \& static void |
|
|
1302 | \& io_cb (ev_loop *loop, ev_io *w, int revents) |
|
|
1303 | \& { |
|
|
1304 | \& // set the relevant poll flags |
|
|
1305 | \& struct pollfd *fd = (struct pollfd *)w->data; |
|
|
1306 | \& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
|
|
1307 | \& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
|
|
1308 | \& } |
|
|
1309 | .Ve |
|
|
1310 | .PP |
|
|
1311 | .Vb 7 |
|
|
1312 | \& // create io watchers for each fd and a timer before blocking |
|
|
1313 | \& static void |
|
|
1314 | \& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
|
|
1315 | \& { |
|
|
1316 | \& int timeout = 3600000;truct pollfd fds [nfd]; |
|
|
1317 | \& // actual code will need to loop here and realloc etc. |
|
|
1318 | \& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
|
|
1319 | .Ve |
|
|
1320 | .PP |
|
|
1321 | .Vb 3 |
|
|
1322 | \& /* the callback is illegal, but won't be called as we stop during check */ |
|
|
1323 | \& ev_timer_init (&tw, 0, timeout * 1e-3); |
|
|
1324 | \& ev_timer_start (loop, &tw); |
|
|
1325 | .Ve |
|
|
1326 | .PP |
|
|
1327 | .Vb 6 |
|
|
1328 | \& // create on ev_io per pollfd |
|
|
1329 | \& for (int i = 0; i < nfd; ++i) |
|
|
1330 | \& { |
|
|
1331 | \& ev_io_init (iow + i, io_cb, fds [i].fd, |
|
|
1332 | \& ((fds [i].events & POLLIN ? EV_READ : 0) |
|
|
1333 | \& | (fds [i].events & POLLOUT ? EV_WRITE : 0))); |
|
|
1334 | .Ve |
|
|
1335 | .PP |
|
|
1336 | .Vb 5 |
|
|
1337 | \& fds [i].revents = 0; |
|
|
1338 | \& iow [i].data = fds + i; |
|
|
1339 | \& ev_io_start (loop, iow + i); |
|
|
1340 | \& } |
|
|
1341 | \& } |
|
|
1342 | .Ve |
|
|
1343 | .PP |
|
|
1344 | .Vb 5 |
|
|
1345 | \& // stop all watchers after blocking |
|
|
1346 | \& static void |
|
|
1347 | \& adns_check_cb (ev_loop *loop, ev_check *w, int revents) |
|
|
1348 | \& { |
|
|
1349 | \& ev_timer_stop (loop, &tw); |
|
|
1350 | .Ve |
|
|
1351 | .PP |
|
|
1352 | .Vb 2 |
|
|
1353 | \& for (int i = 0; i < nfd; ++i) |
|
|
1354 | \& ev_io_stop (loop, iow + i); |
|
|
1355 | .Ve |
|
|
1356 | .PP |
|
|
1357 | .Vb 2 |
|
|
1358 | \& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); |
|
|
1359 | \& } |
|
|
1360 | .Ve |
| 1270 | .ie n .Sh """ev_embed"" \- when one backend isn't enough" |
1361 | .ie n .Sh """ev_embed"" \- when one backend isn't enough..." |
| 1271 | .el .Sh "\f(CWev_embed\fP \- when one backend isn't enough" |
1362 | .el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." |
| 1272 | .IX Subsection "ev_embed - when one backend isn't enough" |
1363 | .IX Subsection "ev_embed - when one backend isn't enough..." |
| 1273 | This is a rather advanced watcher type that lets you embed one event loop |
1364 | This is a rather advanced watcher type that lets you embed one event loop |
| 1274 | into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded |
1365 | into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded |
| 1275 | loop, other types of watchers might be handled in a delayed or incorrect |
1366 | loop, other types of watchers might be handled in a delayed or incorrect |
| 1276 | fashion and must not be used). |
1367 | fashion and must not be used). |
| 1277 | .PP |
1368 | .PP |
| … | |
… | |
| 1428 | .IP "* The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need to use the libev header file and library." 4 |
1519 | .IP "* The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need to use the libev header file and library." 4 |
| 1429 | .IX Item "The libev emulation is not ABI compatible to libevent, you need to use the libev header file and library." |
1520 | .IX Item "The libev emulation is not ABI compatible to libevent, you need to use the libev header file and library." |
| 1430 | .PD |
1521 | .PD |
| 1431 | .SH "\*(C+ SUPPORT" |
1522 | .SH "\*(C+ SUPPORT" |
| 1432 | .IX Header " SUPPORT" |
1523 | .IX Header " SUPPORT" |
| 1433 | \&\s-1TBD\s0. |
1524 | Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow |
|
|
1525 | you to use some convinience methods to start/stop watchers and also change |
|
|
1526 | the callback model to a model using method callbacks on objects. |
|
|
1527 | .PP |
|
|
1528 | To use it, |
|
|
1529 | .PP |
|
|
1530 | .Vb 1 |
|
|
1531 | \& #include <ev++.h> |
|
|
1532 | .Ve |
|
|
1533 | .PP |
|
|
1534 | (it is not installed by default). This automatically includes \fIev.h\fR |
|
|
1535 | and puts all of its definitions (many of them macros) into the global |
|
|
1536 | namespace. All \*(C+ specific things are put into the \f(CW\*(C`ev\*(C'\fR namespace. |
|
|
1537 | .PP |
|
|
1538 | It should support all the same embedding options as \fIev.h\fR, most notably |
|
|
1539 | \&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. |
|
|
1540 | .PP |
|
|
1541 | Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: |
|
|
1542 | .ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4 |
|
|
1543 | .el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 |
|
|
1544 | .IX Item "ev::READ, ev::WRITE etc." |
|
|
1545 | These are just enum values with the same values as the \f(CW\*(C`EV_READ\*(C'\fR etc. |
|
|
1546 | macros from \fIev.h\fR. |
|
|
1547 | .ie n .IP """ev::tstamp""\fR, \f(CW""ev::now""" 4 |
|
|
1548 | .el .IP "\f(CWev::tstamp\fR, \f(CWev::now\fR" 4 |
|
|
1549 | .IX Item "ev::tstamp, ev::now" |
|
|
1550 | Aliases to the same types/functions as with the \f(CW\*(C`ev_\*(C'\fR prefix. |
|
|
1551 | .ie n .IP """ev::io""\fR, \f(CW""ev::timer""\fR, \f(CW""ev::periodic""\fR, \f(CW""ev::idle""\fR, \f(CW""ev::sig"" etc." 4 |
|
|
1552 | .el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4 |
|
|
1553 | .IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc." |
|
|
1554 | For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of |
|
|
1555 | the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR |
|
|
1556 | which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro |
|
|
1557 | defines by many implementations. |
|
|
1558 | .Sp |
|
|
1559 | All of those classes have these methods: |
|
|
1560 | .RS 4 |
|
|
1561 | .IP "ev::TYPE::TYPE (object *, object::method *)" 4 |
|
|
1562 | .IX Item "ev::TYPE::TYPE (object *, object::method *)" |
|
|
1563 | .PD 0 |
|
|
1564 | .IP "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" 4 |
|
|
1565 | .IX Item "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" |
|
|
1566 | .IP "ev::TYPE::~TYPE" 4 |
|
|
1567 | .IX Item "ev::TYPE::~TYPE" |
|
|
1568 | .PD |
|
|
1569 | The constructor takes a pointer to an object and a method pointer to |
|
|
1570 | the event handler callback to call in this class. The constructor calls |
|
|
1571 | \&\f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the \f(CW\*(C`set\*(C'\fR method |
|
|
1572 | before starting it. If you do not specify a loop then the constructor |
|
|
1573 | automatically associates the default loop with this watcher. |
|
|
1574 | .Sp |
|
|
1575 | The destructor automatically stops the watcher if it is active. |
|
|
1576 | .IP "w\->set (struct ev_loop *)" 4 |
|
|
1577 | .IX Item "w->set (struct ev_loop *)" |
|
|
1578 | Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only |
|
|
1579 | do this when the watcher is inactive (and not pending either). |
|
|
1580 | .IP "w\->set ([args])" 4 |
|
|
1581 | .IX Item "w->set ([args])" |
|
|
1582 | Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be |
|
|
1583 | called at least once. Unlike the C counterpart, an active watcher gets |
|
|
1584 | automatically stopped and restarted. |
|
|
1585 | .IP "w\->start ()" 4 |
|
|
1586 | .IX Item "w->start ()" |
|
|
1587 | Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument as the |
|
|
1588 | constructor already takes the loop. |
|
|
1589 | .IP "w\->stop ()" 4 |
|
|
1590 | .IX Item "w->stop ()" |
|
|
1591 | Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. |
|
|
1592 | .ie n .IP "w\->again () ""ev::timer""\fR, \f(CW""ev::periodic"" only" 4 |
|
|
1593 | .el .IP "w\->again () \f(CWev::timer\fR, \f(CWev::periodic\fR only" 4 |
|
|
1594 | .IX Item "w->again () ev::timer, ev::periodic only" |
|
|
1595 | For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding |
|
|
1596 | \&\f(CW\*(C`ev_TYPE_again\*(C'\fR function. |
|
|
1597 | .ie n .IP "w\->sweep () ""ev::embed"" only" 4 |
|
|
1598 | .el .IP "w\->sweep () \f(CWev::embed\fR only" 4 |
|
|
1599 | .IX Item "w->sweep () ev::embed only" |
|
|
1600 | Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR. |
|
|
1601 | .RE |
|
|
1602 | .RS 4 |
|
|
1603 | .RE |
|
|
1604 | .PP |
|
|
1605 | Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in |
|
|
1606 | the constructor. |
|
|
1607 | .PP |
|
|
1608 | .Vb 4 |
|
|
1609 | \& class myclass |
|
|
1610 | \& { |
|
|
1611 | \& ev_io io; void io_cb (ev::io &w, int revents); |
|
|
1612 | \& ev_idle idle void idle_cb (ev::idle &w, int revents); |
|
|
1613 | .Ve |
|
|
1614 | .PP |
|
|
1615 | .Vb 2 |
|
|
1616 | \& myclass (); |
|
|
1617 | \& } |
|
|
1618 | .Ve |
|
|
1619 | .PP |
|
|
1620 | .Vb 6 |
|
|
1621 | \& myclass::myclass (int fd) |
|
|
1622 | \& : io (this, &myclass::io_cb), |
|
|
1623 | \& idle (this, &myclass::idle_cb) |
|
|
1624 | \& { |
|
|
1625 | \& io.start (fd, ev::READ); |
|
|
1626 | \& } |
|
|
1627 | .Ve |
|
|
1628 | .SH "EMBEDDING" |
|
|
1629 | .IX Header "EMBEDDING" |
|
|
1630 | Libev can (and often is) directly embedded into host |
|
|
1631 | applications. Examples of applications that embed it include the Deliantra |
|
|
1632 | Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe) |
|
|
1633 | and rxvt\-unicode. |
|
|
1634 | .PP |
|
|
1635 | The goal is to enable you to just copy the neecssary files into your |
|
|
1636 | source directory without having to change even a single line in them, so |
|
|
1637 | you can easily upgrade by simply copying (or having a checked-out copy of |
|
|
1638 | libev somewhere in your source tree). |
|
|
1639 | .Sh "\s-1FILESETS\s0" |
|
|
1640 | .IX Subsection "FILESETS" |
|
|
1641 | Depending on what features you need you need to include one or more sets of files |
|
|
1642 | in your app. |
|
|
1643 | .PP |
|
|
1644 | \fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR |
|
|
1645 | .IX Subsection "CORE EVENT LOOP" |
|
|
1646 | .PP |
|
|
1647 | To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual |
|
|
1648 | configuration (no autoconf): |
|
|
1649 | .PP |
|
|
1650 | .Vb 2 |
|
|
1651 | \& #define EV_STANDALONE 1 |
|
|
1652 | \& #include "ev.c" |
|
|
1653 | .Ve |
|
|
1654 | .PP |
|
|
1655 | This will automatically include \fIev.h\fR, too, and should be done in a |
|
|
1656 | single C source file only to provide the function implementations. To use |
|
|
1657 | it, do the same for \fIev.h\fR in all files wishing to use this \s-1API\s0 (best |
|
|
1658 | done by writing a wrapper around \fIev.h\fR that you can include instead and |
|
|
1659 | where you can put other configuration options): |
|
|
1660 | .PP |
|
|
1661 | .Vb 2 |
|
|
1662 | \& #define EV_STANDALONE 1 |
|
|
1663 | \& #include "ev.h" |
|
|
1664 | .Ve |
|
|
1665 | .PP |
|
|
1666 | Both header files and implementation files can be compiled with a \*(C+ |
|
|
1667 | compiler (at least, thats a stated goal, and breakage will be treated |
|
|
1668 | as a bug). |
|
|
1669 | .PP |
|
|
1670 | You need the following files in your source tree, or in a directory |
|
|
1671 | in your include path (e.g. in libev/ when using \-Ilibev): |
|
|
1672 | .PP |
|
|
1673 | .Vb 4 |
|
|
1674 | \& ev.h |
|
|
1675 | \& ev.c |
|
|
1676 | \& ev_vars.h |
|
|
1677 | \& ev_wrap.h |
|
|
1678 | .Ve |
|
|
1679 | .PP |
|
|
1680 | .Vb 1 |
|
|
1681 | \& ev_win32.c required on win32 platforms only |
|
|
1682 | .Ve |
|
|
1683 | .PP |
|
|
1684 | .Vb 5 |
|
|
1685 | \& ev_select.c only when select backend is enabled (which is by default) |
|
|
1686 | \& ev_poll.c only when poll backend is enabled (disabled by default) |
|
|
1687 | \& ev_epoll.c only when the epoll backend is enabled (disabled by default) |
|
|
1688 | \& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
|
|
1689 | \& ev_port.c only when the solaris port backend is enabled (disabled by default) |
|
|
1690 | .Ve |
|
|
1691 | .PP |
|
|
1692 | \&\fIev.c\fR includes the backend files directly when enabled, so you only need |
|
|
1693 | to compile this single file. |
|
|
1694 | .PP |
|
|
1695 | \fI\s-1LIBEVENT\s0 \s-1COMPATIBILITY\s0 \s-1API\s0\fR |
|
|
1696 | .IX Subsection "LIBEVENT COMPATIBILITY API" |
|
|
1697 | .PP |
|
|
1698 | To include the libevent compatibility \s-1API\s0, also include: |
|
|
1699 | .PP |
|
|
1700 | .Vb 1 |
|
|
1701 | \& #include "event.c" |
|
|
1702 | .Ve |
|
|
1703 | .PP |
|
|
1704 | in the file including \fIev.c\fR, and: |
|
|
1705 | .PP |
|
|
1706 | .Vb 1 |
|
|
1707 | \& #include "event.h" |
|
|
1708 | .Ve |
|
|
1709 | .PP |
|
|
1710 | in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR. |
|
|
1711 | .PP |
|
|
1712 | You need the following additional files for this: |
|
|
1713 | .PP |
|
|
1714 | .Vb 2 |
|
|
1715 | \& event.h |
|
|
1716 | \& event.c |
|
|
1717 | .Ve |
|
|
1718 | .PP |
|
|
1719 | \fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR |
|
|
1720 | .IX Subsection "AUTOCONF SUPPORT" |
|
|
1721 | .PP |
|
|
1722 | Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your config in |
|
|
1723 | whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your |
|
|
1724 | \&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then |
|
|
1725 | include \fIconfig.h\fR and configure itself accordingly. |
|
|
1726 | .PP |
|
|
1727 | For this of course you need the m4 file: |
|
|
1728 | .PP |
|
|
1729 | .Vb 1 |
|
|
1730 | \& libev.m4 |
|
|
1731 | .Ve |
|
|
1732 | .Sh "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" |
|
|
1733 | .IX Subsection "PREPROCESSOR SYMBOLS/MACROS" |
|
|
1734 | Libev can be configured via a variety of preprocessor symbols you have to define |
|
|
1735 | before including any of its files. The default is not to build for multiplicity |
|
|
1736 | and only include the select backend. |
|
|
1737 | .IP "\s-1EV_STANDALONE\s0" 4 |
|
|
1738 | .IX Item "EV_STANDALONE" |
|
|
1739 | Must always be \f(CW1\fR if you do not use autoconf configuration, which |
|
|
1740 | keeps libev from including \fIconfig.h\fR, and it also defines dummy |
|
|
1741 | implementations for some libevent functions (such as logging, which is not |
|
|
1742 | supported). It will also not define any of the structs usually found in |
|
|
1743 | \&\fIevent.h\fR that are not directly supported by the libev core alone. |
|
|
1744 | .IP "\s-1EV_USE_MONOTONIC\s0" 4 |
|
|
1745 | .IX Item "EV_USE_MONOTONIC" |
|
|
1746 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
|
|
1747 | monotonic clock option at both compiletime and runtime. Otherwise no use |
|
|
1748 | of the monotonic clock option will be attempted. If you enable this, you |
|
|
1749 | usually have to link against librt or something similar. Enabling it when |
|
|
1750 | the functionality isn't available is safe, though, althoguh you have |
|
|
1751 | to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR |
|
|
1752 | function is hiding in (often \fI\-lrt\fR). |
|
|
1753 | .IP "\s-1EV_USE_REALTIME\s0" 4 |
|
|
1754 | .IX Item "EV_USE_REALTIME" |
|
|
1755 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
|
|
1756 | realtime clock option at compiletime (and assume its availability at |
|
|
1757 | runtime if successful). Otherwise no use of the realtime clock option will |
|
|
1758 | be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR by \f(CW\*(C`clock_get |
|
|
1759 | (CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect correctness. See tzhe note about libraries |
|
|
1760 | in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. |
|
|
1761 | .IP "\s-1EV_USE_SELECT\s0" 4 |
|
|
1762 | .IX Item "EV_USE_SELECT" |
|
|
1763 | If undefined or defined to be \f(CW1\fR, libev will compile in support for the |
|
|
1764 | \&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at autodetection will be done: if no |
|
|
1765 | other method takes over, select will be it. Otherwise the select backend |
|
|
1766 | will not be compiled in. |
|
|
1767 | .IP "\s-1EV_SELECT_USE_FD_SET\s0" 4 |
|
|
1768 | .IX Item "EV_SELECT_USE_FD_SET" |
|
|
1769 | If defined to \f(CW1\fR, then the select backend will use the system \f(CW\*(C`fd_set\*(C'\fR |
|
|
1770 | structure. This is useful if libev doesn't compile due to a missing |
|
|
1771 | \&\f(CW\*(C`NFDBITS\*(C'\fR or \f(CW\*(C`fd_mask\*(C'\fR definition or it misguesses the bitset layout on |
|
|
1772 | exotic systems. This usually limits the range of file descriptors to some |
|
|
1773 | low limit such as 1024 or might have other limitations (winsocket only |
|
|
1774 | allows 64 sockets). The \f(CW\*(C`FD_SETSIZE\*(C'\fR macro, set before compilation, might |
|
|
1775 | influence the size of the \f(CW\*(C`fd_set\*(C'\fR used. |
|
|
1776 | .IP "\s-1EV_SELECT_IS_WINSOCKET\s0" 4 |
|
|
1777 | .IX Item "EV_SELECT_IS_WINSOCKET" |
|
|
1778 | When defined to \f(CW1\fR, the select backend will assume that |
|
|
1779 | select/socket/connect etc. don't understand file descriptors but |
|
|
1780 | wants osf handles on win32 (this is the case when the select to |
|
|
1781 | be used is the winsock select). This means that it will call |
|
|
1782 | \&\f(CW\*(C`_get_osfhandle\*(C'\fR on the fd to convert it to an \s-1OS\s0 handle. Otherwise, |
|
|
1783 | it is assumed that all these functions actually work on fds, even |
|
|
1784 | on win32. Should not be defined on non\-win32 platforms. |
|
|
1785 | .IP "\s-1EV_USE_POLL\s0" 4 |
|
|
1786 | .IX Item "EV_USE_POLL" |
|
|
1787 | If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2) |
|
|
1788 | backend. Otherwise it will be enabled on non\-win32 platforms. It |
|
|
1789 | takes precedence over select. |
|
|
1790 | .IP "\s-1EV_USE_EPOLL\s0" 4 |
|
|
1791 | .IX Item "EV_USE_EPOLL" |
|
|
1792 | If defined to be \f(CW1\fR, libev will compile in support for the Linux |
|
|
1793 | \&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime, |
|
|
1794 | otherwise another method will be used as fallback. This is the |
|
|
1795 | preferred backend for GNU/Linux systems. |
|
|
1796 | .IP "\s-1EV_USE_KQUEUE\s0" 4 |
|
|
1797 | .IX Item "EV_USE_KQUEUE" |
|
|
1798 | If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style |
|
|
1799 | \&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime, |
|
|
1800 | otherwise another method will be used as fallback. This is the preferred |
|
|
1801 | backend for \s-1BSD\s0 and BSD-like systems, although on most BSDs kqueue only |
|
|
1802 | supports some types of fds correctly (the only platform we found that |
|
|
1803 | supports ptys for example was NetBSD), so kqueue might be compiled in, but |
|
|
1804 | not be used unless explicitly requested. The best way to use it is to find |
|
|
1805 | out whether kqueue supports your type of fd properly and use an embedded |
|
|
1806 | kqueue loop. |
|
|
1807 | .IP "\s-1EV_USE_PORT\s0" 4 |
|
|
1808 | .IX Item "EV_USE_PORT" |
|
|
1809 | If defined to be \f(CW1\fR, libev will compile in support for the Solaris |
|
|
1810 | 10 port style backend. Its availability will be detected at runtime, |
|
|
1811 | otherwise another method will be used as fallback. This is the preferred |
|
|
1812 | backend for Solaris 10 systems. |
|
|
1813 | .IP "\s-1EV_USE_DEVPOLL\s0" 4 |
|
|
1814 | .IX Item "EV_USE_DEVPOLL" |
|
|
1815 | reserved for future expansion, works like the \s-1USE\s0 symbols above. |
|
|
1816 | .IP "\s-1EV_H\s0" 4 |
|
|
1817 | .IX Item "EV_H" |
|
|
1818 | The name of the \fIev.h\fR header file used to include it. The default if |
|
|
1819 | undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This |
|
|
1820 | can be used to virtually rename the \fIev.h\fR header file in case of conflicts. |
|
|
1821 | .IP "\s-1EV_CONFIG_H\s0" 4 |
|
|
1822 | .IX Item "EV_CONFIG_H" |
|
|
1823 | If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override |
|
|
1824 | \&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to |
|
|
1825 | \&\f(CW\*(C`EV_H\*(C'\fR, above. |
|
|
1826 | .IP "\s-1EV_EVENT_H\s0" 4 |
|
|
1827 | .IX Item "EV_EVENT_H" |
|
|
1828 | Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea |
|
|
1829 | of how the \fIevent.h\fR header can be found. |
|
|
1830 | .IP "\s-1EV_PROTOTYPES\s0" 4 |
|
|
1831 | .IX Item "EV_PROTOTYPES" |
|
|
1832 | If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function |
|
|
1833 | prototypes, but still define all the structs and other symbols. This is |
|
|
1834 | occasionally useful if you want to provide your own wrapper functions |
|
|
1835 | around libev functions. |
|
|
1836 | .IP "\s-1EV_MULTIPLICITY\s0" 4 |
|
|
1837 | .IX Item "EV_MULTIPLICITY" |
|
|
1838 | If undefined or defined to \f(CW1\fR, then all event-loop-specific functions |
|
|
1839 | will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create |
|
|
1840 | additional independent event loops. Otherwise there will be no support |
|
|
1841 | for multiple event loops and there is no first event loop pointer |
|
|
1842 | argument. Instead, all functions act on the single default loop. |
|
|
1843 | .IP "\s-1EV_PERIODICS\s0" 4 |
|
|
1844 | .IX Item "EV_PERIODICS" |
|
|
1845 | If undefined or defined to be \f(CW1\fR, then periodic timers are supported, |
|
|
1846 | otherwise not. This saves a few kb of code. |
|
|
1847 | .IP "\s-1EV_COMMON\s0" 4 |
|
|
1848 | .IX Item "EV_COMMON" |
|
|
1849 | By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining |
|
|
1850 | this macro to a something else you can include more and other types of |
|
|
1851 | members. You have to define it each time you include one of the files, |
|
|
1852 | though, and it must be identical each time. |
|
|
1853 | .Sp |
|
|
1854 | For example, the perl \s-1EV\s0 module uses something like this: |
|
|
1855 | .Sp |
|
|
1856 | .Vb 3 |
|
|
1857 | \& #define EV_COMMON \e |
|
|
1858 | \& SV *self; /* contains this struct */ \e |
|
|
1859 | \& SV *cb_sv, *fh /* note no trailing ";" */ |
|
|
1860 | .Ve |
|
|
1861 | .IP "\s-1EV_CB_DECLARE\s0 (type)" 4 |
|
|
1862 | .IX Item "EV_CB_DECLARE (type)" |
|
|
1863 | .PD 0 |
|
|
1864 | .IP "\s-1EV_CB_INVOKE\s0 (watcher, revents)" 4 |
|
|
1865 | .IX Item "EV_CB_INVOKE (watcher, revents)" |
|
|
1866 | .IP "ev_set_cb (ev, cb)" 4 |
|
|
1867 | .IX Item "ev_set_cb (ev, cb)" |
|
|
1868 | .PD |
|
|
1869 | Can be used to change the callback member declaration in each watcher, |
|
|
1870 | and the way callbacks are invoked and set. Must expand to a struct member |
|
|
1871 | definition and a statement, respectively. See the \fIev.v\fR header file for |
|
|
1872 | their default definitions. One possible use for overriding these is to |
|
|
1873 | avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use |
|
|
1874 | method calls instead of plain function calls in \*(C+. |
|
|
1875 | .Sh "\s-1EXAMPLES\s0" |
|
|
1876 | .IX Subsection "EXAMPLES" |
|
|
1877 | For a real-world example of a program the includes libev |
|
|
1878 | verbatim, you can have a look at the \s-1EV\s0 perl module |
|
|
1879 | (<http://software.schmorp.de/pkg/EV.html>). It has the libev files in |
|
|
1880 | the \fIlibev/\fR subdirectory and includes them in the \fI\s-1EV/EVAPI\s0.h\fR (public |
|
|
1881 | interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file |
|
|
1882 | will be compiled. It is pretty complex because it provides its own header |
|
|
1883 | file. |
|
|
1884 | .Sp |
|
|
1885 | The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file |
|
|
1886 | that everybody includes and which overrides some autoconf choices: |
|
|
1887 | .Sp |
|
|
1888 | .Vb 4 |
|
|
1889 | \& #define EV_USE_POLL 0 |
|
|
1890 | \& #define EV_MULTIPLICITY 0 |
|
|
1891 | \& #define EV_PERIODICS 0 |
|
|
1892 | \& #define EV_CONFIG_H <config.h> |
|
|
1893 | .Ve |
|
|
1894 | .Sp |
|
|
1895 | .Vb 1 |
|
|
1896 | \& #include "ev++.h" |
|
|
1897 | .Ve |
|
|
1898 | .Sp |
|
|
1899 | And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled: |
|
|
1900 | .Sp |
|
|
1901 | .Vb 2 |
|
|
1902 | \& #include "ev_cpp.h" |
|
|
1903 | \& #include "ev.c" |
|
|
1904 | .Ve |
| 1434 | .SH "AUTHOR" |
1905 | .SH "AUTHOR" |
| 1435 | .IX Header "AUTHOR" |
1906 | .IX Header "AUTHOR" |
| 1436 | Marc Lehmann <libev@schmorp.de>. |
1907 | Marc Lehmann <libev@schmorp.de>. |
