ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/IO-AIO/AIO.pm
(Generate patch)

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.61 by root, Sun Oct 22 13:52:11 2006 UTC vs.
Revision 1.63 by root, Mon Oct 23 00:34:36 2006 UTC

… …
79 our $VERSION = '2.0'; 79 our $VERSION = '2.0';
80 80
81 our @EXPORT = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat 81 our @EXPORT = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat
82 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 82 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink
83 aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move 83 aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move
84 aio_group); 84 aio_group aio_nop);
85 our @EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs); 85 our @EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs);
86 86
87 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 87 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
88 88
89 require XSLoader; 89 require XSLoader;
… …
533 add $grp 533 add $grp
534 (aio_stat ...), 534 (aio_stat ...),
535 (aio_stat ...), 535 (aio_stat ...),
536 ...; 536 ...;
537 537
538=item aio_nop $callback->()
539
540This is a special request - it does nothing in itself and is only used for
541side effects, such as when you want to add a dummy request to a group so
542that finishing the requests in the group depends on executing the given
543code.
544
538=item IO::AIO::aio_sleep $fractional_seconds, $callback->() *NOT EXPORTED* 545=item IO::AIO::aio_sleep $fractional_seconds, $callback->() *NOT EXPORTED*
539 546
540Mainly used for debugging and benchmarking, this aio request puts one of 547Mainly used for debugging and benchmarking, this aio request puts one of
541the request workers to sleep for the given time. 548the request workers to sleep for the given time.
542 549
… …
603 }; 610 };
604 611
605This makes it very easy to create composite requests (see the source of 612This makes it very easy to create composite requests (see the source of
606C<aio_move> for an application) that work and feel like simple requests. 613C<aio_move> for an application) that work and feel like simple requests.
607 614
615=over 4
616
608The IO::AIO::GRP objects will be cleaned up during calls to 617=item * The IO::AIO::GRP objects will be cleaned up during calls to
609C<IO::AIO::poll_cb>, just like any other request. 618C<IO::AIO::poll_cb>, just like any other request.
610 619
611They can be canceled like any other request. Canceling will cancel not 620=item * They can be canceled like any other request. Canceling will cancel not
612only the request itself, but also all requests it contains. 621only the request itself, but also all requests it contains.
613 622
614They can also can also be added to other IO::AIO::GRP objects. 623=item * They can also can also be added to other IO::AIO::GRP objects.
615 624
616You must not add requests to a group from within the group callback (or 625=item * You must not add requests to a group from within the group callback (or
617any later time). 626any later time).
627
628=item * This does not harmonise well with C<max_outstanding>, so best do
629not combine C<aio_group> with it. Groups and feeders are recommended for
630this kind of concurrency-limiting.
631
632=back
618 633
619Their lifetime, simplified, looks like this: when they are empty, they 634Their lifetime, simplified, looks like this: when they are empty, they
620will finish very quickly. If they contain only requests that are in the 635will finish very quickly. If they contain only requests that are in the
621C<done> state, they will also finish. Otherwise they will continue to 636C<done> state, they will also finish. Otherwise they will continue to
622exist. 637exist.
… …
784 799
785Under normal circumstances you don't need to call this function. 800Under normal circumstances you don't need to call this function.
786 801
787=item $oldnreqs = IO::AIO::max_outstanding $nreqs 802=item $oldnreqs = IO::AIO::max_outstanding $nreqs
788 803
804[DEPRECATED]
805
789Sets the maximum number of outstanding requests to C<$nreqs>. If you 806Sets the maximum number of outstanding requests to C<$nreqs>. If you
790try to queue up more than this number of requests, the caller will block until 807try to queue up more than this number of requests, the caller will block until
791some requests have been handled. 808some requests have been handled.
792 809
793The default is very large, so normally there is no practical limit. If you 810The default is very large, so normally there is no practical limit. If you
794queue up many requests in a loop it often improves speed if you set 811queue up many requests in a loop it often improves speed if you set
795this to a relatively low number, such as C<100>. 812this to a relatively low number, such as C<100>.
813
814This function does not work well together with C<aio_group>'s, and their
815feeder interface is better suited to limiting concurrency, so do not use
816this function.
796 817
797Under normal circumstances you don't need to call this function. 818Under normal circumstances you don't need to call this function.
798 819
799=back 820=back
800 821

Diff Legend

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