… | |
… | |
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-27" "perl v5.8.8" "User Contributed Perl Documentation" |
132 | .TH "<STANDARD INPUT>" 1 "2007-12-07" "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 |
… | |
… | |
210 | watchers\fR, which are relatively small C structures you initialise with the |
210 | watchers\fR, which are relatively small C structures you initialise with the |
211 | details of the event, and then hand it over to libev by \fIstarting\fR the |
211 | details of the event, and then hand it over to libev by \fIstarting\fR the |
212 | watcher. |
212 | watcher. |
213 | .SH "FEATURES" |
213 | .SH "FEATURES" |
214 | .IX Header "FEATURES" |
214 | .IX Header "FEATURES" |
215 | Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the linux-specific \f(CW\*(C`epoll\*(C'\fR, the |
215 | Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the |
216 | bsd-specific \f(CW\*(C`kqueue\*(C'\fR and the solaris-specific event port mechanisms |
216 | BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms |
217 | for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), relative timers (\f(CW\*(C`ev_timer\*(C'\fR), |
217 | for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface |
|
|
218 | (for \f(CW\*(C`ev_stat\*(C'\fR), relative timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers |
218 | absolute timers with customised rescheduling (\f(CW\*(C`ev_periodic\*(C'\fR), synchronous |
219 | with customised rescheduling (\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals |
219 | signals (\f(CW\*(C`ev_signal\*(C'\fR), process status change events (\f(CW\*(C`ev_child\*(C'\fR), and |
220 | (\f(CW\*(C`ev_signal\*(C'\fR), process status change events (\f(CW\*(C`ev_child\*(C'\fR), and event |
220 | event watchers dealing with the event loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR, |
221 | watchers dealing with the event loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR, |
221 | \&\f(CW\*(C`ev_embed\*(C'\fR, \f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR watchers) as well as |
222 | \&\f(CW\*(C`ev_embed\*(C'\fR, \f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR watchers) as well as |
222 | file watchers (\f(CW\*(C`ev_stat\*(C'\fR) and even limited support for fork events |
223 | file watchers (\f(CW\*(C`ev_stat\*(C'\fR) and even limited support for fork events |
223 | (\f(CW\*(C`ev_fork\*(C'\fR). |
224 | (\f(CW\*(C`ev_fork\*(C'\fR). |
224 | .PP |
225 | .PP |
225 | It also is quite fast (see this |
226 | It also is quite fast (see this |
… | |
… | |
304 | might be supported on the current system, you would need to look at |
305 | might be supported on the current system, you would need to look at |
305 | \&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for |
306 | \&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for |
306 | recommended ones. |
307 | recommended ones. |
307 | .Sp |
308 | .Sp |
308 | See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. |
309 | See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. |
309 | .IP "ev_set_allocator (void *(*cb)(void *ptr, size_t size))" 4 |
310 | .IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4 |
310 | .IX Item "ev_set_allocator (void *(*cb)(void *ptr, size_t size))" |
311 | .IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" |
311 | Sets the allocation function to use (the prototype and semantics are |
312 | Sets the allocation function to use (the prototype is similar \- the |
312 | identical to the realloc C function). It is used to allocate and free |
313 | semantics is identical \- to the realloc C function). It is used to |
313 | memory (no surprises here). If it returns zero when memory needs to be |
314 | allocate and free memory (no surprises here). If it returns zero when |
314 | allocated, the library might abort or take some potentially destructive |
315 | memory needs to be allocated, the library might abort or take some |
315 | action. The default is your system realloc function. |
316 | potentially destructive action. The default is your system realloc |
|
|
317 | function. |
316 | .Sp |
318 | .Sp |
317 | You could override this function in high-availability programs to, say, |
319 | You could override this function in high-availability programs to, say, |
318 | free some memory if it cannot allocate memory, to use a special allocator, |
320 | free some memory if it cannot allocate memory, to use a special allocator, |
319 | or even to sleep a while and retry until some memory is available. |
321 | or even to sleep a while and retry until some memory is available. |
320 | .Sp |
322 | .Sp |
… | |
… | |
409 | or setgid) then libev will \fInot\fR look at the environment variable |
411 | or setgid) then libev will \fInot\fR look at the environment variable |
410 | \&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will |
412 | \&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will |
411 | override the flags completely if it is found in the environment. This is |
413 | override the flags completely if it is found in the environment. This is |
412 | useful to try out specific backends to test their performance, or to work |
414 | useful to try out specific backends to test their performance, or to work |
413 | around bugs. |
415 | around bugs. |
|
|
416 | .ie n .IP """EVFLAG_FORKCHECK""" 4 |
|
|
417 | .el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4 |
|
|
418 | .IX Item "EVFLAG_FORKCHECK" |
|
|
419 | Instead of calling \f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR manually after |
|
|
420 | a fork, you can also make libev check for a fork in each iteration by |
|
|
421 | enabling this flag. |
|
|
422 | .Sp |
|
|
423 | This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, |
|
|
424 | and thus this might slow down your event loop if you do a lot of loop |
|
|
425 | iterations and little real work, but is usually not noticeable (on my |
|
|
426 | Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence |
|
|
427 | without a syscall and thus \fIvery\fR fast, but my Linux system also has |
|
|
428 | \&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). |
|
|
429 | .Sp |
|
|
430 | The big advantage of this flag is that you can forget about fork (and |
|
|
431 | forget about forgetting to tell libev about forking) when you use this |
|
|
432 | flag. |
|
|
433 | .Sp |
|
|
434 | This flag setting cannot be overriden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR |
|
|
435 | environment variable. |
414 | .ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 |
436 | .ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 |
415 | .el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 |
437 | .el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 |
416 | .IX Item "EVBACKEND_SELECT (value 1, portable select backend)" |
438 | .IX Item "EVBACKEND_SELECT (value 1, portable select backend)" |
417 | This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as |
439 | This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as |
418 | libev tries to roll its own fd_set with no limits on the number of fds, |
440 | libev tries to roll its own fd_set with no limits on the number of fds, |
… | |
… | |
559 | .IP "ev_loop_fork (loop)" 4 |
581 | .IP "ev_loop_fork (loop)" 4 |
560 | .IX Item "ev_loop_fork (loop)" |
582 | .IX Item "ev_loop_fork (loop)" |
561 | Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by |
583 | Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by |
562 | \&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop |
584 | \&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop |
563 | after fork, and how you do this is entirely your own problem. |
585 | after fork, and how you do this is entirely your own problem. |
|
|
586 | .IP "unsigned int ev_loop_count (loop)" 4 |
|
|
587 | .IX Item "unsigned int ev_loop_count (loop)" |
|
|
588 | Returns the count of loop iterations for the loop, which is identical to |
|
|
589 | the number of times libev did poll for new events. It starts at \f(CW0\fR and |
|
|
590 | happily wraps around with enough iterations. |
|
|
591 | .Sp |
|
|
592 | This value can sometimes be useful as a generation counter of sorts (it |
|
|
593 | \&\*(L"ticks\*(R" the number of loop iterations), as it roughly corresponds with |
|
|
594 | \&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls. |
564 | .IP "unsigned int ev_backend (loop)" 4 |
595 | .IP "unsigned int ev_backend (loop)" 4 |
565 | .IX Item "unsigned int ev_backend (loop)" |
596 | .IX Item "unsigned int ev_backend (loop)" |
566 | Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in |
597 | Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in |
567 | use. |
598 | use. |
568 | .IP "ev_tstamp ev_now (loop)" 4 |
599 | .IP "ev_tstamp ev_now (loop)" 4 |
… | |
… | |
856 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
887 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
857 | events but its callback has not yet been invoked). As long as a watcher |
888 | events but its callback has not yet been invoked). As long as a watcher |
858 | is pending (but not active) you must not call an init function on it (but |
889 | is pending (but not active) you must not call an init function on it (but |
859 | \&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe) and you must make sure the watcher is available to |
890 | \&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe) and you must make sure the watcher is available to |
860 | libev (e.g. you cnanot \f(CW\*(C`free ()\*(C'\fR it). |
891 | libev (e.g. you cnanot \f(CW\*(C`free ()\*(C'\fR it). |
861 | .IP "callback = ev_cb (ev_TYPE *watcher)" 4 |
892 | .IP "callback ev_cb (ev_TYPE *watcher)" 4 |
862 | .IX Item "callback = ev_cb (ev_TYPE *watcher)" |
893 | .IX Item "callback ev_cb (ev_TYPE *watcher)" |
863 | Returns the callback currently set on the watcher. |
894 | Returns the callback currently set on the watcher. |
864 | .IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 |
895 | .IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 |
865 | .IX Item "ev_cb_set (ev_TYPE *watcher, callback)" |
896 | .IX Item "ev_cb_set (ev_TYPE *watcher, callback)" |
866 | Change the callback. You can change the callback at virtually any time |
897 | Change the callback. You can change the callback at virtually any time |
867 | (modulo threads). |
898 | (modulo threads). |
|
|
899 | .IP "ev_set_priority (ev_TYPE *watcher, priority)" 4 |
|
|
900 | .IX Item "ev_set_priority (ev_TYPE *watcher, priority)" |
|
|
901 | .PD 0 |
|
|
902 | .IP "int ev_priority (ev_TYPE *watcher)" 4 |
|
|
903 | .IX Item "int ev_priority (ev_TYPE *watcher)" |
|
|
904 | .PD |
|
|
905 | Set and query the priority of the watcher. The priority is a small |
|
|
906 | integer between \f(CW\*(C`EV_MAXPRI\*(C'\fR (default: \f(CW2\fR) and \f(CW\*(C`EV_MINPRI\*(C'\fR |
|
|
907 | (default: \f(CW\*(C`\-2\*(C'\fR). Pending watchers with higher priority will be invoked |
|
|
908 | before watchers with lower priority, but priority will not keep watchers |
|
|
909 | from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers). |
|
|
910 | .Sp |
|
|
911 | This means that priorities are \fIonly\fR used for ordering callback |
|
|
912 | invocation after new events have been received. This is useful, for |
|
|
913 | example, to reduce latency after idling, or more often, to bind two |
|
|
914 | watchers on the same event and make sure one is called first. |
|
|
915 | .Sp |
|
|
916 | If you need to suppress invocation when higher priority events are pending |
|
|
917 | you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality. |
|
|
918 | .Sp |
|
|
919 | The default priority used by watchers when no priority has been set is |
|
|
920 | always \f(CW0\fR, which is supposed to not be too high and not be too low :). |
|
|
921 | .Sp |
|
|
922 | Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is |
|
|
923 | fine, as long as you do not mind that the priority value you query might |
|
|
924 | or might not have been adjusted to be within valid range. |
868 | .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" |
925 | .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" |
869 | .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" |
926 | .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" |
870 | Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change |
927 | Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change |
871 | and read at any time, libev will completely ignore it. This can be used |
928 | and read at any time, libev will completely ignore it. This can be used |
872 | to associate arbitrary data with your watcher. If you need more data and |
929 | to associate arbitrary data with your watcher. If you need more data and |
… | |
… | |
893 | \& struct my_io *w = (struct my_io *)w_; |
950 | \& struct my_io *w = (struct my_io *)w_; |
894 | \& ... |
951 | \& ... |
895 | \& } |
952 | \& } |
896 | .Ve |
953 | .Ve |
897 | .PP |
954 | .PP |
898 | More interesting and less C\-conformant ways of catsing your callback type |
955 | More interesting and less C\-conformant ways of casting your callback type |
899 | have been omitted.... |
956 | instead have been omitted. |
|
|
957 | .PP |
|
|
958 | Another common scenario is having some data structure with multiple |
|
|
959 | watchers: |
|
|
960 | .PP |
|
|
961 | .Vb 6 |
|
|
962 | \& struct my_biggy |
|
|
963 | \& { |
|
|
964 | \& int some_data; |
|
|
965 | \& ev_timer t1; |
|
|
966 | \& ev_timer t2; |
|
|
967 | \& } |
|
|
968 | .Ve |
|
|
969 | .PP |
|
|
970 | In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more complicated, |
|
|
971 | you need to use \f(CW\*(C`offsetof\*(C'\fR: |
|
|
972 | .PP |
|
|
973 | .Vb 1 |
|
|
974 | \& #include <stddef.h> |
|
|
975 | .Ve |
|
|
976 | .PP |
|
|
977 | .Vb 6 |
|
|
978 | \& static void |
|
|
979 | \& t1_cb (EV_P_ struct ev_timer *w, int revents) |
|
|
980 | \& { |
|
|
981 | \& struct my_biggy big = (struct my_biggy * |
|
|
982 | \& (((char *)w) - offsetof (struct my_biggy, t1)); |
|
|
983 | \& } |
|
|
984 | .Ve |
|
|
985 | .PP |
|
|
986 | .Vb 6 |
|
|
987 | \& static void |
|
|
988 | \& t2_cb (EV_P_ struct ev_timer *w, int revents) |
|
|
989 | \& { |
|
|
990 | \& struct my_biggy big = (struct my_biggy * |
|
|
991 | \& (((char *)w) - offsetof (struct my_biggy, t2)); |
|
|
992 | \& } |
|
|
993 | .Ve |
900 | .SH "WATCHER TYPES" |
994 | .SH "WATCHER TYPES" |
901 | .IX Header "WATCHER TYPES" |
995 | .IX Header "WATCHER TYPES" |
902 | This section describes each watcher in detail, but will not repeat |
996 | This section describes each watcher in detail, but will not repeat |
903 | information given in the last section. Any initialisation/set macros, |
997 | information given in the last section. Any initialisation/set macros, |
904 | functions and members specific to the watcher type are explained. |
998 | functions and members specific to the watcher type are explained. |
… | |
… | |
1032 | .IP "ev_timer_again (loop)" 4 |
1126 | .IP "ev_timer_again (loop)" 4 |
1033 | .IX Item "ev_timer_again (loop)" |
1127 | .IX Item "ev_timer_again (loop)" |
1034 | This will act as if the timer timed out and restart it again if it is |
1128 | This will act as if the timer timed out and restart it again if it is |
1035 | repeating. The exact semantics are: |
1129 | repeating. The exact semantics are: |
1036 | .Sp |
1130 | .Sp |
|
|
1131 | If the timer is pending, its pending status is cleared. |
|
|
1132 | .Sp |
1037 | If the timer is started but nonrepeating, stop it. |
1133 | If the timer is started but nonrepeating, stop it (as if it timed out). |
1038 | .Sp |
1134 | .Sp |
1039 | If the timer is repeating, either start it if necessary (with the repeat |
1135 | If the timer is repeating, either start it if necessary (with the |
1040 | value), or reset the running timer to the repeat value. |
1136 | \&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value. |
1041 | .Sp |
1137 | .Sp |
1042 | This sounds a bit complicated, but here is a useful and typical |
1138 | This sounds a bit complicated, but here is a useful and typical |
1043 | example: Imagine you have a tcp connection and you want a so-called |
1139 | example: Imagine you have a tcp connection and you want a so-called idle |
1044 | idle timeout, that is, you want to be called when there have been, |
1140 | timeout, that is, you want to be called when there have been, say, 60 |
1045 | say, 60 seconds of inactivity on the socket. The easiest way to do |
1141 | seconds of inactivity on the socket. The easiest way to do this is to |
1046 | this is to configure an \f(CW\*(C`ev_timer\*(C'\fR with \f(CW\*(C`after\*(C'\fR=\f(CW\*(C`repeat\*(C'\fR=\f(CW60\fR and calling |
1142 | configure an \f(CW\*(C`ev_timer\*(C'\fR with a \f(CW\*(C`repeat\*(C'\fR value of \f(CW60\fR and then call |
1047 | \&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If |
1143 | \&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If |
1048 | you go into an idle state where you do not expect data to travel on the |
1144 | you go into an idle state where you do not expect data to travel on the |
1049 | socket, you can stop the timer, and again will automatically restart it if |
1145 | socket, you can \f(CW\*(C`ev_timer_stop\*(C'\fR the timer, and \f(CW\*(C`ev_timer_again\*(C'\fR will |
1050 | need be. |
1146 | automatically restart it if need be. |
1051 | .Sp |
1147 | .Sp |
1052 | You can also ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR altogether |
1148 | That means you can ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR |
1053 | and only ever use the \f(CW\*(C`repeat\*(C'\fR value: |
1149 | altogether and only ever use the \f(CW\*(C`repeat\*(C'\fR value and \f(CW\*(C`ev_timer_again\*(C'\fR: |
1054 | .Sp |
1150 | .Sp |
1055 | .Vb 8 |
1151 | .Vb 8 |
1056 | \& ev_timer_init (timer, callback, 0., 5.); |
1152 | \& ev_timer_init (timer, callback, 0., 5.); |
1057 | \& ev_timer_again (loop, timer); |
1153 | \& ev_timer_again (loop, timer); |
1058 | \& ... |
1154 | \& ... |
… | |
… | |
1061 | \& ... |
1157 | \& ... |
1062 | \& timer->again = 10.; |
1158 | \& timer->again = 10.; |
1063 | \& ev_timer_again (loop, timer); |
1159 | \& ev_timer_again (loop, timer); |
1064 | .Ve |
1160 | .Ve |
1065 | .Sp |
1161 | .Sp |
1066 | This is more efficient then stopping/starting the timer eahc time you want |
1162 | This is more slightly efficient then stopping/starting the timer each time |
1067 | to modify its timeout value. |
1163 | you want to modify its timeout value. |
1068 | .IP "ev_tstamp repeat [read\-write]" 4 |
1164 | .IP "ev_tstamp repeat [read\-write]" 4 |
1069 | .IX Item "ev_tstamp repeat [read-write]" |
1165 | .IX Item "ev_tstamp repeat [read-write]" |
1070 | The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out |
1166 | The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out |
1071 | or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any), |
1167 | or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any), |
1072 | which is also when any modifications are taken into account. |
1168 | which is also when any modifications are taken into account. |
… | |
… | |
1345 | not exist\*(R" is a status change like any other. The condition \*(L"path does |
1441 | not exist\*(R" is a status change like any other. The condition \*(L"path does |
1346 | not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is |
1442 | not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is |
1347 | otherwise always forced to be at least one) and all the other fields of |
1443 | otherwise always forced to be at least one) and all the other fields of |
1348 | the stat buffer having unspecified contents. |
1444 | the stat buffer having unspecified contents. |
1349 | .PP |
1445 | .PP |
|
|
1446 | The path \fIshould\fR be absolute and \fImust not\fR end in a slash. If it is |
|
|
1447 | relative and your working directory changes, the behaviour is undefined. |
|
|
1448 | .PP |
1350 | Since there is no standard to do this, the portable implementation simply |
1449 | Since there is no standard to do this, the portable implementation simply |
1351 | calls \f(CW\*(C`stat (2)\*(C'\fR regulalry on the path to see if it changed somehow. You |
1450 | calls \f(CW\*(C`stat (2)\*(C'\fR regularly on the path to see if it changed somehow. You |
1352 | can specify a recommended polling interval for this case. If you specify |
1451 | can specify a recommended polling interval for this case. If you specify |
1353 | a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable, |
1452 | a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable, |
1354 | unspecified default\fR value will be used (which you can expect to be around |
1453 | unspecified default\fR value will be used (which you can expect to be around |
1355 | five seconds, although this might change dynamically). Libev will also |
1454 | five seconds, although this might change dynamically). Libev will also |
1356 | impose a minimum interval which is currently around \f(CW0.1\fR, but thats |
1455 | impose a minimum interval which is currently around \f(CW0.1\fR, but thats |
… | |
… | |
1358 | .PP |
1457 | .PP |
1359 | This watcher type is not meant for massive numbers of stat watchers, |
1458 | This watcher type is not meant for massive numbers of stat watchers, |
1360 | as even with OS-supported change notifications, this can be |
1459 | as even with OS-supported change notifications, this can be |
1361 | resource\-intensive. |
1460 | resource\-intensive. |
1362 | .PP |
1461 | .PP |
1363 | At the time of this writing, no specific \s-1OS\s0 backends are implemented, but |
1462 | At the time of this writing, only the Linux inotify interface is |
1364 | if demand increases, at least a kqueue and inotify backend will be added. |
1463 | implemented (implementing kqueue support is left as an exercise for the |
|
|
1464 | reader). Inotify will be used to give hints only and should not change the |
|
|
1465 | semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs |
|
|
1466 | to fall back to regular polling again even with inotify, but changes are |
|
|
1467 | usually detected immediately, and if the file exists there will be no |
|
|
1468 | polling. |
1365 | .IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 |
1469 | .IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 |
1366 | .IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" |
1470 | .IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" |
1367 | .PD 0 |
1471 | .PD 0 |
1368 | .IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4 |
1472 | .IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4 |
1369 | .IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" |
1473 | .IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" |
… | |
… | |
1430 | \& ev_stat_start (loop, &passwd); |
1534 | \& ev_stat_start (loop, &passwd); |
1431 | .Ve |
1535 | .Ve |
1432 | .ie n .Sh """ev_idle"" \- when you've got nothing better to do..." |
1536 | .ie n .Sh """ev_idle"" \- when you've got nothing better to do..." |
1433 | .el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." |
1537 | .el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." |
1434 | .IX Subsection "ev_idle - when you've got nothing better to do..." |
1538 | .IX Subsection "ev_idle - when you've got nothing better to do..." |
1435 | Idle watchers trigger events when there are no other events are pending |
1539 | Idle watchers trigger events when no other events of the same or higher |
1436 | (prepare, check and other idle watchers do not count). That is, as long |
1540 | priority are pending (prepare, check and other idle watchers do not |
1437 | as your process is busy handling sockets or timeouts (or even signals, |
1541 | count). |
1438 | imagine) it will not be triggered. But when your process is idle all idle |
1542 | .PP |
1439 | watchers are being called again and again, once per event loop iteration \- |
1543 | That is, as long as your process is busy handling sockets or timeouts |
|
|
1544 | (or even signals, imagine) of the same or higher priority it will not be |
|
|
1545 | triggered. But when your process is idle (or only lower-priority watchers |
|
|
1546 | are pending), the idle watchers are being called once per event loop |
1440 | until stopped, that is, or your process receives more events and becomes |
1547 | iteration \- until stopped, that is, or your process receives more events |
1441 | busy. |
1548 | and becomes busy again with higher priority stuff. |
1442 | .PP |
1549 | .PP |
1443 | The most noteworthy effect is that as long as any idle watchers are |
1550 | The most noteworthy effect is that as long as any idle watchers are |
1444 | active, the process will not block when waiting for new events. |
1551 | active, the process will not block when waiting for new events. |
1445 | .PP |
1552 | .PP |
1446 | Apart from keeping your process non-blocking (which is a useful |
1553 | Apart from keeping your process non-blocking (which is a useful |
… | |
… | |
1541 | \& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
1648 | \& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
1542 | \& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
1649 | \& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
1543 | \& } |
1650 | \& } |
1544 | .Ve |
1651 | .Ve |
1545 | .PP |
1652 | .PP |
1546 | .Vb 7 |
1653 | .Vb 8 |
1547 | \& // create io watchers for each fd and a timer before blocking |
1654 | \& // create io watchers for each fd and a timer before blocking |
1548 | \& static void |
1655 | \& static void |
1549 | \& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
1656 | \& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
1550 | \& { |
1657 | \& { |
1551 | \& int timeout = 3600000;truct pollfd fds [nfd]; |
1658 | \& int timeout = 3600000; |
|
|
1659 | \& struct pollfd fds [nfd]; |
1552 | \& // actual code will need to loop here and realloc etc. |
1660 | \& // actual code will need to loop here and realloc etc. |
1553 | \& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
1661 | \& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
1554 | .Ve |
1662 | .Ve |
1555 | .PP |
1663 | .PP |
1556 | .Vb 3 |
1664 | .Vb 3 |
… | |
… | |
1928 | .el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 |
2036 | .el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 |
1929 | .IX Item "EV_DEFAULT, EV_DEFAULT_" |
2037 | .IX Item "EV_DEFAULT, EV_DEFAULT_" |
1930 | Similar to the other two macros, this gives you the value of the default |
2038 | Similar to the other two macros, this gives you the value of the default |
1931 | loop, if multiple loops are supported (\*(L"ev loop default\*(R"). |
2039 | loop, if multiple loops are supported (\*(L"ev loop default\*(R"). |
1932 | .PP |
2040 | .PP |
1933 | Example: Declare and initialise a check watcher, working regardless of |
2041 | Example: Declare and initialise a check watcher, utilising the above |
1934 | wether multiple loops are supported or not. |
2042 | macros so it will work regardless of wether multiple loops are supported |
|
|
2043 | or not. |
1935 | .PP |
2044 | .PP |
1936 | .Vb 5 |
2045 | .Vb 5 |
1937 | \& static void |
2046 | \& static void |
1938 | \& check_cb (EV_P_ ev_timer *w, int revents) |
2047 | \& check_cb (EV_P_ ev_timer *w, int revents) |
1939 | \& { |
2048 | \& { |
… | |
… | |
2002 | .Vb 1 |
2111 | .Vb 1 |
2003 | \& ev_win32.c required on win32 platforms only |
2112 | \& ev_win32.c required on win32 platforms only |
2004 | .Ve |
2113 | .Ve |
2005 | .PP |
2114 | .PP |
2006 | .Vb 5 |
2115 | .Vb 5 |
2007 | \& ev_select.c only when select backend is enabled (which is by default) |
2116 | \& ev_select.c only when select backend is enabled (which is enabled by default) |
2008 | \& ev_poll.c only when poll backend is enabled (disabled by default) |
2117 | \& ev_poll.c only when poll backend is enabled (disabled by default) |
2009 | \& ev_epoll.c only when the epoll backend is enabled (disabled by default) |
2118 | \& ev_epoll.c only when the epoll backend is enabled (disabled by default) |
2010 | \& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
2119 | \& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
2011 | \& ev_port.c only when the solaris port backend is enabled (disabled by default) |
2120 | \& ev_port.c only when the solaris port backend is enabled (disabled by default) |
2012 | .Ve |
2121 | .Ve |
… | |
… | |
2133 | otherwise another method will be used as fallback. This is the preferred |
2242 | otherwise another method will be used as fallback. This is the preferred |
2134 | backend for Solaris 10 systems. |
2243 | backend for Solaris 10 systems. |
2135 | .IP "\s-1EV_USE_DEVPOLL\s0" 4 |
2244 | .IP "\s-1EV_USE_DEVPOLL\s0" 4 |
2136 | .IX Item "EV_USE_DEVPOLL" |
2245 | .IX Item "EV_USE_DEVPOLL" |
2137 | reserved for future expansion, works like the \s-1USE\s0 symbols above. |
2246 | reserved for future expansion, works like the \s-1USE\s0 symbols above. |
|
|
2247 | .IP "\s-1EV_USE_INOTIFY\s0" 4 |
|
|
2248 | .IX Item "EV_USE_INOTIFY" |
|
|
2249 | If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify |
|
|
2250 | interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will |
|
|
2251 | be detected at runtime. |
2138 | .IP "\s-1EV_H\s0" 4 |
2252 | .IP "\s-1EV_H\s0" 4 |
2139 | .IX Item "EV_H" |
2253 | .IX Item "EV_H" |
2140 | The name of the \fIev.h\fR header file used to include it. The default if |
2254 | The name of the \fIev.h\fR header file used to include it. The default if |
2141 | undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This |
2255 | undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This |
2142 | can be used to virtually rename the \fIev.h\fR header file in case of conflicts. |
2256 | can be used to virtually rename the \fIev.h\fR header file in case of conflicts. |
… | |
… | |
2165 | .IP "\s-1EV_PERIODIC_ENABLE\s0" 4 |
2279 | .IP "\s-1EV_PERIODIC_ENABLE\s0" 4 |
2166 | .IX Item "EV_PERIODIC_ENABLE" |
2280 | .IX Item "EV_PERIODIC_ENABLE" |
2167 | If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If |
2281 | If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If |
2168 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
2282 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
2169 | code. |
2283 | code. |
|
|
2284 | .IP "\s-1EV_IDLE_ENABLE\s0" 4 |
|
|
2285 | .IX Item "EV_IDLE_ENABLE" |
|
|
2286 | If undefined or defined to be \f(CW1\fR, then idle watchers are supported. If |
|
|
2287 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
|
|
2288 | code. |
2170 | .IP "\s-1EV_EMBED_ENABLE\s0" 4 |
2289 | .IP "\s-1EV_EMBED_ENABLE\s0" 4 |
2171 | .IX Item "EV_EMBED_ENABLE" |
2290 | .IX Item "EV_EMBED_ENABLE" |
2172 | If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If |
2291 | If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If |
2173 | defined to be \f(CW0\fR, then they are not. |
2292 | defined to be \f(CW0\fR, then they are not. |
2174 | .IP "\s-1EV_STAT_ENABLE\s0" 4 |
2293 | .IP "\s-1EV_STAT_ENABLE\s0" 4 |
… | |
… | |
2187 | .IP "\s-1EV_PID_HASHSIZE\s0" 4 |
2306 | .IP "\s-1EV_PID_HASHSIZE\s0" 4 |
2188 | .IX Item "EV_PID_HASHSIZE" |
2307 | .IX Item "EV_PID_HASHSIZE" |
2189 | \&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by |
2308 | \&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by |
2190 | pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more |
2309 | pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more |
2191 | than enough. If you need to manage thousands of children you might want to |
2310 | than enough. If you need to manage thousands of children you might want to |
2192 | increase this value. |
2311 | increase this value (\fImust\fR be a power of two). |
|
|
2312 | .IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4 |
|
|
2313 | .IX Item "EV_INOTIFY_HASHSIZE" |
|
|
2314 | \&\f(CW\*(C`ev_staz\*(C'\fR watchers use a small hash table to distribute workload by |
|
|
2315 | inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), |
|
|
2316 | usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR |
|
|
2317 | watchers you might want to increase this value (\fImust\fR be a power of |
|
|
2318 | two). |
2193 | .IP "\s-1EV_COMMON\s0" 4 |
2319 | .IP "\s-1EV_COMMON\s0" 4 |
2194 | .IX Item "EV_COMMON" |
2320 | .IX Item "EV_COMMON" |
2195 | By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining |
2321 | By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining |
2196 | this macro to a something else you can include more and other types of |
2322 | this macro to a something else you can include more and other types of |
2197 | members. You have to define it each time you include one of the files, |
2323 | members. You have to define it each time you include one of the files, |
… | |
… | |
2227 | interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file |
2353 | interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file |
2228 | will be compiled. It is pretty complex because it provides its own header |
2354 | will be compiled. It is pretty complex because it provides its own header |
2229 | file. |
2355 | file. |
2230 | .Sp |
2356 | .Sp |
2231 | The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file |
2357 | The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file |
2232 | that everybody includes and which overrides some autoconf choices: |
2358 | that everybody includes and which overrides some configure choices: |
2233 | .Sp |
2359 | .Sp |
2234 | .Vb 4 |
2360 | .Vb 9 |
|
|
2361 | \& #define EV_MINIMAL 1 |
2235 | \& #define EV_USE_POLL 0 |
2362 | \& #define EV_USE_POLL 0 |
2236 | \& #define EV_MULTIPLICITY 0 |
2363 | \& #define EV_MULTIPLICITY 0 |
2237 | \& #define EV_PERIODICS 0 |
2364 | \& #define EV_PERIODIC_ENABLE 0 |
|
|
2365 | \& #define EV_STAT_ENABLE 0 |
|
|
2366 | \& #define EV_FORK_ENABLE 0 |
2238 | \& #define EV_CONFIG_H <config.h> |
2367 | \& #define EV_CONFIG_H <config.h> |
|
|
2368 | \& #define EV_MINPRI 0 |
|
|
2369 | \& #define EV_MAXPRI 0 |
2239 | .Ve |
2370 | .Ve |
2240 | .Sp |
2371 | .Sp |
2241 | .Vb 1 |
2372 | .Vb 1 |
2242 | \& #include "ev++.h" |
2373 | \& #include "ev++.h" |
2243 | .Ve |
2374 | .Ve |
… | |
… | |
2261 | .IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" |
2392 | .IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" |
2262 | .IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 |
2393 | .IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 |
2263 | .IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" |
2394 | .IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" |
2264 | .IP "Stopping check/prepare/idle watchers: O(1)" 4 |
2395 | .IP "Stopping check/prepare/idle watchers: O(1)" 4 |
2265 | .IX Item "Stopping check/prepare/idle watchers: O(1)" |
2396 | .IX Item "Stopping check/prepare/idle watchers: O(1)" |
2266 | .IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))" 4 |
2397 | .IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4 |
2267 | .IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))" |
2398 | .IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))" |
2268 | .IP "Finding the next timer per loop iteration: O(1)" 4 |
2399 | .IP "Finding the next timer per loop iteration: O(1)" 4 |
2269 | .IX Item "Finding the next timer per loop iteration: O(1)" |
2400 | .IX Item "Finding the next timer per loop iteration: O(1)" |
2270 | .IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 |
2401 | .IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 |
2271 | .IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" |
2402 | .IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" |
2272 | .IP "Activating one watcher: O(1)" 4 |
2403 | .IP "Activating one watcher: O(1)" 4 |