… | |
… | |
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-11-28" "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 |
… | |
… | |
1383 | not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is |
1383 | not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is |
1384 | otherwise always forced to be at least one) and all the other fields of |
1384 | otherwise always forced to be at least one) and all the other fields of |
1385 | the stat buffer having unspecified contents. |
1385 | the stat buffer having unspecified contents. |
1386 | .PP |
1386 | .PP |
1387 | Since there is no standard to do this, the portable implementation simply |
1387 | Since there is no standard to do this, the portable implementation simply |
1388 | calls \f(CW\*(C`stat (2)\*(C'\fR regulalry on the path to see if it changed somehow. You |
1388 | calls \f(CW\*(C`stat (2)\*(C'\fR regularly on the path to see if it changed somehow. You |
1389 | can specify a recommended polling interval for this case. If you specify |
1389 | can specify a recommended polling interval for this case. If you specify |
1390 | a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable, |
1390 | a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable, |
1391 | unspecified default\fR value will be used (which you can expect to be around |
1391 | unspecified default\fR value will be used (which you can expect to be around |
1392 | five seconds, although this might change dynamically). Libev will also |
1392 | five seconds, although this might change dynamically). Libev will also |
1393 | impose a minimum interval which is currently around \f(CW0.1\fR, but thats |
1393 | impose a minimum interval which is currently around \f(CW0.1\fR, but thats |
… | |
… | |
1395 | .PP |
1395 | .PP |
1396 | This watcher type is not meant for massive numbers of stat watchers, |
1396 | This watcher type is not meant for massive numbers of stat watchers, |
1397 | as even with OS-supported change notifications, this can be |
1397 | as even with OS-supported change notifications, this can be |
1398 | resource\-intensive. |
1398 | resource\-intensive. |
1399 | .PP |
1399 | .PP |
1400 | At the time of this writing, no specific \s-1OS\s0 backends are implemented, but |
1400 | At the time of this writing, only the Linux inotify interface is |
1401 | if demand increases, at least a kqueue and inotify backend will be added. |
1401 | implemented (implementing kqueue support is left as an exercise for the |
|
|
1402 | reader). Inotify will be used to give hints only and should not change the |
|
|
1403 | semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs |
|
|
1404 | to fall back to regular polling again even with inotify, but changes are |
|
|
1405 | usually detected immediately, and if the file exists there will be no |
|
|
1406 | polling. |
1402 | .IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 |
1407 | .IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 |
1403 | .IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" |
1408 | .IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" |
1404 | .PD 0 |
1409 | .PD 0 |
1405 | .IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4 |
1410 | .IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4 |
1406 | .IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" |
1411 | .IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" |
… | |
… | |
2170 | otherwise another method will be used as fallback. This is the preferred |
2175 | otherwise another method will be used as fallback. This is the preferred |
2171 | backend for Solaris 10 systems. |
2176 | backend for Solaris 10 systems. |
2172 | .IP "\s-1EV_USE_DEVPOLL\s0" 4 |
2177 | .IP "\s-1EV_USE_DEVPOLL\s0" 4 |
2173 | .IX Item "EV_USE_DEVPOLL" |
2178 | .IX Item "EV_USE_DEVPOLL" |
2174 | reserved for future expansion, works like the \s-1USE\s0 symbols above. |
2179 | reserved for future expansion, works like the \s-1USE\s0 symbols above. |
|
|
2180 | .IP "\s-1EV_USE_INOTIFY\s0" 4 |
|
|
2181 | .IX Item "EV_USE_INOTIFY" |
|
|
2182 | If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify |
|
|
2183 | interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will |
|
|
2184 | be detected at runtime. |
2175 | .IP "\s-1EV_H\s0" 4 |
2185 | .IP "\s-1EV_H\s0" 4 |
2176 | .IX Item "EV_H" |
2186 | .IX Item "EV_H" |
2177 | The name of the \fIev.h\fR header file used to include it. The default if |
2187 | The name of the \fIev.h\fR header file used to include it. The default if |
2178 | undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This |
2188 | undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This |
2179 | can be used to virtually rename the \fIev.h\fR header file in case of conflicts. |
2189 | can be used to virtually rename the \fIev.h\fR header file in case of conflicts. |
… | |
… | |
2224 | .IP "\s-1EV_PID_HASHSIZE\s0" 4 |
2234 | .IP "\s-1EV_PID_HASHSIZE\s0" 4 |
2225 | .IX Item "EV_PID_HASHSIZE" |
2235 | .IX Item "EV_PID_HASHSIZE" |
2226 | \&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by |
2236 | \&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by |
2227 | pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more |
2237 | pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more |
2228 | than enough. If you need to manage thousands of children you might want to |
2238 | than enough. If you need to manage thousands of children you might want to |
2229 | increase this value. |
2239 | increase this value (\fImust\fR be a power of two). |
|
|
2240 | .IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4 |
|
|
2241 | .IX Item "EV_INOTIFY_HASHSIZE" |
|
|
2242 | \&\f(CW\*(C`ev_staz\*(C'\fR watchers use a small hash table to distribute workload by |
|
|
2243 | inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), |
|
|
2244 | usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR |
|
|
2245 | watchers you might want to increase this value (\fImust\fR be a power of |
|
|
2246 | two). |
2230 | .IP "\s-1EV_COMMON\s0" 4 |
2247 | .IP "\s-1EV_COMMON\s0" 4 |
2231 | .IX Item "EV_COMMON" |
2248 | .IX Item "EV_COMMON" |
2232 | By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining |
2249 | By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining |
2233 | this macro to a something else you can include more and other types of |
2250 | this macro to a something else you can include more and other types of |
2234 | members. You have to define it each time you include one of the files, |
2251 | members. You have to define it each time you include one of the files, |
… | |
… | |
2298 | .IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" |
2315 | .IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" |
2299 | .IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 |
2316 | .IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 |
2300 | .IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" |
2317 | .IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" |
2301 | .IP "Stopping check/prepare/idle watchers: O(1)" 4 |
2318 | .IP "Stopping check/prepare/idle watchers: O(1)" 4 |
2302 | .IX Item "Stopping check/prepare/idle watchers: O(1)" |
2319 | .IX Item "Stopping check/prepare/idle watchers: O(1)" |
2303 | .IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))" 4 |
2320 | .IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4 |
2304 | .IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))" |
2321 | .IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))" |
2305 | .IP "Finding the next timer per loop iteration: O(1)" 4 |
2322 | .IP "Finding the next timer per loop iteration: O(1)" 4 |
2306 | .IX Item "Finding the next timer per loop iteration: O(1)" |
2323 | .IX Item "Finding the next timer per loop iteration: O(1)" |
2307 | .IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 |
2324 | .IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 |
2308 | .IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" |
2325 | .IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" |
2309 | .IP "Activating one watcher: O(1)" 4 |
2326 | .IP "Activating one watcher: O(1)" 4 |