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.462 by root, Wed Jan 22 13:06:53 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
… …
1828=item ev_io_init (ev_io *, callback, int fd, int events) 1829=item ev_io_init (ev_io *, callback, int fd, int events)
1829 1830
1830=item ev_io_set (ev_io *, int fd, int events) 1831=item ev_io_set (ev_io *, int fd, int events)
1831 1832
1832Configures an C<ev_io> watcher. The C<fd> is the file descriptor to 1833Configures 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 1834receive 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. 1835C<EV_READ | EV_WRITE> or C<0>, to express the desire to receive the given
1836events.
1837
1838Note that setting the C<events> to C<0> and starting the watcher is
1839supported, but not specially optimized - if your program sometimes happens
1840to generate this combination this is fine, but if it is easy to avoid
1841starting an io watcher watching for no events you should do so.
1835 1842
1836=item ev_io_modify (ev_io *, int events) 1843=item ev_io_modify (ev_io *, int events)
1837 1844
1838Similar to C<ev_io_set>, but only changes the event mask. Using this might 1845Similar to C<ev_io_set>, but only changes the event mask. Using this might
1839be faster with some backends, as libev can assume that the C<fd> still 1846be faster with some backends, as libev can assume that the C<fd> still
… …
1846must not modify this member even when the watcher is stopped - always use 1853must not modify this member even when the watcher is stopped - always use
1847C<ev_io_set> for that. 1854C<ev_io_set> for that.
1848 1855
1849=item int events [no-modify] 1856=item int events [no-modify]
1850 1857
1851The set of events being watched, among other flags. This field is a 1858The 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 1859that this is a bit set - to test for C<EV_READ>, use C<< w->events &
1853similarly for C<EV_WRITE>. 1860EV_READ >>, and similarly for C<EV_WRITE>.
1854 1861
1855As with C<fd>, you must not modify this member even when the watcher is 1862As 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. 1863stopped, always use C<ev_io_set> or C<ev_io_modify> for that.
1857 1864
1858=back 1865=back
… …
4259method. 4266method.
4260 4267
4261For C<ev::embed> watchers this method is called C<set_embed>, to avoid 4268For C<ev::embed> watchers this method is called C<set_embed>, to avoid
4262clashing with the C<set (loop)> method. 4269clashing with the C<set (loop)> method.
4263 4270
4271For C<ev::io> watchers there is an additional C<set> method that acepts a
4272new event mask only, and internally calls C<ev_io_modfify>.
4273
4264=item w->start () 4274=item w->start ()
4265 4275
4266Starts the watcher. Note that there is no C<loop> argument, as the 4276Starts the watcher. Note that there is no C<loop> argument, as the
4267constructor already stores the event loop. 4277constructor already stores the event loop.
4268 4278

Diff Legend

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