--- libeio/eio.pod 2011/06/05 23:22:04 1.10 +++ libeio/eio.pod 2011/07/05 09:24:12 1.13 @@ -155,7 +155,10 @@ required parameters, a callback of type C (called C below) and a freely usable C argument. -The return value will either be 0 +The return value will either be 0, in case something went really wrong +(which can basically only happen on very fatal errors, such as C +returning 0, which is rather unlikely), or a pointer to the newly-created +and submitted C. The callback will be called with an C which contains the results of the request. The members you can access inside that structure @@ -228,7 +231,7 @@ =head3 POSIX API WRAPPERS These requests simply wrap the POSIX call of the same name, with the same -arguments. If a function is not implemented by the OS and cnanot be emulated +arguments. If a function is not implemented by the OS and cannot be emulated in some way, then all of these return C<-1> and set C to C. =over 4 @@ -319,6 +322,12 @@ free (target); } +=item eio_realpath (const char *path, int pri, eio_cb cb, void *data) + +Similar to the realpath libc function, but unlike that one, result is +C<0> on failure and the length of the returned path in C - this is +similar to readlink. + =item eio_stat (const char *path, int pri, eio_cb cb, void *data) =item eio_lstat (const char *path, int pri, eio_cb cb, void *data) @@ -570,6 +579,28 @@ =head3 GROUPING AND LIMITING REQUESTS +There is one more rather special request, C. It is a very special +aio request: Instead of doing something, it is a container for other eio +requests. + +There are two primary use cases for this: a) bundle many requests into a +single, composite, request with a definite callback and the ability to +cancel the whole request with its subrequests and b) limiting the number +of "active" requests. + +Further below you will find more dicussion of these topics - first follows +the reference section detailing the request generator and other methods. + +=over 4 + +=item eio_grp (eio_cb cb, void *data) + +Creates and submits a group request. + +=back + + + #TODO /*****************************************************************************/