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

Comparing libeio/eio.pod (file contents):
Revision 1.30 by root, Wed Jan 11 05:13:22 2012 UTC vs.
Revision 1.35 by root, Mon Aug 18 08:11:54 2014 UTC

… …
25similar functions, as well as less rarely ones such as C<mknod>, C<futime> 25similar functions, as well as less rarely ones such as C<mknod>, C<futime>
26or C<readlink>. 26or C<readlink>.
27 27
28It also offers wrappers around C<sendfile> (Solaris, Linux, HP-UX and 28It also offers wrappers around C<sendfile> (Solaris, Linux, HP-UX and
29FreeBSD, with emulation on other platforms) and C<readahead> (Linux, with 29FreeBSD, with emulation on other platforms) and C<readahead> (Linux, with
30emulation elsewhere>). 30emulation elsewhere).
31 31
32The goal is to enable you to write fully non-blocking programs. For 32The goal is to enable you to write fully non-blocking programs. For
33example, in a game server, you would not want to freeze for a few seconds 33example, in a game server, you would not want to freeze for a few seconds
34just because the server is running a backup and you happen to call 34just because the server is running a backup and you happen to call
35C<readdir>. 35C<readdir>.
… …
176 { 176 {
177 loop = EV_DEFAULT; 177 loop = EV_DEFAULT;
178 178
179 ev_idle_init (&repeat_watcher, repeat); 179 ev_idle_init (&repeat_watcher, repeat);
180 ev_async_init (&ready_watcher, ready); 180 ev_async_init (&ready_watcher, ready);
181 ev_async_start (loop &watcher); 181 ev_async_start (loop, &watcher);
182 182
183 eio_init (want_poll, 0); 183 eio_init (want_poll, 0);
184 } 184 }
185 185
186For most other event loops, you would typically use a pipe - the event 186For most other event loops, you would typically use a pipe - the event
… …
290 290
291Cancel the request (and all its subrequests). If the request is currently 291Cancel the request (and all its subrequests). If the request is currently
292executing it might still continue to execute, and in other cases it might 292executing it might still continue to execute, and in other cases it might
293still take a while till the request is cancelled. 293still take a while till the request is cancelled.
294 294
295Even if cancelled, the finish callback will still be invoked - the 295When cancelled, the finish callback will not be invoked.
296callbacks of all cancellable requests need to check whether the request
297has been cancelled by calling C<EIO_CANCELLED (req)>:
298
299 static int
300 my_eio_cb (eio_req *req)
301 {
302 if (EIO_CANCELLED (req))
303 return 0;
304 }
305
306In addition, cancelled requests will I<either> have C<< req->result >>
307set to C<-1> and C<errno> to C<ECANCELED>, or I<otherwise> they were
308successfully executed, despite being cancelled (e.g. when they have
309already been executed at the time they were cancelled).
310 296
311C<EIO_CANCELLED> is still true for requests that have successfully 297C<EIO_CANCELLED> is still true for requests that have successfully
312executed, as long as C<eio_cancel> was called on them at some point. 298executed, as long as C<eio_cancel> was called on them at some point.
313 299
314=back 300=back
… …
630 616
631=over 4 617=over 4
632 618
633=item eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data) 619=item eio_mtouch (void *addr, size_t length, int flags, int pri, eio_cb cb, void *data)
634 620
635Reads (C<flags == 0>) or modifies (C<flags == EIO_MT_MODIFY) the given 621Reads (C<flags == 0>) or modifies (C<flags == EIO_MT_MODIFY>) the given
636memory area, page-wise, that is, it reads (or reads and writes back) the 622memory area, page-wise, that is, it reads (or reads and writes back) the
637first octet of every page that spans the memory area. 623first octet of every page that spans the memory area.
638 624
639This can be used to page in some mmapped file, or dirty some pages. Note 625This can be used to page in some mmapped file, or dirty some pages. Note
640that dirtying is an unlocked read-write access, so races can ensue when 626that dirtying is an unlocked read-write access, so races can ensue when
… …
788#TODO 774#TODO
789 775
790void eio_grp_limit (eio_req *grp, int limit); 776void eio_grp_limit (eio_req *grp, int limit);
791 777
792 778
793=back
794
795 779
796=head1 LOW LEVEL REQUEST API 780=head1 LOW LEVEL REQUEST API
797 781
798#TODO 782#TODO
799 783
… …
926This symbol governs the stack size for each eio thread. Libeio itself 910This symbol governs the stack size for each eio thread. Libeio itself
927was written to use very little stackspace, but when using C<EIO_CUSTOM> 911was written to use very little stackspace, but when using C<EIO_CUSTOM>
928requests, you might want to increase this. 912requests, you might want to increase this.
929 913
930If this symbol is undefined (the default) then libeio will use its default 914If this symbol is undefined (the default) then libeio will use its default
931stack size (C<sizeof (void *) * 4096> currently). If it is defined, but 915stack size (C<sizeof (void *) * 4096> currently). In all other cases, the
932C<0>, then the default operating system stack size will be used. In all
933other cases, the value must be an expression that evaluates to the desired 916value must be an expression that evaluates to the desired stack size.
934stack size.
935 917
936=back 918=back
937 919
938 920
939=head1 PORTABILITY REQUIREMENTS 921=head1 PORTABILITY REQUIREMENTS

Diff Legend

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