… | |
… | |
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 | |
|
|
540 | This is a special request - it does nothing in itself and is only used for |
|
|
541 | side effects, such as when you want to add a dummy request to a group so |
|
|
542 | that finishing the requests in the group depends on executing the given |
|
|
543 | code. |
|
|
544 | |
|
|
545 | While this request does nothing, it still goes through the execution |
|
|
546 | phase and still requires a worker thread. Thus, the callback will not |
|
|
547 | be executed immediately but only after other requests in the queue have |
|
|
548 | entered their execution phase. This can be used to measure request |
|
|
549 | latency. |
|
|
550 | |
538 | =item IO::AIO::aio_sleep $fractional_seconds, $callback->() *NOT EXPORTED* |
551 | =item IO::AIO::aio_sleep $fractional_seconds, $callback->() *NOT EXPORTED* |
539 | |
552 | |
540 | Mainly used for debugging and benchmarking, this aio request puts one of |
553 | Mainly used for debugging and benchmarking, this aio request puts one of |
541 | the request workers to sleep for the given time. |
554 | the request workers to sleep for the given time. |
542 | |
555 | |
… | |
… | |
603 | }; |
616 | }; |
604 | |
617 | |
605 | This makes it very easy to create composite requests (see the source of |
618 | This makes it very easy to create composite requests (see the source of |
606 | C<aio_move> for an application) that work and feel like simple requests. |
619 | C<aio_move> for an application) that work and feel like simple requests. |
607 | |
620 | |
|
|
621 | =over 4 |
|
|
622 | |
608 | The IO::AIO::GRP objects will be cleaned up during calls to |
623 | =item * The IO::AIO::GRP objects will be cleaned up during calls to |
609 | C<IO::AIO::poll_cb>, just like any other request. |
624 | C<IO::AIO::poll_cb>, just like any other request. |
610 | |
625 | |
611 | They can be canceled like any other request. Canceling will cancel not |
626 | =item * They can be canceled like any other request. Canceling will cancel not |
612 | only the request itself, but also all requests it contains. |
627 | only the request itself, but also all requests it contains. |
613 | |
628 | |
614 | They can also can also be added to other IO::AIO::GRP objects. |
629 | =item * They can also can also be added to other IO::AIO::GRP objects. |
615 | |
630 | |
616 | You must not add requests to a group from within the group callback (or |
631 | =item * You must not add requests to a group from within the group callback (or |
617 | any later time). |
632 | any later time). |
|
|
633 | |
|
|
634 | =item * This does not harmonise well with C<max_outstanding>, so best do |
|
|
635 | not combine C<aio_group> with it. Groups and feeders are recommended for |
|
|
636 | this kind of concurrency-limiting. |
|
|
637 | |
|
|
638 | =back |
618 | |
639 | |
619 | Their lifetime, simplified, looks like this: when they are empty, they |
640 | Their lifetime, simplified, looks like this: when they are empty, they |
620 | will finish very quickly. If they contain only requests that are in the |
641 | will finish very quickly. If they contain only requests that are in the |
621 | C<done> state, they will also finish. Otherwise they will continue to |
642 | C<done> state, they will also finish. Otherwise they will continue to |
622 | exist. |
643 | exist. |
… | |
… | |
784 | |
805 | |
785 | Under normal circumstances you don't need to call this function. |
806 | Under normal circumstances you don't need to call this function. |
786 | |
807 | |
787 | =item $oldnreqs = IO::AIO::max_outstanding $nreqs |
808 | =item $oldnreqs = IO::AIO::max_outstanding $nreqs |
788 | |
809 | |
|
|
810 | [DEPRECATED] |
|
|
811 | |
789 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
812 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
790 | try to queue up more than this number of requests, the caller will block until |
813 | try to queue up more than this number of requests, the caller will block until |
791 | some requests have been handled. |
814 | some requests have been handled. |
792 | |
815 | |
793 | The default is very large, so normally there is no practical limit. If you |
816 | The default is very large, so normally there is no practical limit. If you |
794 | queue up many requests in a loop it often improves speed if you set |
817 | queue up many requests in a loop it often improves speed if you set |
795 | this to a relatively low number, such as C<100>. |
818 | this to a relatively low number, such as C<100>. |
|
|
819 | |
|
|
820 | This function does not work well together with C<aio_group>'s, and their |
|
|
821 | feeder interface is better suited to limiting concurrency, so do not use |
|
|
822 | this function. |
796 | |
823 | |
797 | Under normal circumstances you don't need to call this function. |
824 | Under normal circumstances you don't need to call this function. |
798 | |
825 | |
799 | =back |
826 | =back |
800 | |
827 | |