… | |
… | |
959 | - Queue all expired timers. |
959 | - Queue all expired timers. |
960 | - Queue all expired periodics. |
960 | - Queue all expired periodics. |
961 | - Queue all idle watchers with priority higher than that of pending events. |
961 | - Queue all idle watchers with priority higher than that of pending events. |
962 | - Queue all check watchers. |
962 | - Queue all check watchers. |
963 | - Call all queued watchers in reverse order (i.e. check watchers first). |
963 | - Call all queued watchers in reverse order (i.e. check watchers first). |
964 | Signals and child watchers are implemented as I/O watchers, and will |
964 | Signals, async and child watchers are implemented as I/O watchers, and |
965 | be handled here by queueing them when their watcher gets executed. |
965 | will be handled here by queueing them when their watcher gets executed. |
966 | - If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT |
966 | - If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT |
967 | were used, or there are no active watchers, goto FINISH, otherwise |
967 | were used, or there are no active watchers, goto FINISH, otherwise |
968 | continue with step LOOP. |
968 | continue with step LOOP. |
969 | FINISH: |
969 | FINISH: |
970 | - Reset the ev_break status iff it was EVBREAK_ONE. |
970 | - Reset the ev_break status iff it was EVBREAK_ONE. |
… | |
… | |
1218 | with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher |
1218 | with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher |
1219 | *) >>), and you can stop watching for events at any time by calling the |
1219 | *) >>), and you can stop watching for events at any time by calling the |
1220 | corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>. |
1220 | corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>. |
1221 | |
1221 | |
1222 | As long as your watcher is active (has been started but not stopped) you |
1222 | As long as your watcher is active (has been started but not stopped) you |
1223 | must not touch the values stored in it. Most specifically you must never |
1223 | must not touch the values stored in it except when explicitly documented |
1224 | reinitialise it or call its C<ev_TYPE_set> macro. |
1224 | otherwise. Most specifically you must never reinitialise it or call its |
|
|
1225 | C<ev_TYPE_set> macro. |
1225 | |
1226 | |
1226 | Each and every callback receives the event loop pointer as first, the |
1227 | Each and every callback receives the event loop pointer as first, the |
1227 | registered watcher structure as second, and a bitset of received events as |
1228 | registered watcher structure as second, and a bitset of received events as |
1228 | third argument. |
1229 | third argument. |
1229 | |
1230 | |
… | |
… | |
1395 | |
1396 | |
1396 | =item bool ev_is_active (ev_TYPE *watcher) |
1397 | =item bool ev_is_active (ev_TYPE *watcher) |
1397 | |
1398 | |
1398 | Returns a true value iff the watcher is active (i.e. it has been started |
1399 | Returns a true value iff the watcher is active (i.e. it has been started |
1399 | and not yet been stopped). As long as a watcher is active you must not modify |
1400 | and not yet been stopped). As long as a watcher is active you must not modify |
1400 | it. |
1401 | it unless documented otherwise. |
1401 | |
1402 | |
1402 | =item bool ev_is_pending (ev_TYPE *watcher) |
1403 | =item bool ev_is_pending (ev_TYPE *watcher) |
1403 | |
1404 | |
1404 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
1405 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
1405 | events but its callback has not yet been invoked). As long as a watcher |
1406 | events but its callback has not yet been invoked). As long as a watcher |
… | |
… | |
1652 | |
1653 | |
1653 | Most members are additionally marked with either I<[read-only]>, meaning |
1654 | Most members are additionally marked with either I<[read-only]>, meaning |
1654 | that, while the watcher is active, you can look at the member and expect |
1655 | that, while the watcher is active, you can look at the member and expect |
1655 | some sensible content, but you must not modify it (you can modify it while |
1656 | some sensible content, but you must not modify it (you can modify it while |
1656 | the watcher is stopped to your hearts content), or I<[read-write]>, which |
1657 | the watcher is stopped to your hearts content), or I<[read-write]>, which |
1657 | means you can expect it to have some sensible content while the watcher |
1658 | means you can expect it to have some sensible content while the watcher is |
1658 | is active, but you can also modify it. Modifying it may not do something |
1659 | active, but you can also modify it (within the same thread as the event |
|
|
1660 | loop, i.e. without creating data races). Modifying it may not do something |
1659 | sensible or take immediate effect (or do anything at all), but libev will |
1661 | sensible or take immediate effect (or do anything at all), but libev will |
1660 | not crash or malfunction in any way. |
1662 | not crash or malfunction in any way. |
1661 | |
1663 | |
1662 | In any case, the documentation for each member will explain what the |
1664 | In any case, the documentation for each member will explain what the |
1663 | effects are, and if there are any additional access restrictions. |
1665 | effects are, and if there are any additional access restrictions. |
… | |
… | |
1828 | =item ev_io_init (ev_io *, callback, int fd, int events) |
1830 | =item ev_io_init (ev_io *, callback, int fd, int events) |
1829 | |
1831 | |
1830 | =item ev_io_set (ev_io *, int fd, int events) |
1832 | =item ev_io_set (ev_io *, int fd, int events) |
1831 | |
1833 | |
1832 | Configures an C<ev_io> watcher. The C<fd> is the file descriptor to |
1834 | Configures an C<ev_io> watcher. The C<fd> is the file descriptor to |
1833 | receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or |
1835 | receive events for and C<events> is either C<EV_READ>, C<EV_WRITE>, both |
1834 | C<EV_READ | EV_WRITE>, to express the desire to receive the given events. |
1836 | C<EV_READ | EV_WRITE> or C<0>, to express the desire to receive the given |
|
|
1837 | events. |
|
|
1838 | |
|
|
1839 | Note that setting the C<events> to C<0> and starting the watcher is |
|
|
1840 | supported, but not specially optimized - if your program sometimes happens |
|
|
1841 | to generate this combination this is fine, but if it is easy to avoid |
|
|
1842 | starting an io watcher watching for no events you should do so. |
1835 | |
1843 | |
1836 | =item ev_io_modify (ev_io *, int events) |
1844 | =item ev_io_modify (ev_io *, int events) |
1837 | |
1845 | |
1838 | Similar to C<ev_io_set>, but only changes the event mask. Using this might |
1846 | Similar to C<ev_io_set>, but only changes the requested events. Using this |
1839 | be faster with some backends, as libev can assume that the C<fd> still |
1847 | might be faster with some backends, as libev can assume that the C<fd> |
1840 | refers to the same underlying file description, something it cannot do |
1848 | still refers to the same underlying file description, something it cannot |
1841 | when using C<ev_io_set>. |
1849 | do when using C<ev_io_set>. |
1842 | |
1850 | |
1843 | =item int fd [no-modify] |
1851 | =item int fd [no-modify] |
1844 | |
1852 | |
1845 | The file descriptor being watched. While it can be read at any time, you |
1853 | The file descriptor being watched. While it can be read at any time, you |
1846 | must not modify this member even when the watcher is stopped - always use |
1854 | must not modify this member even when the watcher is stopped - always use |
1847 | C<ev_io_set> for that. |
1855 | C<ev_io_set> for that. |
1848 | |
1856 | |
1849 | =item int events [no-modify] |
1857 | =item int events [no-modify] |
1850 | |
1858 | |
1851 | The set of events being watched, among other flags. This field is a |
1859 | The set of events the fd is being watched for, among other flags. Remember |
1852 | bit set - to test for C<EV_READ>, use C<< w->events & EV_READ >>, and |
1860 | that this is a bit set - to test for C<EV_READ>, use C<< w->events & |
1853 | similarly for C<EV_WRITE>. |
1861 | EV_READ >>, and similarly for C<EV_WRITE>. |
1854 | |
1862 | |
1855 | As with C<fd>, you must not modify this member even when the watcher is |
1863 | As with C<fd>, you must not modify this member even when the watcher is |
1856 | stopped, always use C<ev_io_set> or C<ev_io_modify> for that. |
1864 | stopped, always use C<ev_io_set> or C<ev_io_modify> for that. |
1857 | |
1865 | |
1858 | =back |
1866 | =back |
… | |
… | |
3854 | event loop thread and an unspecified mechanism to wake up the main thread. |
3862 | event loop thread and an unspecified mechanism to wake up the main thread. |
3855 | |
3863 | |
3856 | First, you need to associate some data with the event loop: |
3864 | First, you need to associate some data with the event loop: |
3857 | |
3865 | |
3858 | typedef struct { |
3866 | typedef struct { |
3859 | mutex_t lock; /* global loop lock */ |
3867 | pthread_mutex_t lock; /* global loop lock */ |
|
|
3868 | pthread_t tid; |
|
|
3869 | pthread_cond_t invoke_cv; |
3860 | ev_async async_w; |
3870 | ev_async async_w; |
3861 | thread_t tid; |
|
|
3862 | cond_t invoke_cv; |
|
|
3863 | } userdata; |
3871 | } userdata; |
3864 | |
3872 | |
3865 | void prepare_loop (EV_P) |
3873 | void prepare_loop (EV_P) |
3866 | { |
3874 | { |
3867 | // for simplicity, we use a static userdata struct. |
3875 | // for simplicity, we use a static userdata struct. |
3868 | static userdata u; |
3876 | static userdata u; |
3869 | |
3877 | |
3870 | ev_async_init (&u->async_w, async_cb); |
3878 | ev_async_init (&u.async_w, async_cb); |
3871 | ev_async_start (EV_A_ &u->async_w); |
3879 | ev_async_start (EV_A_ &u.async_w); |
3872 | |
3880 | |
3873 | pthread_mutex_init (&u->lock, 0); |
3881 | pthread_mutex_init (&u.lock, 0); |
3874 | pthread_cond_init (&u->invoke_cv, 0); |
3882 | pthread_cond_init (&u.invoke_cv, 0); |
3875 | |
3883 | |
3876 | // now associate this with the loop |
3884 | // now associate this with the loop |
3877 | ev_set_userdata (EV_A_ u); |
3885 | ev_set_userdata (EV_A_ &u); |
3878 | ev_set_invoke_pending_cb (EV_A_ l_invoke); |
3886 | ev_set_invoke_pending_cb (EV_A_ l_invoke); |
3879 | ev_set_loop_release_cb (EV_A_ l_release, l_acquire); |
3887 | ev_set_loop_release_cb (EV_A_ l_release, l_acquire); |
3880 | |
3888 | |
3881 | // then create the thread running ev_run |
3889 | // then create the thread running ev_run |
3882 | pthread_create (&u->tid, 0, l_run, EV_A); |
3890 | pthread_create (&u.tid, 0, l_run, EV_A); |
3883 | } |
3891 | } |
3884 | |
3892 | |
3885 | The callback for the C<ev_async> watcher does nothing: the watcher is used |
3893 | The callback for the C<ev_async> watcher does nothing: the watcher is used |
3886 | solely to wake up the event loop so it takes notice of any new watchers |
3894 | solely to wake up the event loop so it takes notice of any new watchers |
3887 | that might have been added: |
3895 | that might have been added: |
… | |
… | |
4258 | gets automatically stopped and restarted when reconfiguring it with this |
4266 | gets automatically stopped and restarted when reconfiguring it with this |
4259 | method. |
4267 | method. |
4260 | |
4268 | |
4261 | For C<ev::embed> watchers this method is called C<set_embed>, to avoid |
4269 | For C<ev::embed> watchers this method is called C<set_embed>, to avoid |
4262 | clashing with the C<set (loop)> method. |
4270 | clashing with the C<set (loop)> method. |
|
|
4271 | |
|
|
4272 | For C<ev::io> watchers there is an additional C<set> method that acepts a |
|
|
4273 | new event mask only, and internally calls C<ev_io_modify>. |
4263 | |
4274 | |
4264 | =item w->start () |
4275 | =item w->start () |
4265 | |
4276 | |
4266 | Starts the watcher. Note that there is no C<loop> argument, as the |
4277 | Starts the watcher. Note that there is no C<loop> argument, as the |
4267 | constructor already stores the event loop. |
4278 | constructor already stores the event loop. |