… | |
… | |
823 | Can be used to make a call to C<ev_run> return early (but only after it |
823 | Can be used to make a call to C<ev_run> return early (but only after it |
824 | has processed all outstanding events). The C<how> argument must be either |
824 | has processed all outstanding events). The C<how> argument must be either |
825 | C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or |
825 | C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or |
826 | C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return. |
826 | C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return. |
827 | |
827 | |
828 | This "unloop state" will be cleared when entering C<ev_run> again. |
828 | This "break state" will be cleared when entering C<ev_run> again. |
829 | |
829 | |
830 | It is safe to call C<ev_break> from outside any C<ev_run> calls. ##TODO## |
830 | It is safe to call C<ev_break> from outside any C<ev_run> calls, too. |
831 | |
831 | |
832 | =item ev_ref (loop) |
832 | =item ev_ref (loop) |
833 | |
833 | |
834 | =item ev_unref (loop) |
834 | =item ev_unref (loop) |
835 | |
835 | |
… | |
… | |
1154 | 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 |
1155 | thing, so beware. |
1155 | thing, so beware. |
1156 | |
1156 | |
1157 | =back |
1157 | =back |
1158 | |
1158 | |
1159 | =head2 WATCHER STATES |
|
|
1160 | |
|
|
1161 | There are various watcher states mentioned throughout this manual - |
|
|
1162 | active, pending and so on. In this section these states and the rules to |
|
|
1163 | transition between them will be described in more detail - and while these |
|
|
1164 | rules might look complicated, they usually do "the right thing". |
|
|
1165 | |
|
|
1166 | =over 4 |
|
|
1167 | |
|
|
1168 | =item initialiased |
|
|
1169 | |
|
|
1170 | Before a watcher can be registered with the event looop it has to be |
|
|
1171 | initialised. This can be done with a call to C<ev_TYPE_init>, or calls to |
|
|
1172 | C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. |
|
|
1173 | |
|
|
1174 | In this state it is simply some block of memory that is suitable for use |
|
|
1175 | in an event loop. It can be moved around, freed, reused etc. at will. |
|
|
1176 | |
|
|
1177 | =item started/running/active |
|
|
1178 | |
|
|
1179 | Once a watcher has been started with a call to C<ev_TYPE_start> it becomes |
|
|
1180 | property of the event loop, and is actively waiting for events. While in |
|
|
1181 | this state it cannot be accessed (except in a few documented ways), moved, |
|
|
1182 | freed or anything else - the only legal thing is to keep a pointer to it, |
|
|
1183 | and call libev functions on it that are documented to work on active watchers. |
|
|
1184 | |
|
|
1185 | =item pending |
|
|
1186 | |
|
|
1187 | If a watcher is active and libev determines that an event it is interested |
|
|
1188 | in has occurred (such as a timer expiring), it will become pending. It will |
|
|
1189 | stay in this pending state until either it is stopped or its callback is |
|
|
1190 | about to be invoked, so it is not normally pending inside the watcher |
|
|
1191 | callback. |
|
|
1192 | |
|
|
1193 | The watcher might or might not be active while it is pending (for example, |
|
|
1194 | an expired non-repeating timer can be pending but no longer active). If it |
|
|
1195 | is stopped, it can be freely accessed (e.g. by calling C<ev_TYPE_set>), |
|
|
1196 | but it is still property of the event loop at this time, so cannot be |
|
|
1197 | moved, freed or reused. And if it is active the rules described in the |
|
|
1198 | previous item still apply. |
|
|
1199 | |
|
|
1200 | It is also possible to feed an event on a watcher that is not active (e.g. |
|
|
1201 | via C<ev_feed_event>), in which case it becomes pending without being |
|
|
1202 | active. |
|
|
1203 | |
|
|
1204 | =item stopped |
|
|
1205 | |
|
|
1206 | A watcher can be stopped implicitly by libev (in which case it might still |
|
|
1207 | be pending), or explicitly by calling its C<ev_TYPE_stop> function. The |
|
|
1208 | latter will clear any pending state the watcher might be in, regardless |
|
|
1209 | of whether it was active or not, so stopping a watcher explicitly before |
|
|
1210 | freeing it is often a good idea. |
|
|
1211 | |
|
|
1212 | While stopped (and not pending) the watcher is essentially in the |
|
|
1213 | initialised state, that is it can be reused, moved, modified in any way |
|
|
1214 | you wish. |
|
|
1215 | |
|
|
1216 | =back |
|
|
1217 | |
|
|
1218 | =head2 GENERIC WATCHER FUNCTIONS |
1159 | =head2 GENERIC WATCHER FUNCTIONS |
1219 | |
1160 | |
1220 | =over 4 |
1161 | =over 4 |
1221 | |
1162 | |
1222 | =item C<ev_init> (ev_TYPE *watcher, callback) |
1163 | =item C<ev_init> (ev_TYPE *watcher, callback) |
… | |
… | |
1363 | |
1304 | |
1364 | 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 |
1365 | functions that do not need a watcher. |
1306 | functions that do not need a watcher. |
1366 | |
1307 | |
1367 | =back |
1308 | =back |
1368 | |
|
|
1369 | |
1309 | |
1370 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
1310 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
1371 | |
1311 | |
1372 | 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 |
1373 | 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 |
… | |
… | |
1429 | t2_cb (EV_P_ ev_timer *w, int revents) |
1369 | t2_cb (EV_P_ ev_timer *w, int revents) |
1430 | { |
1370 | { |
1431 | struct my_biggy big = (struct my_biggy *) |
1371 | struct my_biggy big = (struct my_biggy *) |
1432 | (((char *)w) - offsetof (struct my_biggy, t2)); |
1372 | (((char *)w) - offsetof (struct my_biggy, t2)); |
1433 | } |
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 |
1434 | |
1433 | |
1435 | =head2 WATCHER PRIORITY MODELS |
1434 | =head2 WATCHER PRIORITY MODELS |
1436 | |
1435 | |
1437 | Many event loops support I<watcher priorities>, which are usually small |
1436 | Many event loops support I<watcher priorities>, which are usually small |
1438 | integers that influence the ordering of event callback invocation |
1437 | integers that influence the ordering of event callback invocation |