… | |
… | |
77 | on event-based programming, nor will it introduce event-based programming |
77 | on event-based programming, nor will it introduce event-based programming |
78 | with libev. |
78 | with libev. |
79 | |
79 | |
80 | Familiarity with event based programming techniques in general is assumed |
80 | Familiarity with event based programming techniques in general is assumed |
81 | throughout this document. |
81 | throughout this document. |
|
|
82 | |
|
|
83 | =head1 WHAT TO READ WHEN IN A HURRY |
|
|
84 | |
|
|
85 | This manual tries to be very detailed, but unfortunately, this also makes |
|
|
86 | it very long. If you just want to know the basics of libev, I suggest |
|
|
87 | reading L<ANATOMY OF A WATCHER>, then the L<EXAMPLE PROGRAM> above and |
|
|
88 | look up the missing functions in L<GLOBAL FUNCTIONS> and the C<ev_io> and |
|
|
89 | C<ev_timer> sections in L<WATCHER TYPES>. |
82 | |
90 | |
83 | =head1 ABOUT LIBEV |
91 | =head1 ABOUT LIBEV |
84 | |
92 | |
85 | Libev is an event loop: you register interest in certain events (such as a |
93 | Libev is an event loop: you register interest in certain events (such as a |
86 | file descriptor being readable or a timeout occurring), and it will manage |
94 | file descriptor being readable or a timeout occurring), and it will manage |
… | |
… | |
300 | An event loop is described by a C<struct ev_loop *> (the C<struct> is |
308 | An event loop is described by a C<struct ev_loop *> (the C<struct> is |
301 | I<not> optional in this case unless libev 3 compatibility is disabled, as |
309 | I<not> optional in this case unless libev 3 compatibility is disabled, as |
302 | libev 3 had an C<ev_loop> function colliding with the struct name). |
310 | libev 3 had an C<ev_loop> function colliding with the struct name). |
303 | |
311 | |
304 | The library knows two types of such loops, the I<default> loop, which |
312 | The library knows two types of such loops, the I<default> loop, which |
305 | supports signals and child events, and dynamically created event loops |
313 | supports child process events, and dynamically created event loops which |
306 | which do not. |
314 | do not. |
307 | |
315 | |
308 | =over 4 |
316 | =over 4 |
309 | |
317 | |
310 | =item struct ev_loop *ev_default_loop (unsigned int flags) |
318 | =item struct ev_loop *ev_default_loop (unsigned int flags) |
311 | |
319 | |
… | |
… | |
1114 | The event loop has been resumed in the child process after fork (see |
1122 | The event loop has been resumed in the child process after fork (see |
1115 | C<ev_fork>). |
1123 | C<ev_fork>). |
1116 | |
1124 | |
1117 | =item C<EV_CLEANUP> |
1125 | =item C<EV_CLEANUP> |
1118 | |
1126 | |
1119 | The event loop is abotu to be destroyed (see C<ev_cleanup>). |
1127 | The event loop is about to be destroyed (see C<ev_cleanup>). |
1120 | |
1128 | |
1121 | =item C<EV_ASYNC> |
1129 | =item C<EV_ASYNC> |
1122 | |
1130 | |
1123 | The given async watcher has been asynchronously notified (see C<ev_async>). |
1131 | The given async watcher has been asynchronously notified (see C<ev_async>). |
1124 | |
1132 | |
… | |
… | |
1146 | programs, though, as the fd could already be closed and reused for another |
1154 | programs, though, as the fd could already be closed and reused for another |
1147 | thing, so beware. |
1155 | thing, so beware. |
1148 | |
1156 | |
1149 | =back |
1157 | =back |
1150 | |
1158 | |
1151 | =head2 WATCHER STATES |
|
|
1152 | |
|
|
1153 | There are various watcher states mentioned throughout this manual - |
|
|
1154 | active, pending and so on. In this section these states and the rules to |
|
|
1155 | transition between them will be described in more detail - and while these |
|
|
1156 | rules might look complicated, they usually do "the right thing". |
|
|
1157 | |
|
|
1158 | =over 4 |
|
|
1159 | |
|
|
1160 | =item initialiased |
|
|
1161 | |
|
|
1162 | Before a watcher can be registered with the event looop it has to be |
|
|
1163 | initialised. This can be done with a call to C<ev_TYPE_init>, or calls to |
|
|
1164 | C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. |
|
|
1165 | |
|
|
1166 | In this state it is simply some block of memory that is suitable for use |
|
|
1167 | in an event loop. It can be moved around, freed, reused etc. at will. |
|
|
1168 | |
|
|
1169 | =item started/running/active |
|
|
1170 | |
|
|
1171 | Once a watcher has been started with a call to C<ev_TYPE_start> it becomes |
|
|
1172 | property of the event loop, and is actively waiting for events. While in |
|
|
1173 | this state it cannot be accessed (except in a few documented ways), moved, |
|
|
1174 | freed or anything else - the only legal thing is to keep a pointer to it, |
|
|
1175 | and call libev functions on it that are documented to work on active watchers. |
|
|
1176 | |
|
|
1177 | =item pending |
|
|
1178 | |
|
|
1179 | If a watcher is active and libev determines that an event it is interested |
|
|
1180 | in has occurred (such as a timer expiring), it will become pending. It will |
|
|
1181 | stay in this pending state until either it is stopped or its callback is |
|
|
1182 | about to be invoked, so it is not normally pending inside the watcher |
|
|
1183 | callback. |
|
|
1184 | |
|
|
1185 | The watcher might or might not be active while it is pending (for example, |
|
|
1186 | an expired non-repeating timer can be pending but no longer active). If it |
|
|
1187 | is stopped, it can be freely accessed (e.g. by calling C<ev_TYPE_set>), |
|
|
1188 | but it is still property of the event loop at this time, so cannot be |
|
|
1189 | moved, freed or reused. And if it is active the rules described in the |
|
|
1190 | previous item still apply. |
|
|
1191 | |
|
|
1192 | It is also possible to feed an event on a watcher that is not active (e.g. |
|
|
1193 | via C<ev_feed_event>), in which case it becomes pending without being |
|
|
1194 | active. |
|
|
1195 | |
|
|
1196 | =item stopped |
|
|
1197 | |
|
|
1198 | A watcher can be stopped implicitly by libev (in which case it might still |
|
|
1199 | be pending), or explicitly by calling its C<ev_TYPE_stop> function. The |
|
|
1200 | latter will clear any pending state the watcher might be in, regardless |
|
|
1201 | of whether it was active or not, so stopping a watcher explicitly before |
|
|
1202 | freeing it is often a good idea. |
|
|
1203 | |
|
|
1204 | While stopped (and not pending) the watcher is essentially in the |
|
|
1205 | initialised state, that is it can be reused, moved, modified in any way |
|
|
1206 | you wish. |
|
|
1207 | |
|
|
1208 | =back |
|
|
1209 | |
|
|
1210 | =head2 GENERIC WATCHER FUNCTIONS |
1159 | =head2 GENERIC WATCHER FUNCTIONS |
1211 | |
1160 | |
1212 | =over 4 |
1161 | =over 4 |
1213 | |
1162 | |
1214 | =item C<ev_init> (ev_TYPE *watcher, callback) |
1163 | =item C<ev_init> (ev_TYPE *watcher, callback) |
… | |
… | |
1355 | |
1304 | |
1356 | See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related |
1305 | See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related |
1357 | functions that do not need a watcher. |
1306 | functions that do not need a watcher. |
1358 | |
1307 | |
1359 | =back |
1308 | =back |
1360 | |
|
|
1361 | |
1309 | |
1362 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
1310 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
1363 | |
1311 | |
1364 | Each watcher has, by default, a member C<void *data> that you can change |
1312 | Each watcher has, by default, a member C<void *data> that you can change |
1365 | and read at any time: libev will completely ignore it. This can be used |
1313 | and read at any time: libev will completely ignore it. This can be used |
… | |
… | |
1421 | t2_cb (EV_P_ ev_timer *w, int revents) |
1369 | t2_cb (EV_P_ ev_timer *w, int revents) |
1422 | { |
1370 | { |
1423 | struct my_biggy big = (struct my_biggy *) |
1371 | struct my_biggy big = (struct my_biggy *) |
1424 | (((char *)w) - offsetof (struct my_biggy, t2)); |
1372 | (((char *)w) - offsetof (struct my_biggy, t2)); |
1425 | } |
1373 | } |
|
|
1374 | |
|
|
1375 | =head2 WATCHER STATES |
|
|
1376 | |
|
|
1377 | There are various watcher states mentioned throughout this manual - |
|
|
1378 | active, pending and so on. In this section these states and the rules to |
|
|
1379 | transition between them will be described in more detail - and while these |
|
|
1380 | rules might look complicated, they usually do "the right thing". |
|
|
1381 | |
|
|
1382 | =over 4 |
|
|
1383 | |
|
|
1384 | =item initialiased |
|
|
1385 | |
|
|
1386 | Before a watcher can be registered with the event looop it has to be |
|
|
1387 | initialised. This can be done with a call to C<ev_TYPE_init>, or calls to |
|
|
1388 | C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. |
|
|
1389 | |
|
|
1390 | In this state it is simply some block of memory that is suitable for use |
|
|
1391 | in an event loop. It can be moved around, freed, reused etc. at will. |
|
|
1392 | |
|
|
1393 | =item started/running/active |
|
|
1394 | |
|
|
1395 | Once a watcher has been started with a call to C<ev_TYPE_start> it becomes |
|
|
1396 | property of the event loop, and is actively waiting for events. While in |
|
|
1397 | this state it cannot be accessed (except in a few documented ways), moved, |
|
|
1398 | freed or anything else - the only legal thing is to keep a pointer to it, |
|
|
1399 | and call libev functions on it that are documented to work on active watchers. |
|
|
1400 | |
|
|
1401 | =item pending |
|
|
1402 | |
|
|
1403 | If a watcher is active and libev determines that an event it is interested |
|
|
1404 | in has occurred (such as a timer expiring), it will become pending. It will |
|
|
1405 | stay in this pending state until either it is stopped or its callback is |
|
|
1406 | about to be invoked, so it is not normally pending inside the watcher |
|
|
1407 | callback. |
|
|
1408 | |
|
|
1409 | The watcher might or might not be active while it is pending (for example, |
|
|
1410 | an expired non-repeating timer can be pending but no longer active). If it |
|
|
1411 | is stopped, it can be freely accessed (e.g. by calling C<ev_TYPE_set>), |
|
|
1412 | but it is still property of the event loop at this time, so cannot be |
|
|
1413 | moved, freed or reused. And if it is active the rules described in the |
|
|
1414 | previous item still apply. |
|
|
1415 | |
|
|
1416 | It is also possible to feed an event on a watcher that is not active (e.g. |
|
|
1417 | via C<ev_feed_event>), in which case it becomes pending without being |
|
|
1418 | active. |
|
|
1419 | |
|
|
1420 | =item stopped |
|
|
1421 | |
|
|
1422 | A watcher can be stopped implicitly by libev (in which case it might still |
|
|
1423 | be pending), or explicitly by calling its C<ev_TYPE_stop> function. The |
|
|
1424 | latter will clear any pending state the watcher might be in, regardless |
|
|
1425 | of whether it was active or not, so stopping a watcher explicitly before |
|
|
1426 | freeing it is often a good idea. |
|
|
1427 | |
|
|
1428 | While stopped (and not pending) the watcher is essentially in the |
|
|
1429 | initialised state, that is it can be reused, moved, modified in any way |
|
|
1430 | you wish. |
|
|
1431 | |
|
|
1432 | =back |
1426 | |
1433 | |
1427 | =head2 WATCHER PRIORITY MODELS |
1434 | =head2 WATCHER PRIORITY MODELS |
1428 | |
1435 | |
1429 | Many event loops support I<watcher priorities>, which are usually small |
1436 | Many event loops support I<watcher priorities>, which are usually small |
1430 | integers that influence the ordering of event callback invocation |
1437 | integers that influence the ordering of event callback invocation |
… | |
… | |
3098 | |
3105 | |
3099 | =item ev_fork_init (ev_fork *, callback) |
3106 | =item ev_fork_init (ev_fork *, callback) |
3100 | |
3107 | |
3101 | Initialises and configures the fork watcher - it has no parameters of any |
3108 | Initialises and configures the fork watcher - it has no parameters of any |
3102 | kind. There is a C<ev_fork_set> macro, but using it is utterly pointless, |
3109 | kind. There is a C<ev_fork_set> macro, but using it is utterly pointless, |
3103 | believe me. |
3110 | really. |
3104 | |
3111 | |
3105 | =back |
3112 | =back |
3106 | |
3113 | |
3107 | |
3114 | |
3108 | =head2 C<ev_cleanup> - even the best things end |
3115 | =head2 C<ev_cleanup> - even the best things end |
… | |
… | |
3126 | |
3133 | |
3127 | =item ev_cleanup_init (ev_cleanup *, callback) |
3134 | =item ev_cleanup_init (ev_cleanup *, callback) |
3128 | |
3135 | |
3129 | Initialises and configures the cleanup watcher - it has no parameters of |
3136 | Initialises and configures the cleanup watcher - it has no parameters of |
3130 | any kind. There is a C<ev_cleanup_set> macro, but using it is utterly |
3137 | any kind. There is a C<ev_cleanup_set> macro, but using it is utterly |
3131 | pointless, believe me. |
3138 | pointless, I assure you. |
3132 | |
3139 | |
3133 | =back |
3140 | =back |
3134 | |
3141 | |
3135 | Example: Register an atexit handler to destroy the default loop, so any |
3142 | Example: Register an atexit handler to destroy the default loop, so any |
3136 | cleanup functions are called. |
3143 | cleanup functions are called. |
… | |
… | |
4757 | structure (guaranteed by POSIX but not by ISO C for example), but it also |
4764 | structure (guaranteed by POSIX but not by ISO C for example), but it also |
4758 | assumes that the same (machine) code can be used to call any watcher |
4765 | assumes that the same (machine) code can be used to call any watcher |
4759 | callback: The watcher callbacks have different type signatures, but libev |
4766 | callback: The watcher callbacks have different type signatures, but libev |
4760 | calls them using an C<ev_watcher *> internally. |
4767 | calls them using an C<ev_watcher *> internally. |
4761 | |
4768 | |
|
|
4769 | =item pointer accesses must be thread-atomic |
|
|
4770 | |
|
|
4771 | Accessing a pointer value must be atomic, it must both be readable and |
|
|
4772 | writable in one piece - this is the case on all current architectures. |
|
|
4773 | |
4762 | =item C<sig_atomic_t volatile> must be thread-atomic as well |
4774 | =item C<sig_atomic_t volatile> must be thread-atomic as well |
4763 | |
4775 | |
4764 | The type C<sig_atomic_t volatile> (or whatever is defined as |
4776 | The type C<sig_atomic_t volatile> (or whatever is defined as |
4765 | C<EV_ATOMIC_T>) must be atomic with respect to accesses from different |
4777 | C<EV_ATOMIC_T>) must be atomic with respect to accesses from different |
4766 | threads. This is not part of the specification for C<sig_atomic_t>, but is |
4778 | threads. This is not part of the specification for C<sig_atomic_t>, but is |
… | |
… | |
4872 | =back |
4884 | =back |
4873 | |
4885 | |
4874 | |
4886 | |
4875 | =head1 PORTING FROM LIBEV 3.X TO 4.X |
4887 | =head1 PORTING FROM LIBEV 3.X TO 4.X |
4876 | |
4888 | |
4877 | The major version 4 introduced some minor incompatible changes to the API. |
4889 | The major version 4 introduced some incompatible changes to the API. |
4878 | |
4890 | |
4879 | At the moment, the C<ev.h> header file tries to implement superficial |
4891 | At the moment, the C<ev.h> header file provides compatibility definitions |
4880 | compatibility, so most programs should still compile. Those might be |
4892 | for all changes, so most programs should still compile. The compatibility |
4881 | removed in later versions of libev, so better update early than late. |
4893 | layer might be removed in later versions of libev, so better update to the |
|
|
4894 | new API early than late. |
4882 | |
4895 | |
4883 | =over 4 |
4896 | =over 4 |
|
|
4897 | |
|
|
4898 | =item C<EV_COMPAT3> backwards compatibility mechanism |
|
|
4899 | |
|
|
4900 | The backward compatibility mechanism can be controlled by |
|
|
4901 | C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING> |
|
|
4902 | section. |
4884 | |
4903 | |
4885 | =item C<ev_default_destroy> and C<ev_default_fork> have been removed |
4904 | =item C<ev_default_destroy> and C<ev_default_fork> have been removed |
4886 | |
4905 | |
4887 | These calls can be replaced easily by their C<ev_loop_xxx> counterparts: |
4906 | These calls can be replaced easily by their C<ev_loop_xxx> counterparts: |
4888 | |
4907 | |
… | |
… | |
4914 | ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme |
4933 | ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme |
4915 | as all other watcher types. Note that C<ev_loop_fork> is still called |
4934 | as all other watcher types. Note that C<ev_loop_fork> is still called |
4916 | C<ev_loop_fork> because it would otherwise clash with the C<ev_fork> |
4935 | C<ev_loop_fork> because it would otherwise clash with the C<ev_fork> |
4917 | typedef. |
4936 | typedef. |
4918 | |
4937 | |
4919 | =item C<EV_COMPAT3> backwards compatibility mechanism |
|
|
4920 | |
|
|
4921 | The backward compatibility mechanism can be controlled by |
|
|
4922 | C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING> |
|
|
4923 | section. |
|
|
4924 | |
|
|
4925 | =item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES> |
4938 | =item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES> |
4926 | |
4939 | |
4927 | The preprocessor symbol C<EV_MINIMAL> has been replaced by a different |
4940 | The preprocessor symbol C<EV_MINIMAL> has been replaced by a different |
4928 | mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile |
4941 | mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile |
4929 | and work, but the library code will of course be larger. |
4942 | and work, but the library code will of course be larger. |
… | |
… | |
5003 | |
5016 | |
5004 | =back |
5017 | =back |
5005 | |
5018 | |
5006 | =head1 AUTHOR |
5019 | =head1 AUTHOR |
5007 | |
5020 | |
5008 | Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson. |
5021 | Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael |
|
|
5022 | Magnusson and Emanuele Giaquinta. |
5009 | |
5023 | |