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

Comparing libeio/eio.pod (file contents):
Revision 1.1 by root, Sun May 11 13:05:10 2008 UTC vs.
Revision 1.5 by root, Sun Nov 29 15:53:48 2009 UTC

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 enbale 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>.
36 36
37=head2 TIME REPRESENTATION 37=head2 TIME REPRESENTATION
236=head1 EMBEDDING 236=head1 EMBEDDING
237 237
238Libeio can be embedded directly into programs. This functionality is not 238Libeio can be embedded directly into programs. This functionality is not
239documented and not (yet) officially supported. 239documented and not (yet) officially supported.
240 240
241Note that, when including C<libeio.m4>, you are responsible for defining
242the compilation environment (C<_LARGEFILE_SOURCE>, C<_GNU_SOURCE> etc.).
243
241If you ened to know how, cehck the C<IO::AIO> perl module, which does 244If you need to know how, check the C<IO::AIO> perl module, which does
242exactly that. 245exactly that.
246
247
248=head1 COMPILETIME CONFIGURATION
249
250These symbols, if used, must be defined when compiling F<eio.c>.
251
252=over 4
253
254=item EIO_STACKSIZE
255
256This symbol governs the stack size for each eio thread. Libeio itself
257was written to use very little stackspace, but when using C<EIO_CUSTOM>
258requests, you might want to increase this.
259
260If this symbol is undefined (the default) then libeio will use its default
261stack size (C<sizeof (long) * 4096> currently). If it is defined, but
262C<0>, then the default operating system stack size will be used. In all
263other cases, the value must be an expression that evaluates to the desired
264stack size.
265
266=back
243 267
244 268
245=head1 PORTABILITY REQUIREMENTS 269=head1 PORTABILITY REQUIREMENTS
246 270
247In addition to a working ISO-C implementation, libeio relies on a few 271In addition to a working ISO-C implementation, libeio relies on a few

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines