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

Comparing libev/ev.pod (file contents):
Revision 1.218 by root, Thu Nov 20 00:35:10 2008 UTC vs.
Revision 1.222 by root, Sun Dec 7 15:43:43 2008 UTC

… …
43 43
44 int 44 int
45 main (void) 45 main (void)
46 { 46 {
47 // use the default event loop unless you have special needs 47 // use the default event loop unless you have special needs
48 ev_loop *loop = ev_default_loop (0); 48 struct ev_loop *loop = ev_default_loop (0);
49 49
50 // initialise an io watcher, then start it 50 // initialise an io watcher, then start it
51 // this one will watch for stdin to become readable 51 // this one will watch for stdin to become readable
52 ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); 52 ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
53 ev_io_start (loop, &stdin_watcher); 53 ev_io_start (loop, &stdin_watcher);
… …
2012the process. The exception are C<ev_stat> watchers - those call C<stat 2012the process. The exception are C<ev_stat> watchers - those call C<stat
2013()>, which is a synchronous operation. 2013()>, which is a synchronous operation.
2014 2014
2015For local paths, this usually doesn't matter: unless the system is very 2015For local paths, this usually doesn't matter: unless the system is very
2016busy or the intervals between stat's are large, a stat call will be fast, 2016busy or the intervals between stat's are large, a stat call will be fast,
2017as the path data is suually in memory already (except when starting the 2017as the path data is usually in memory already (except when starting the
2018watcher). 2018watcher).
2019 2019
2020For networked file systems, calling C<stat ()> can block an indefinite 2020For networked file systems, calling C<stat ()> can block an indefinite
2021time due to network issues, and even under good conditions, a stat call 2021time due to network issues, and even under good conditions, a stat call
2022often takes multiple milliseconds. 2022often takes multiple milliseconds.
… …
2891 2891
2892 myclass obj; 2892 myclass obj;
2893 ev::io iow; 2893 ev::io iow;
2894 iow.set <myclass, &myclass::io_cb> (&obj); 2894 iow.set <myclass, &myclass::io_cb> (&obj);
2895 2895
2896=item w->set (object *)
2897
2898This is an B<experimental> feature that might go away in a future version.
2899
2900This is a variation of a method callback - leaving out the method to call
2901will default the method to C<operator ()>, which makes it possible to use
2902functor objects without having to manually specify the C<operator ()> all
2903the time. Incidentally, you can then also leave out the template argument
2904list.
2905
2906The C<operator ()> method prototype must be C<void operator ()(watcher &w,
2907int revents)>.
2908
2909See the method-C<set> above for more details.
2910
2911Example: use a functor object as callback.
2912
2913 struct myfunctor
2914 {
2915 void operator() (ev::io &w, int revents)
2916 {
2917 ...
2918 }
2919 }
2920
2921 myfunctor f;
2922
2923 ev::io w;
2924 w.set (&f);
2925
2896=item w->set<function> (void *data = 0) 2926=item w->set<function> (void *data = 0)
2897 2927
2898Also sets a callback, but uses a static method or plain function as 2928Also sets a callback, but uses a static method or plain function as
2899callback. The optional C<data> argument will be stored in the watcher's 2929callback. The optional C<data> argument will be stored in the watcher's
2900C<data> member and is free for you to use. 2930C<data> member and is free for you to use.
… …
3215 3245
3216If defined to be C<1>, libev will try to use a direct syscall instead 3246If defined to be C<1>, libev will try to use a direct syscall instead
3217of calling the system-provided C<clock_gettime> function. This option 3247of calling the system-provided C<clock_gettime> function. This option
3218exists because on GNU/Linux, C<clock_gettime> is in C<librt>, but C<librt> 3248exists because on GNU/Linux, C<clock_gettime> is in C<librt>, but C<librt>
3219unconditionally pulls in C<libpthread>, slowing down single-threaded 3249unconditionally pulls in C<libpthread>, slowing down single-threaded
3220programs needlessly. Using a direct syscall is slightly slower, because 3250programs needlessly. Using a direct syscall is slightly slower (in
3221no optimised vdso implementation can be used, but avoids the pthread 3251theory), because no optimised vdso implementation can be used, but avoids
3222dependency. Defaults to C<1> on GNU/Linux with glibc 2.x or higher. 3252the pthread dependency. Defaults to C<1> on GNU/Linux with glibc 2.x or
3253higher, as it simplifies linking (no need for C<-lrt>).
3223 3254
3224=item EV_USE_NANOSLEEP 3255=item EV_USE_NANOSLEEP
3225 3256
3226If defined to be C<1>, libev will assume that C<nanosleep ()> is available 3257If defined to be C<1>, libev will assume that C<nanosleep ()> is available
3227and will use it for delays. Otherwise it will use C<select ()>. 3258and will use it for delays. Otherwise it will use C<select ()>.

Diff Legend

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