diff options
| -rw-r--r-- | ev.3 | 87 | ||||
| -rw-r--r-- | ev.html | 76 | ||||
| -rw-r--r-- | ev.pod | 79 |
3 files changed, 153 insertions, 89 deletions
@@ -214,7 +214,7 @@ recommended for this platform. This set is often smaller than the one returned by \f(CW\*(C`ev_supported_backends\*(C'\fR, as for example kqueue is broken on most BSDs and will not be autodetected unless you explicitly request it (assuming you know what you are doing). This is the set of backends that -\&\f(CW\*(C`EVFLAG_AUTO\*(C'\fR will probe for. +libev will probe for if you specify no backends explicitly. .IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4 .IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" Sets the allocation function to use (the prototype is similar to the @@ -258,9 +258,9 @@ If you don't know what event loop to use, use the one returned from this function. .Sp The flags argument can be used to specify special behaviour or specific -backends to use, and is usually specified as \f(CW0\fR (or \s-1EVFLAG_AUTO\s0). +backends to use, and is usually specified as \f(CW0\fR (or \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). .Sp -It supports the following flags: +The following flags are supported: .RS 4 .ie n .IP """EVFLAG_AUTO""" 4 .el .IP "\f(CWEVFLAG_AUTO\fR" 4 @@ -314,8 +314,9 @@ need to use non-blocking I/O or other means to avoid blocking when no data Kqueue deserves special mention, as at the time of this writing, it was broken on all BSDs except NetBSD (usually it doesn't work with anything but sockets and pipes, except on Darwin, where of course its -completely useless). For this reason its not being \*(L"autodetected\*(R" unless -you explicitly specify the flags (i.e. you don't use \s-1EVFLAG_AUTO\s0). +completely useless). For this reason its not being \*(L"autodetected\*(R" +unless you explicitly specify it explicitly in the flags (i.e. using +\&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR). .Sp It scales in the same way as the epoll backend, but the interface to the kernel is more efficient (which says nothing about its actual speed, of @@ -348,6 +349,28 @@ If one or more of these are ored into the flags value, then only these backends will be tried (in the reverse order as given here). If none are specified, most compiled-in backend will be tried, usually in reverse order of their flag values :) +.Sp +The most typical usage is like this: +.Sp +.Vb 2 +\& if (!ev_default_loop (0)) +\& fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); +.Ve +.Sp +Restrict libev to the select and poll backends, and do not allow +environment settings to be taken into account: +.Sp +.Vb 1 +\& ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV); +.Ve +.Sp +Use whatever libev has to offer, but make sure that kqueue is used if +available (warning, breaks stuff, best use only with your own private +event loop and only if you know the \s-1OS\s0 supports your types of fds): +.Sp +.Vb 1 +\& ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); +.Ve .RE .IP "struct ev_loop *ev_loop_new (unsigned int flags)" 4 .IX Item "struct ev_loop *ev_loop_new (unsigned int flags)" @@ -408,8 +431,8 @@ Finally, this is it, the event handler. This function usually is called after you initialised all your watchers and you want to start handling events. .Sp -If the flags argument is specified as 0, it will not return until either -no event watchers are active anymore or \f(CW\*(C`ev_unloop\*(C'\fR was called. +If the flags argument is specified as \f(CW0\fR, it will not return until +either no event watchers are active anymore or \f(CW\*(C`ev_unloop\*(C'\fR was called. .Sp A flags value of \f(CW\*(C`EVLOOP_NONBLOCK\*(C'\fR will look for new events, will handle those events and any outstanding ones, but will not block your process in @@ -418,30 +441,32 @@ case there are no events and will return after one iteration of the loop. A flags value of \f(CW\*(C`EVLOOP_ONESHOT\*(C'\fR will look for new events (waiting if neccessary) and will handle those and any outstanding ones. It will block your process until at least one new event arrives, and will return after -one iteration of the loop. -.Sp -This flags value could be used to implement alternative looping -constructs, but the \f(CW\*(C`prepare\*(C'\fR and \f(CW\*(C`check\*(C'\fR watchers provide a better and -more generic mechanism. -.Sp -Here are the gory details of what ev_loop does: -.Sp -.Vb 15 -\& 1. If there are no active watchers (reference count is zero), return. -\& 2. Queue and immediately call all prepare watchers. -\& 3. If we have been forked, recreate the kernel state. -\& 4. Update the kernel state with all outstanding changes. -\& 5. Update the "event loop time". -\& 6. Calculate for how long to block. -\& 7. Block the process, waiting for events. -\& 8. Update the "event loop time" and do time jump handling. -\& 9. Queue all outstanding timers. -\& 10. Queue all outstanding periodics. -\& 11. If no events are pending now, queue all idle watchers. -\& 12. Queue all check watchers. -\& 13. Call all queued watchers in reverse order (i.e. check watchers first). -\& 14. If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK -\& was used, return, otherwise continue with step #1. +one iteration of the loop. This is useful if you are waiting for some +external event in conjunction with something not expressible using other +libev watchers. However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is +usually a better approach for this kind of thing. +.Sp +Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does: +.Sp +.Vb 18 +\& * If there are no active watchers (reference count is zero), return. +\& - Queue prepare watchers and then call all outstanding watchers. +\& - If we have been forked, recreate the kernel state. +\& - Update the kernel state with all outstanding changes. +\& - Update the "event loop time". +\& - Calculate for how long to block. +\& - Block the process, waiting for any events. +\& - Queue all outstanding I/O (fd) events. +\& - Update the "event loop time" and do time jump handling. +\& - Queue all outstanding timers. +\& - Queue all outstanding periodics. +\& - If no events are pending now, queue all idle watchers. +\& - Queue all check watchers. +\& - Call all queued watchers in reverse order (i.e. check watchers first). +\& Signals and child watchers are implemented as I/O watchers, and will +\& be handled here by queueing them when their watcher gets executed. +\& - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK +\& were used, return, otherwise continue with step *. .Ve .IP "ev_unloop (loop, how)" 4 .IX Item "ev_unloop (loop, how)" @@ -6,7 +6,7 @@ <meta name="description" content="Pod documentation for libev" /> <meta name="inputfile" content="<standard input>" /> <meta name="outputfile" content="<standard output>" /> - <meta name="created" content="Fri Nov 23 09:26:40 2007" /> + <meta name="created" content="Fri Nov 23 16:26:06 2007" /> <meta name="generator" content="Pod::Xhtml 1.57" /> <link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head> <body> @@ -139,7 +139,7 @@ recommended for this platform. This set is often smaller than the one returned by <code>ev_supported_backends</code>, as for example kqueue is broken on most BSDs and will not be autodetected unless you explicitly request it (assuming you know what you are doing). This is the set of backends that -<code>EVFLAG_AUTO</code> will probe for.</p> +libev will probe for if you specify no backends explicitly.</p> </dd> <dt>ev_set_allocator (void *(*cb)(void *ptr, long size))</dt> <dd> @@ -186,8 +186,8 @@ flags. If that is troubling you, check <code>ev_backend ()</code> afterwards).</ <p>If you don't know what event loop to use, use the one returned from this function.</p> <p>The flags argument can be used to specify special behaviour or specific -backends to use, and is usually specified as <code>0</code> (or EVFLAG_AUTO).</p> - <p>It supports the following flags:</p> +backends to use, and is usually specified as <code>0</code> (or <code>EVFLAG_AUTO</code>).</p> + <p>The following flags are supported:</p> <p> <dl> <dt><code>EVFLAG_AUTO</code></dt> @@ -239,8 +239,9 @@ need to use non-blocking I/O or other means to avoid blocking when no data <p>Kqueue deserves special mention, as at the time of this writing, it was broken on all BSDs except NetBSD (usually it doesn't work with anything but sockets and pipes, except on Darwin, where of course its -completely useless). For this reason its not being "autodetected" unless -you explicitly specify the flags (i.e. you don't use EVFLAG_AUTO).</p> +completely useless). For this reason its not being "autodetected" +unless you explicitly specify it explicitly in the flags (i.e. using +<code>EVBACKEND_KQUEUE</code>).</p> <p>It scales in the same way as the epoll backend, but the interface to the kernel is more efficient (which says nothing about its actual speed, of course). While starting and stopping an I/O watcher does not cause an @@ -271,6 +272,22 @@ with <code>EVFLAG_AUTO</code>). Since this is a mask, you can do stuff such as backends will be tried (in the reverse order as given here). If none are specified, most compiled-in backend will be tried, usually in reverse order of their flag values :)</p> + <p>The most typical usage is like this:</p> +<pre> if (!ev_default_loop (0)) + fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); + +</pre> + <p>Restrict libev to the select and poll backends, and do not allow +environment settings to be taken into account:</p> +<pre> ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV); + +</pre> + <p>Use whatever libev has to offer, but make sure that kqueue is used if +available (warning, breaks stuff, best use only with your own private +event loop and only if you know the OS supports your types of fds):</p> +<pre> ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); + +</pre> </dd> <dt>struct ev_loop *ev_loop_new (unsigned int flags)</dt> <dd> @@ -333,34 +350,37 @@ occuring (or more correctly, the mainloop finding out about it).</p> <p>Finally, this is it, the event handler. This function usually is called after you initialised all your watchers and you want to start handling events.</p> - <p>If the flags argument is specified as 0, it will not return until either -no event watchers are active anymore or <code>ev_unloop</code> was called.</p> + <p>If the flags argument is specified as <code>0</code>, it will not return until +either no event watchers are active anymore or <code>ev_unloop</code> was called.</p> <p>A flags value of <code>EVLOOP_NONBLOCK</code> will look for new events, will handle those events and any outstanding ones, but will not block your process in case there are no events and will return after one iteration of the loop.</p> <p>A flags value of <code>EVLOOP_ONESHOT</code> will look for new events (waiting if neccessary) and will handle those and any outstanding ones. It will block your process until at least one new event arrives, and will return after -one iteration of the loop.</p> - <p>This flags value could be used to implement alternative looping -constructs, but the <code>prepare</code> and <code>check</code> watchers provide a better and -more generic mechanism.</p> - <p>Here are the gory details of what ev_loop does:</p> -<pre> 1. If there are no active watchers (reference count is zero), return. - 2. Queue and immediately call all prepare watchers. - 3. If we have been forked, recreate the kernel state. - 4. Update the kernel state with all outstanding changes. - 5. Update the "event loop time". - 6. Calculate for how long to block. - 7. Block the process, waiting for events. - 8. Update the "event loop time" and do time jump handling. - 9. Queue all outstanding timers. - 10. Queue all outstanding periodics. - 11. If no events are pending now, queue all idle watchers. - 12. Queue all check watchers. - 13. Call all queued watchers in reverse order (i.e. check watchers first). - 14. If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK - was used, return, otherwise continue with step #1. +one iteration of the loop. This is useful if you are waiting for some +external event in conjunction with something not expressible using other +libev watchers. However, a pair of <code>ev_prepare</code>/<code>ev_check</code> watchers is +usually a better approach for this kind of thing.</p> + <p>Here are the gory details of what <code>ev_loop</code> does:</p> +<pre> * If there are no active watchers (reference count is zero), return. + - Queue prepare watchers and then call all outstanding watchers. + - If we have been forked, recreate the kernel state. + - Update the kernel state with all outstanding changes. + - Update the "event loop time". + - Calculate for how long to block. + - Block the process, waiting for any events. + - Queue all outstanding I/O (fd) events. + - Update the "event loop time" and do time jump handling. + - Queue all outstanding timers. + - Queue all outstanding periodics. + - If no events are pending now, queue all idle watchers. + - Queue all check watchers. + - Call all queued watchers in reverse order (i.e. check watchers first). + Signals and child watchers are implemented as I/O watchers, and will + be handled here by queueing them when their watcher gets executed. + - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK + were used, return, otherwise continue with step *. </pre> </dd> @@ -91,7 +91,7 @@ recommended for this platform. This set is often smaller than the one returned by C<ev_supported_backends>, as for example kqueue is broken on most BSDs and will not be autodetected unless you explicitly request it (assuming you know what you are doing). This is the set of backends that -C<EVFLAG_AUTO> will probe for. +libev will probe for if you specify no backends explicitly. =item ev_set_allocator (void *(*cb)(void *ptr, long size)) @@ -143,9 +143,9 @@ If you don't know what event loop to use, use the one returned from this function. The flags argument can be used to specify special behaviour or specific -backends to use, and is usually specified as C<0> (or EVFLAG_AUTO). +backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>). -It supports the following flags: +The following flags are supported: =over 4 @@ -200,8 +200,9 @@ need to use non-blocking I/O or other means to avoid blocking when no data Kqueue deserves special mention, as at the time of this writing, it was broken on all BSDs except NetBSD (usually it doesn't work with anything but sockets and pipes, except on Darwin, where of course its -completely useless). For this reason its not being "autodetected" unless -you explicitly specify the flags (i.e. you don't use EVFLAG_AUTO). +completely useless). For this reason its not being "autodetected" +unless you explicitly specify it explicitly in the flags (i.e. using +C<EVBACKEND_KQUEUE>). It scales in the same way as the epoll backend, but the interface to the kernel is more efficient (which says nothing about its actual speed, of @@ -235,6 +236,22 @@ backends will be tried (in the reverse order as given here). If none are specified, most compiled-in backend will be tried, usually in reverse order of their flag values :) +The most typical usage is like this: + + if (!ev_default_loop (0)) + fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); + +Restrict libev to the select and poll backends, and do not allow +environment settings to be taken into account: + + ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV); + +Use whatever libev has to offer, but make sure that kqueue is used if +available (warning, breaks stuff, best use only with your own private +event loop and only if you know the OS supports your types of fds): + + ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); + =item struct ev_loop *ev_loop_new (unsigned int flags) Similar to C<ev_default_loop>, but always creates a new event loop that is @@ -299,8 +316,8 @@ Finally, this is it, the event handler. This function usually is called after you initialised all your watchers and you want to start handling events. -If the flags argument is specified as 0, it will not return until either -no event watchers are active anymore or C<ev_unloop> was called. +If the flags argument is specified as C<0>, it will not return until +either no event watchers are active anymore or C<ev_unloop> was called. A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle those events and any outstanding ones, but will not block your process in @@ -309,29 +326,31 @@ case there are no events and will return after one iteration of the loop. A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if neccessary) and will handle those and any outstanding ones. It will block your process until at least one new event arrives, and will return after -one iteration of the loop. - -This flags value could be used to implement alternative looping -constructs, but the C<prepare> and C<check> watchers provide a better and -more generic mechanism. - -Here are the gory details of what ev_loop does: - - 1. If there are no active watchers (reference count is zero), return. - 2. Queue and immediately call all prepare watchers. - 3. If we have been forked, recreate the kernel state. - 4. Update the kernel state with all outstanding changes. - 5. Update the "event loop time". - 6. Calculate for how long to block. - 7. Block the process, waiting for events. - 8. Update the "event loop time" and do time jump handling. - 9. Queue all outstanding timers. - 10. Queue all outstanding periodics. - 11. If no events are pending now, queue all idle watchers. - 12. Queue all check watchers. - 13. Call all queued watchers in reverse order (i.e. check watchers first). - 14. If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK - was used, return, otherwise continue with step #1. +one iteration of the loop. This is useful if you are waiting for some +external event in conjunction with something not expressible using other +libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is +usually a better approach for this kind of thing. + +Here are the gory details of what C<ev_loop> does: + + * If there are no active watchers (reference count is zero), return. + - Queue prepare watchers and then call all outstanding watchers. + - If we have been forked, recreate the kernel state. + - Update the kernel state with all outstanding changes. + - Update the "event loop time". + - Calculate for how long to block. + - Block the process, waiting for any events. + - Queue all outstanding I/O (fd) events. + - Update the "event loop time" and do time jump handling. + - Queue all outstanding timers. + - Queue all outstanding periodics. + - If no events are pending now, queue all idle watchers. + - Queue all check watchers. + - Call all queued watchers in reverse order (i.e. check watchers first). + Signals and child watchers are implemented as I/O watchers, and will + be handled here by queueing them when their watcher gets executed. + - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK + were used, return, otherwise continue with step *. =item ev_unloop (loop, how) |