… | |
… | |
127 | .\} |
127 | .\} |
128 | .rm #[ #] #H #V #F C |
128 | .rm #[ #] #H #V #F C |
129 | .\" ======================================================================== |
129 | .\" ======================================================================== |
130 | .\" |
130 | .\" |
131 | .IX Title ""<STANDARD INPUT>" 1" |
131 | .IX Title ""<STANDARD INPUT>" 1" |
132 | .TH "<STANDARD INPUT>" 1 "2007-12-07" "perl v5.8.8" "User Contributed Perl Documentation" |
132 | .TH "<STANDARD INPUT>" 1 "2007-12-08" "perl v5.8.8" "User Contributed Perl Documentation" |
133 | .SH "NAME" |
133 | .SH "NAME" |
134 | libev \- a high performance full\-featured event loop written in C |
134 | libev \- a high performance full\-featured event loop written in C |
135 | .SH "SYNOPSIS" |
135 | .SH "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
137 | .Vb 1 |
137 | .Vb 1 |
… | |
… | |
889 | .IP "bool ev_is_pending (ev_TYPE *watcher)" 4 |
889 | .IP "bool ev_is_pending (ev_TYPE *watcher)" 4 |
890 | .IX Item "bool ev_is_pending (ev_TYPE *watcher)" |
890 | .IX Item "bool ev_is_pending (ev_TYPE *watcher)" |
891 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
891 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
892 | events but its callback has not yet been invoked). As long as a watcher |
892 | events but its callback has not yet been invoked). As long as a watcher |
893 | is pending (but not active) you must not call an init function on it (but |
893 | is pending (but not active) you must not call an init function on it (but |
894 | \&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe) and you must make sure the watcher is available to |
894 | \&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe), you must not change its priority, and you must |
895 | libev (e.g. you cnanot \f(CW\*(C`free ()\*(C'\fR it). |
895 | make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR |
|
|
896 | it). |
896 | .IP "callback ev_cb (ev_TYPE *watcher)" 4 |
897 | .IP "callback ev_cb (ev_TYPE *watcher)" 4 |
897 | .IX Item "callback ev_cb (ev_TYPE *watcher)" |
898 | .IX Item "callback ev_cb (ev_TYPE *watcher)" |
898 | Returns the callback currently set on the watcher. |
899 | Returns the callback currently set on the watcher. |
899 | .IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 |
900 | .IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 |
900 | .IX Item "ev_cb_set (ev_TYPE *watcher, callback)" |
901 | .IX Item "ev_cb_set (ev_TYPE *watcher, callback)" |
… | |
… | |
918 | watchers on the same event and make sure one is called first. |
919 | watchers on the same event and make sure one is called first. |
919 | .Sp |
920 | .Sp |
920 | If you need to suppress invocation when higher priority events are pending |
921 | If you need to suppress invocation when higher priority events are pending |
921 | you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality. |
922 | you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality. |
922 | .Sp |
923 | .Sp |
|
|
924 | You \fImust not\fR change the priority of a watcher as long as it is active or |
|
|
925 | pending. |
|
|
926 | .Sp |
923 | The default priority used by watchers when no priority has been set is |
927 | The default priority used by watchers when no priority has been set is |
924 | always \f(CW0\fR, which is supposed to not be too high and not be too low :). |
928 | always \f(CW0\fR, which is supposed to not be too high and not be too low :). |
925 | .Sp |
929 | .Sp |
926 | Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is |
930 | Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is |
927 | fine, as long as you do not mind that the priority value you query might |
931 | fine, as long as you do not mind that the priority value you query might |
928 | or might not have been adjusted to be within valid range. |
932 | or might not have been adjusted to be within valid range. |
|
|
933 | .IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4 |
|
|
934 | .IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)" |
|
|
935 | Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither |
|
|
936 | \&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback |
|
|
937 | can deal with that fact. |
|
|
938 | .IP "int ev_clear_pending (loop, ev_TYPE *watcher)" 4 |
|
|
939 | .IX Item "int ev_clear_pending (loop, ev_TYPE *watcher)" |
|
|
940 | If the watcher is pending, this function returns clears its pending status |
|
|
941 | and returns its \f(CW\*(C`revents\*(C'\fR bitset (as if its callback was invoked). If the |
|
|
942 | watcher isn't pending it does nothing and returns \f(CW0\fR. |
929 | .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" |
943 | .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" |
930 | .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" |
944 | .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" |
931 | Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change |
945 | Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change |
932 | and read at any time, libev will completely ignore it. This can be used |
946 | and read at any time, libev will completely ignore it. This can be used |
933 | to associate arbitrary data with your watcher. If you need more data and |
947 | to associate arbitrary data with your watcher. If you need more data and |
… | |
… | |
1978 | .Vb 3 |
1992 | .Vb 3 |
1979 | \& myclass obj; |
1993 | \& myclass obj; |
1980 | \& ev::io iow; |
1994 | \& ev::io iow; |
1981 | \& iow.set <myclass, &myclass::io_cb> (&obj); |
1995 | \& iow.set <myclass, &myclass::io_cb> (&obj); |
1982 | .Ve |
1996 | .Ve |
1983 | .IP "w\->set (void (*function)(watcher &w, int), void *data = 0)" 4 |
1997 | .IP "w\->set<function> (void *data = 0)" 4 |
1984 | .IX Item "w->set (void (*function)(watcher &w, int), void *data = 0)" |
1998 | .IX Item "w->set<function> (void *data = 0)" |
1985 | Also sets a callback, but uses a static method or plain function as |
1999 | Also sets a callback, but uses a static method or plain function as |
1986 | callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's |
2000 | callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's |
1987 | \&\f(CW\*(C`data\*(C'\fR member and is free for you to use. |
2001 | \&\f(CW\*(C`data\*(C'\fR member and is free for you to use. |
1988 | .Sp |
2002 | .Sp |
|
|
2003 | The prototype of the \f(CW\*(C`function\*(C'\fR must be \f(CW\*(C`void (*)(ev::TYPE &w, int)\*(C'\fR. |
|
|
2004 | .Sp |
1989 | See the method\-\f(CW\*(C`set\*(C'\fR above for more details. |
2005 | See the method\-\f(CW\*(C`set\*(C'\fR above for more details. |
|
|
2006 | .Sp |
|
|
2007 | Example: |
|
|
2008 | .Sp |
|
|
2009 | .Vb 2 |
|
|
2010 | \& static void io_cb (ev::io &w, int revents) { } |
|
|
2011 | \& iow.set <io_cb> (); |
|
|
2012 | .Ve |
1990 | .IP "w\->set (struct ev_loop *)" 4 |
2013 | .IP "w\->set (struct ev_loop *)" 4 |
1991 | .IX Item "w->set (struct ev_loop *)" |
2014 | .IX Item "w->set (struct ev_loop *)" |
1992 | Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only |
2015 | Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only |
1993 | do this when the watcher is inactive (and not pending either). |
2016 | do this when the watcher is inactive (and not pending either). |
1994 | .IP "w\->set ([args])" 4 |
2017 | .IP "w\->set ([args])" 4 |