… | |
… | |
126 | . ds Ae AE |
126 | . ds Ae AE |
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 "EV 1" |
132 | .TH "<STANDARD INPUT>" 1 "2007-12-09" "perl v5.8.8" "User Contributed Perl Documentation" |
132 | .TH EV 1 "2007-12-19" "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 |
… | |
… | |
243 | Libev represents time as a single floating point number, representing the |
243 | Libev represents time as a single floating point number, representing the |
244 | (fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near |
244 | (fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near |
245 | the beginning of 1970, details are complicated, don't ask). This type is |
245 | the beginning of 1970, details are complicated, don't ask). This type is |
246 | called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually aliases |
246 | called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually aliases |
247 | to the \f(CW\*(C`double\*(C'\fR type in C, and when you need to do any calculations on |
247 | to the \f(CW\*(C`double\*(C'\fR type in C, and when you need to do any calculations on |
248 | it, you should treat it as such. |
248 | it, you should treat it as some floatingpoint value. Unlike the name |
|
|
249 | component \f(CW\*(C`stamp\*(C'\fR might indicate, it is also used for time differences |
|
|
250 | throughout libev. |
249 | .SH "GLOBAL FUNCTIONS" |
251 | .SH "GLOBAL FUNCTIONS" |
250 | .IX Header "GLOBAL FUNCTIONS" |
252 | .IX Header "GLOBAL FUNCTIONS" |
251 | These functions can be called anytime, even before initialising the |
253 | These functions can be called anytime, even before initialising the |
252 | library in any way. |
254 | library in any way. |
253 | .IP "ev_tstamp ev_time ()" 4 |
255 | .IP "ev_tstamp ev_time ()" 4 |
… | |
… | |
555 | Destroys the default loop again (frees all memory and kernel state |
557 | Destroys the default loop again (frees all memory and kernel state |
556 | etc.). None of the active event watchers will be stopped in the normal |
558 | etc.). None of the active event watchers will be stopped in the normal |
557 | sense, so e.g. \f(CW\*(C`ev_is_active\*(C'\fR might still return true. It is your |
559 | sense, so e.g. \f(CW\*(C`ev_is_active\*(C'\fR might still return true. It is your |
558 | responsibility to either stop all watchers cleanly yoursef \fIbefore\fR |
560 | responsibility to either stop all watchers cleanly yoursef \fIbefore\fR |
559 | calling this function, or cope with the fact afterwards (which is usually |
561 | calling this function, or cope with the fact afterwards (which is usually |
560 | the easiest thing, youc na just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them |
562 | the easiest thing, you can just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them |
561 | for example). |
563 | for example). |
|
|
564 | .Sp |
|
|
565 | Not that certain global state, such as signal state, will not be freed by |
|
|
566 | this function, and related watchers (such as signal and child watchers) |
|
|
567 | would need to be stopped manually. |
|
|
568 | .Sp |
|
|
569 | In general it is not advisable to call this function except in the |
|
|
570 | rare occasion where you really need to free e.g. the signal handling |
|
|
571 | pipe fds. If you need dynamically allocated loops it is better to use |
|
|
572 | \&\f(CW\*(C`ev_loop_new\*(C'\fR and \f(CW\*(C`ev_loop_destroy\*(C'\fR). |
562 | .IP "ev_loop_destroy (loop)" 4 |
573 | .IP "ev_loop_destroy (loop)" 4 |
563 | .IX Item "ev_loop_destroy (loop)" |
574 | .IX Item "ev_loop_destroy (loop)" |
564 | Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an |
575 | Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an |
565 | earlier call to \f(CW\*(C`ev_loop_new\*(C'\fR. |
576 | earlier call to \f(CW\*(C`ev_loop_new\*(C'\fR. |
566 | .IP "ev_default_fork ()" 4 |
577 | .IP "ev_default_fork ()" 4 |
… | |
… | |
1065 | If you cannot run the fd in non-blocking mode (for example you should not |
1076 | If you cannot run the fd in non-blocking mode (for example you should not |
1066 | play around with an Xlib connection), then you have to seperately re-test |
1077 | play around with an Xlib connection), then you have to seperately re-test |
1067 | whether a file descriptor is really ready with a known-to-be good interface |
1078 | whether a file descriptor is really ready with a known-to-be good interface |
1068 | such as poll (fortunately in our Xlib example, Xlib already does this on |
1079 | such as poll (fortunately in our Xlib example, Xlib already does this on |
1069 | its own, so its quite safe to use). |
1080 | its own, so its quite safe to use). |
|
|
1081 | .PP |
|
|
1082 | \fIThe special problem of disappearing file descriptors\fR |
|
|
1083 | .IX Subsection "The special problem of disappearing file descriptors" |
|
|
1084 | .PP |
|
|
1085 | Some backends (e.g kqueue, epoll) need to be told about closing a file |
|
|
1086 | descriptor (either by calling \f(CW\*(C`close\*(C'\fR explicitly or by any other means, |
|
|
1087 | such as \f(CW\*(C`dup\*(C'\fR). The reason is that you register interest in some file |
|
|
1088 | descriptor, but when it goes away, the operating system will silently drop |
|
|
1089 | this interest. If another file descriptor with the same number then is |
|
|
1090 | registered with libev, there is no efficient way to see that this is, in |
|
|
1091 | fact, a different file descriptor. |
|
|
1092 | .PP |
|
|
1093 | To avoid having to explicitly tell libev about such cases, libev follows |
|
|
1094 | the following policy: Each time \f(CW\*(C`ev_io_set\*(C'\fR is being called, libev |
|
|
1095 | will assume that this is potentially a new file descriptor, otherwise |
|
|
1096 | it is assumed that the file descriptor stays the same. That means that |
|
|
1097 | you \fIhave\fR to call \f(CW\*(C`ev_io_set\*(C'\fR (or \f(CW\*(C`ev_io_init\*(C'\fR) when you change the |
|
|
1098 | descriptor even if the file descriptor number itself did not change. |
|
|
1099 | .PP |
|
|
1100 | This is how one would do it normally anyway, the important point is that |
|
|
1101 | the libev application should not optimise around libev but should leave |
|
|
1102 | optimisations to libev. |
|
|
1103 | .PP |
|
|
1104 | \fIWatcher-Specific Functions\fR |
|
|
1105 | .IX Subsection "Watcher-Specific Functions" |
1070 | .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 |
1106 | .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 |
1071 | .IX Item "ev_io_init (ev_io *, callback, int fd, int events)" |
1107 | .IX Item "ev_io_init (ev_io *, callback, int fd, int events)" |
1072 | .PD 0 |
1108 | .PD 0 |
1073 | .IP "ev_io_set (ev_io *, int fd, int events)" 4 |
1109 | .IP "ev_io_set (ev_io *, int fd, int events)" 4 |
1074 | .IX Item "ev_io_set (ev_io *, int fd, int events)" |
1110 | .IX Item "ev_io_set (ev_io *, int fd, int events)" |
… | |
… | |
1127 | .Ve |
1163 | .Ve |
1128 | .PP |
1164 | .PP |
1129 | The callback is guarenteed to be invoked only when its timeout has passed, |
1165 | The callback is guarenteed to be invoked only when its timeout has passed, |
1130 | but if multiple timers become ready during the same loop iteration then |
1166 | but if multiple timers become ready during the same loop iteration then |
1131 | order of execution is undefined. |
1167 | order of execution is undefined. |
|
|
1168 | .PP |
|
|
1169 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1170 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1132 | .IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4 |
1171 | .IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4 |
1133 | .IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" |
1172 | .IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" |
1134 | .PD 0 |
1173 | .PD 0 |
1135 | .IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 |
1174 | .IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 |
1136 | .IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" |
1175 | .IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" |
… | |
… | |
1247 | rules. |
1286 | rules. |
1248 | .PP |
1287 | .PP |
1249 | As with timers, the callback is guarenteed to be invoked only when the |
1288 | As with timers, the callback is guarenteed to be invoked only when the |
1250 | time (\f(CW\*(C`at\*(C'\fR) has been passed, but if multiple periodic timers become ready |
1289 | time (\f(CW\*(C`at\*(C'\fR) has been passed, but if multiple periodic timers become ready |
1251 | during the same loop iteration then order of execution is undefined. |
1290 | during the same loop iteration then order of execution is undefined. |
|
|
1291 | .PP |
|
|
1292 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1293 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1252 | .IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 |
1294 | .IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 |
1253 | .IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" |
1295 | .IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" |
1254 | .PD 0 |
1296 | .PD 0 |
1255 | .IP "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 4 |
1297 | .IP "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 4 |
1256 | .IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" |
1298 | .IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" |
… | |
… | |
1348 | .IP "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read\-write]" 4 |
1390 | .IP "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read\-write]" 4 |
1349 | .IX Item "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]" |
1391 | .IX Item "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]" |
1350 | The current reschedule callback, or \f(CW0\fR, if this functionality is |
1392 | The current reschedule callback, or \f(CW0\fR, if this functionality is |
1351 | switched off. Can be changed any time, but changes only take effect when |
1393 | switched off. Can be changed any time, but changes only take effect when |
1352 | the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. |
1394 | the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. |
|
|
1395 | .IP "ev_tstamp at [read\-only]" 4 |
|
|
1396 | .IX Item "ev_tstamp at [read-only]" |
|
|
1397 | When active, contains the absolute time that the watcher is supposed to |
|
|
1398 | trigger next. |
1353 | .PP |
1399 | .PP |
1354 | Example: Call a callback every hour, or, more precisely, whenever the |
1400 | Example: Call a callback every hour, or, more precisely, whenever the |
1355 | system clock is divisible by 3600. The callback invocation times have |
1401 | system clock is divisible by 3600. The callback invocation times have |
1356 | potentially a lot of jittering, but good long-term stability. |
1402 | potentially a lot of jittering, but good long-term stability. |
1357 | .PP |
1403 | .PP |
… | |
… | |
1407 | first watcher gets started will libev actually register a signal watcher |
1453 | first watcher gets started will libev actually register a signal watcher |
1408 | with the kernel (thus it coexists with your own signal handlers as long |
1454 | with the kernel (thus it coexists with your own signal handlers as long |
1409 | as you don't register any with libev). Similarly, when the last signal |
1455 | as you don't register any with libev). Similarly, when the last signal |
1410 | watcher for a signal is stopped libev will reset the signal handler to |
1456 | watcher for a signal is stopped libev will reset the signal handler to |
1411 | \&\s-1SIG_DFL\s0 (regardless of what it was set to before). |
1457 | \&\s-1SIG_DFL\s0 (regardless of what it was set to before). |
|
|
1458 | .PP |
|
|
1459 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1460 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1412 | .IP "ev_signal_init (ev_signal *, callback, int signum)" 4 |
1461 | .IP "ev_signal_init (ev_signal *, callback, int signum)" 4 |
1413 | .IX Item "ev_signal_init (ev_signal *, callback, int signum)" |
1462 | .IX Item "ev_signal_init (ev_signal *, callback, int signum)" |
1414 | .PD 0 |
1463 | .PD 0 |
1415 | .IP "ev_signal_set (ev_signal *, int signum)" 4 |
1464 | .IP "ev_signal_set (ev_signal *, int signum)" 4 |
1416 | .IX Item "ev_signal_set (ev_signal *, int signum)" |
1465 | .IX Item "ev_signal_set (ev_signal *, int signum)" |
… | |
… | |
1423 | .ie n .Sh """ev_child"" \- watch out for process status changes" |
1472 | .ie n .Sh """ev_child"" \- watch out for process status changes" |
1424 | .el .Sh "\f(CWev_child\fP \- watch out for process status changes" |
1473 | .el .Sh "\f(CWev_child\fP \- watch out for process status changes" |
1425 | .IX Subsection "ev_child - watch out for process status changes" |
1474 | .IX Subsection "ev_child - watch out for process status changes" |
1426 | Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to |
1475 | Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to |
1427 | some child status changes (most typically when a child of yours dies). |
1476 | some child status changes (most typically when a child of yours dies). |
|
|
1477 | .PP |
|
|
1478 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1479 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1428 | .IP "ev_child_init (ev_child *, callback, int pid)" 4 |
1480 | .IP "ev_child_init (ev_child *, callback, int pid)" 4 |
1429 | .IX Item "ev_child_init (ev_child *, callback, int pid)" |
1481 | .IX Item "ev_child_init (ev_child *, callback, int pid)" |
1430 | .PD 0 |
1482 | .PD 0 |
1431 | .IP "ev_child_set (ev_child *, int pid)" 4 |
1483 | .IP "ev_child_set (ev_child *, int pid)" 4 |
1432 | .IX Item "ev_child_set (ev_child *, int pid)" |
1484 | .IX Item "ev_child_set (ev_child *, int pid)" |
… | |
… | |
1497 | reader). Inotify will be used to give hints only and should not change the |
1549 | reader). Inotify will be used to give hints only and should not change the |
1498 | semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs |
1550 | semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs |
1499 | to fall back to regular polling again even with inotify, but changes are |
1551 | to fall back to regular polling again even with inotify, but changes are |
1500 | usually detected immediately, and if the file exists there will be no |
1552 | usually detected immediately, and if the file exists there will be no |
1501 | polling. |
1553 | polling. |
|
|
1554 | .PP |
|
|
1555 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1556 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1502 | .IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 |
1557 | .IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 |
1503 | .IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" |
1558 | .IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" |
1504 | .PD 0 |
1559 | .PD 0 |
1505 | .IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4 |
1560 | .IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4 |
1506 | .IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" |
1561 | .IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" |
… | |
… | |
1585 | .PP |
1640 | .PP |
1586 | Apart from keeping your process non-blocking (which is a useful |
1641 | Apart from keeping your process non-blocking (which is a useful |
1587 | effect on its own sometimes), idle watchers are a good place to do |
1642 | effect on its own sometimes), idle watchers are a good place to do |
1588 | \&\*(L"pseudo\-background processing\*(R", or delay processing stuff to after the |
1643 | \&\*(L"pseudo\-background processing\*(R", or delay processing stuff to after the |
1589 | event loop has handled all outstanding events. |
1644 | event loop has handled all outstanding events. |
|
|
1645 | .PP |
|
|
1646 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1647 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1590 | .IP "ev_idle_init (ev_signal *, callback)" 4 |
1648 | .IP "ev_idle_init (ev_signal *, callback)" 4 |
1591 | .IX Item "ev_idle_init (ev_signal *, callback)" |
1649 | .IX Item "ev_idle_init (ev_signal *, callback)" |
1592 | Initialises and configures the idle watcher \- it has no parameters of any |
1650 | Initialises and configures the idle watcher \- it has no parameters of any |
1593 | kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, |
1651 | kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, |
1594 | believe me. |
1652 | believe me. |
… | |
… | |
1659 | supports this, they will be called before other \f(CW\*(C`ev_check\*(C'\fR watchers did |
1717 | supports this, they will be called before other \f(CW\*(C`ev_check\*(C'\fR watchers did |
1660 | their job. As \f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other event |
1718 | their job. As \f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other event |
1661 | loops those other event loops might be in an unusable state until their |
1719 | loops those other event loops might be in an unusable state until their |
1662 | \&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with |
1720 | \&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with |
1663 | others). |
1721 | others). |
|
|
1722 | .PP |
|
|
1723 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1724 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1664 | .IP "ev_prepare_init (ev_prepare *, callback)" 4 |
1725 | .IP "ev_prepare_init (ev_prepare *, callback)" 4 |
1665 | .IX Item "ev_prepare_init (ev_prepare *, callback)" |
1726 | .IX Item "ev_prepare_init (ev_prepare *, callback)" |
1666 | .PD 0 |
1727 | .PD 0 |
1667 | .IP "ev_check_init (ev_check *, callback)" 4 |
1728 | .IP "ev_check_init (ev_check *, callback)" 4 |
1668 | .IX Item "ev_check_init (ev_check *, callback)" |
1729 | .IX Item "ev_check_init (ev_check *, callback)" |
… | |
… | |
1915 | \& ev_embed_start (loop_hi, &embed); |
1976 | \& ev_embed_start (loop_hi, &embed); |
1916 | \& } |
1977 | \& } |
1917 | \& else |
1978 | \& else |
1918 | \& loop_lo = loop_hi; |
1979 | \& loop_lo = loop_hi; |
1919 | .Ve |
1980 | .Ve |
|
|
1981 | .PP |
|
|
1982 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1983 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1920 | .IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
1984 | .IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
1921 | .IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" |
1985 | .IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" |
1922 | .PD 0 |
1986 | .PD 0 |
1923 | .IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
1987 | .IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
1924 | .IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" |
1988 | .IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" |
… | |
… | |
1944 | \&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the |
2008 | \&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the |
1945 | event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, |
2009 | event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, |
1946 | and only in the child after the fork. If whoever good citizen calling |
2010 | and only in the child after the fork. If whoever good citizen calling |
1947 | \&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork |
2011 | \&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork |
1948 | handlers will be invoked, too, of course. |
2012 | handlers will be invoked, too, of course. |
|
|
2013 | .PP |
|
|
2014 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
2015 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1949 | .IP "ev_fork_init (ev_signal *, callback)" 4 |
2016 | .IP "ev_fork_init (ev_signal *, callback)" 4 |
1950 | .IX Item "ev_fork_init (ev_signal *, callback)" |
2017 | .IX Item "ev_fork_init (ev_signal *, callback)" |
1951 | Initialises and configures the fork watcher \- it has no parameters of any |
2018 | Initialises and configures the fork watcher \- it has no parameters of any |
1952 | kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless, |
2019 | kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless, |
1953 | believe me. |
2020 | believe me. |
… | |
… | |
2147 | Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the |
2214 | Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the |
2148 | constructor already stores the event loop. |
2215 | constructor already stores the event loop. |
2149 | .IP "w\->stop ()" 4 |
2216 | .IP "w\->stop ()" 4 |
2150 | .IX Item "w->stop ()" |
2217 | .IX Item "w->stop ()" |
2151 | Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. |
2218 | Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. |
2152 | .ie n .IP "w\->again () ""ev::timer""\fR, \f(CW""ev::periodic"" only" 4 |
2219 | .ie n .IP "w\->again () (""ev::timer""\fR, \f(CW""ev::periodic"" only)" 4 |
2153 | .el .IP "w\->again () \f(CWev::timer\fR, \f(CWev::periodic\fR only" 4 |
2220 | .el .IP "w\->again () (\f(CWev::timer\fR, \f(CWev::periodic\fR only)" 4 |
2154 | .IX Item "w->again () ev::timer, ev::periodic only" |
2221 | .IX Item "w->again () (ev::timer, ev::periodic only)" |
2155 | For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding |
2222 | For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding |
2156 | \&\f(CW\*(C`ev_TYPE_again\*(C'\fR function. |
2223 | \&\f(CW\*(C`ev_TYPE_again\*(C'\fR function. |
2157 | .ie n .IP "w\->sweep () ""ev::embed"" only" 4 |
2224 | .ie n .IP "w\->sweep () (""ev::embed"" only)" 4 |
2158 | .el .IP "w\->sweep () \f(CWev::embed\fR only" 4 |
2225 | .el .IP "w\->sweep () (\f(CWev::embed\fR only)" 4 |
2159 | .IX Item "w->sweep () ev::embed only" |
2226 | .IX Item "w->sweep () (ev::embed only)" |
2160 | Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR. |
2227 | Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR. |
2161 | .ie n .IP "w\->update () ""ev::stat"" only" 4 |
2228 | .ie n .IP "w\->update () (""ev::stat"" only)" 4 |
2162 | .el .IP "w\->update () \f(CWev::stat\fR only" 4 |
2229 | .el .IP "w\->update () (\f(CWev::stat\fR only)" 4 |
2163 | .IX Item "w->update () ev::stat only" |
2230 | .IX Item "w->update () (ev::stat only)" |
2164 | Invokes \f(CW\*(C`ev_stat_stat\*(C'\fR. |
2231 | Invokes \f(CW\*(C`ev_stat_stat\*(C'\fR. |
2165 | .RE |
2232 | .RE |
2166 | .RS 4 |
2233 | .RS 4 |
2167 | .RE |
2234 | .RE |
2168 | .PP |
2235 | .PP |
… | |
… | |
2192 | \& io.start (fd, ev::READ); |
2259 | \& io.start (fd, ev::READ); |
2193 | \& } |
2260 | \& } |
2194 | .Ve |
2261 | .Ve |
2195 | .SH "MACRO MAGIC" |
2262 | .SH "MACRO MAGIC" |
2196 | .IX Header "MACRO MAGIC" |
2263 | .IX Header "MACRO MAGIC" |
2197 | Libev can be compiled with a variety of options, the most fundemantal is |
2264 | Libev can be compiled with a variety of options, the most fundamantal |
2198 | \&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) functions and |
2265 | of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) |
2199 | callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. |
2266 | functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. |
2200 | .PP |
2267 | .PP |
2201 | To make it easier to write programs that cope with either variant, the |
2268 | To make it easier to write programs that cope with either variant, the |
2202 | following macros are defined: |
2269 | following macros are defined: |
2203 | .ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4 |
2270 | .ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4 |
2204 | .el .IP "\f(CWEV_A\fR, \f(CWEV_A_\fR" 4 |
2271 | .el .IP "\f(CWEV_A\fR, \f(CWEV_A_\fR" 4 |
… | |
… | |
2562 | and the way callbacks are invoked and set. Must expand to a struct member |
2629 | and the way callbacks are invoked and set. Must expand to a struct member |
2563 | definition and a statement, respectively. See the \fIev.v\fR header file for |
2630 | definition and a statement, respectively. See the \fIev.v\fR header file for |
2564 | their default definitions. One possible use for overriding these is to |
2631 | their default definitions. One possible use for overriding these is to |
2565 | avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use |
2632 | avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use |
2566 | method calls instead of plain function calls in \*(C+. |
2633 | method calls instead of plain function calls in \*(C+. |
|
|
2634 | .Sh "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0" |
|
|
2635 | .IX Subsection "EXPORTED API SYMBOLS" |
|
|
2636 | If you need to re-export the \s-1API\s0 (e.g. via a dll) and you need a list of |
|
|
2637 | exported symbols, you can use the provided \fISymbol.*\fR files which list |
|
|
2638 | all public symbols, one per line: |
|
|
2639 | .Sp |
|
|
2640 | .Vb 2 |
|
|
2641 | \& Symbols.ev for libev proper |
|
|
2642 | \& Symbols.event for the libevent emulation |
|
|
2643 | .Ve |
|
|
2644 | .Sp |
|
|
2645 | This can also be used to rename all public symbols to avoid clashes with |
|
|
2646 | multiple versions of libev linked together (which is obviously bad in |
|
|
2647 | itself, but sometimes it is inconvinient to avoid this). |
|
|
2648 | .Sp |
|
|
2649 | A sed comamnd like this will create wrapper \f(CW\*(C`#define\*(C'\fR's that you need to |
|
|
2650 | include before including \fIev.h\fR: |
|
|
2651 | .Sp |
|
|
2652 | .Vb 1 |
|
|
2653 | \& <Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h |
|
|
2654 | .Ve |
|
|
2655 | .Sp |
|
|
2656 | This would create a file \fIwrap.h\fR which essentially looks like this: |
|
|
2657 | .Sp |
|
|
2658 | .Vb 4 |
|
|
2659 | \& #define ev_backend myprefix_ev_backend |
|
|
2660 | \& #define ev_check_start myprefix_ev_check_start |
|
|
2661 | \& #define ev_check_stop myprefix_ev_check_stop |
|
|
2662 | \& ... |
|
|
2663 | .Ve |
2567 | .Sh "\s-1EXAMPLES\s0" |
2664 | .Sh "\s-1EXAMPLES\s0" |
2568 | .IX Subsection "EXAMPLES" |
2665 | .IX Subsection "EXAMPLES" |
2569 | For a real-world example of a program the includes libev |
2666 | For a real-world example of a program the includes libev |
2570 | verbatim, you can have a look at the \s-1EV\s0 perl module |
2667 | verbatim, you can have a look at the \s-1EV\s0 perl module |
2571 | (<http://software.schmorp.de/pkg/EV.html>). It has the libev files in |
2668 | (<http://software.schmorp.de/pkg/EV.html>). It has the libev files in |