ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.pod
(Generate patch)

Comparing libev/ev.pod (file contents):
Revision 1.459 by root, Wed Jan 22 01:50:42 2020 UTC vs.
Revision 1.464 by root, Sun Jan 26 06:04:20 2020 UTC

… …
1218with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher 1218with 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
1220corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>. 1220corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>.
1221 1221
1222As long as your watcher is active (has been started but not stopped) you 1222As long as your watcher is active (has been started but not stopped) you
1223must not touch the values stored in it. Most specifically you must never 1223must not touch the values stored in it except when explicitly documented
1224reinitialise it or call its C<ev_TYPE_set> macro. 1224otherwise. Most specifically you must never reinitialise it or call its
1225C<ev_TYPE_set> macro.
1225 1226
1226Each and every callback receives the event loop pointer as first, the 1227Each and every callback receives the event loop pointer as first, the
1227registered watcher structure as second, and a bitset of received events as 1228registered watcher structure as second, and a bitset of received events as
1228third argument. 1229third argument.
1229 1230
… …
1652 1653
1653Most members are additionally marked with either I<[read-only]>, meaning 1654Most members are additionally marked with either I<[read-only]>, meaning
1654that, while the watcher is active, you can look at the member and expect 1655that, while the watcher is active, you can look at the member and expect
1655some sensible content, but you must not modify it (you can modify it while 1656some sensible content, but you must not modify it (you can modify it while
1656the watcher is stopped to your hearts content), or I<[read-write]>, which 1657the watcher is stopped to your hearts content), or I<[read-write]>, which
1657means you can expect it to have some sensible content while the watcher 1658means you can expect it to have some sensible content while the watcher is
1658is active, but you can also modify it. Modifying it may not do something 1659active, but you can also modify it (within the same thread as the event
1660loop, i.e. without creating data races). Modifying it may not do something
1659sensible or take immediate effect (or do anything at all), but libev will 1661sensible or take immediate effect (or do anything at all), but libev will
1660not crash or malfunction in any way. 1662not crash or malfunction in any way.
1661 1663
1662In any case, the documentation for each member will explain what the 1664In any case, the documentation for each member will explain what the
1663effects are, and if there are any additional access restrictions. 1665effects 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
1832Configures an C<ev_io> watcher. The C<fd> is the file descriptor to 1834Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
1833receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or 1835receive events for and C<events> is either C<EV_READ>, C<EV_WRITE>, both
1834C<EV_READ | EV_WRITE>, to express the desire to receive the given events. 1836C<EV_READ | EV_WRITE> or C<0>, to express the desire to receive the given
1837events.
1838
1839Note that setting the C<events> to C<0> and starting the watcher is
1840supported, but not specially optimized - if your program sometimes happens
1841to generate this combination this is fine, but if it is easy to avoid
1842starting 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
1838Similar to C<ev_io_set>, but only changes the event mask. Using this might 1846Similar to C<ev_io_set>, but only changes the requested events. Using this
1839be faster with some backends, as libev can assume that the C<fd> still 1847might be faster with some backends, as libev can assume that the C<fd>
1840refers to the same underlying file description, something it cannot do 1848still refers to the same underlying file description, something it cannot
1841when using C<ev_io_set>. 1849do when using C<ev_io_set>.
1842 1850
1843=item int fd [no-modify] 1851=item int fd [no-modify]
1844 1852
1845The file descriptor being watched. While it can be read at any time, you 1853The file descriptor being watched. While it can be read at any time, you
1846must not modify this member even when the watcher is stopped - always use 1854must not modify this member even when the watcher is stopped - always use
1847C<ev_io_set> for that. 1855C<ev_io_set> for that.
1848 1856
1849=item int events [no-modify] 1857=item int events [no-modify]
1850 1858
1851The set of events being watched, among other flags. This field is a 1859The set of events the fd is being watched for, among other flags. Remember
1852bit set - to test for C<EV_READ>, use C<< w->events & EV_READ >>, and 1860that this is a bit set - to test for C<EV_READ>, use C<< w->events &
1853similarly for C<EV_WRITE>. 1861EV_READ >>, and similarly for C<EV_WRITE>.
1854 1862
1855As with C<fd>, you must not modify this member even when the watcher is 1863As with C<fd>, you must not modify this member even when the watcher is
1856stopped, always use C<ev_io_set> or C<ev_io_modify> for that. 1864stopped, always use C<ev_io_set> or C<ev_io_modify> for that.
1857 1865
1858=back 1866=back
… …
4259method. 4267method.
4260 4268
4261For C<ev::embed> watchers this method is called C<set_embed>, to avoid 4269For C<ev::embed> watchers this method is called C<set_embed>, to avoid
4262clashing with the C<set (loop)> method. 4270clashing with the C<set (loop)> method.
4263 4271
4272For C<ev::io> watchers there is an additional C<set> method that acepts a
4273new event mask only, and internally calls C<ev_io_modfify>.
4274
4264=item w->start () 4275=item w->start ()
4265 4276
4266Starts the watcher. Note that there is no C<loop> argument, as the 4277Starts the watcher. Note that there is no C<loop> argument, as the
4267constructor already stores the event loop. 4278constructor already stores the event loop.
4268 4279

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines