… | |
… | |
26 | $req->cancel; # cancel request if still in queue |
26 | $req->cancel; # cancel request if still in queue |
27 | |
27 | |
28 | my $grp = aio_group sub { print "all stats done\n" }; |
28 | my $grp = aio_group sub { print "all stats done\n" }; |
29 | add $grp aio_stat "..." for ...; |
29 | add $grp aio_stat "..." for ...; |
30 | |
30 | |
31 | # AnyEvent integration (EV, Event, Glib, Tk, urxvt, pureperl...) |
31 | # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...) |
32 | open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; |
32 | use AnyEvent::AIO; |
33 | my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); |
|
|
34 | |
33 | |
35 | # EV integration |
34 | # EV integration |
36 | my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
35 | my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
37 | |
36 | |
38 | # Event integration |
37 | # Event integration |
… | |
… | |
194 | use strict 'vars'; |
193 | use strict 'vars'; |
195 | |
194 | |
196 | use base 'Exporter'; |
195 | use base 'Exporter'; |
197 | |
196 | |
198 | BEGIN { |
197 | BEGIN { |
199 | our $VERSION = '2.62'; |
198 | our $VERSION = '3.19'; |
200 | |
199 | |
201 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
200 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
202 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir |
201 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
203 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
202 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
204 | aio_fdatasync aio_pathsync aio_readahead |
203 | aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead |
205 | aio_rename aio_link aio_move aio_copy aio_group |
204 | aio_rename aio_link aio_move aio_copy aio_group |
206 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
205 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
207 | aio_chmod aio_utime aio_truncate); |
206 | aio_chmod aio_utime aio_truncate); |
208 | |
207 | |
209 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
208 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
210 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
209 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
211 | min_parallel max_parallel max_idle |
210 | min_parallel max_parallel max_idle |
212 | nreqs nready npending nthreads |
211 | nreqs nready npending nthreads |
213 | max_poll_time max_poll_reqs); |
212 | max_poll_time max_poll_reqs); |
214 | |
213 | |
|
|
214 | push @AIO_REQ, qw(aio_busy); # not exported |
|
|
215 | |
215 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
216 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
216 | |
217 | |
217 | require XSLoader; |
218 | require XSLoader; |
218 | XSLoader::load ("IO::AIO", $VERSION); |
219 | XSLoader::load ("IO::AIO", $VERSION); |
219 | } |
220 | } |
… | |
… | |
225 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
226 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
226 | with the same name (sans C<aio_>). The arguments are similar or identical, |
227 | with the same name (sans C<aio_>). The arguments are similar or identical, |
227 | and they all accept an additional (and optional) C<$callback> argument |
228 | and they all accept an additional (and optional) C<$callback> argument |
228 | which must be a code reference. This code reference will get called with |
229 | which must be a code reference. This code reference will get called with |
229 | the syscall return code (e.g. most syscalls return C<-1> on error, unlike |
230 | the syscall return code (e.g. most syscalls return C<-1> on error, unlike |
230 | perl, which usually delivers "false") as it's sole argument when the given |
231 | perl, which usually delivers "false") as its sole argument after the given |
231 | syscall has been executed asynchronously. |
232 | syscall has been executed asynchronously. |
232 | |
233 | |
233 | All functions expecting a filehandle keep a copy of the filehandle |
234 | All functions expecting a filehandle keep a copy of the filehandle |
234 | internally until the request has finished. |
235 | internally until the request has finished. |
235 | |
236 | |
… | |
… | |
249 | your pathnames to the locale (or other) encoding in effect in the user |
250 | your pathnames to the locale (or other) encoding in effect in the user |
250 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
251 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
251 | use something else to ensure your scalar has the correct contents. |
252 | use something else to ensure your scalar has the correct contents. |
252 | |
253 | |
253 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
254 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
254 | handles correctly wether it is set or not. |
255 | handles correctly whether it is set or not. |
255 | |
256 | |
256 | =over 4 |
257 | =over 4 |
257 | |
258 | |
258 | =item $prev_pri = aioreq_pri [$pri] |
259 | =item $prev_pri = aioreq_pri [$pri] |
259 | |
260 | |
… | |
… | |
337 | |
338 | |
338 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
339 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
339 | |
340 | |
340 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
341 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
341 | |
342 | |
342 | Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset> |
343 | Reads or writes C<$length> bytes from or to the specified C<$fh> and |
343 | into the scalar given by C<$data> and offset C<$dataoffset> and calls the |
344 | C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> |
344 | callback without the actual number of bytes read (or -1 on error, just |
345 | and calls the callback without the actual number of bytes read (or -1 on |
345 | like the syscall). |
346 | error, just like the syscall). |
|
|
347 | |
|
|
348 | C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to |
|
|
349 | offset plus the actual number of bytes read. |
346 | |
350 | |
347 | If C<$offset> is undefined, then the current file descriptor offset will |
351 | If C<$offset> is undefined, then the current file descriptor offset will |
348 | be used (and updated), otherwise the file descriptor offset will not be |
352 | be used (and updated), otherwise the file descriptor offset will not be |
349 | changed by these calls. |
353 | changed by these calls. |
350 | |
354 | |
351 | If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. |
355 | If C<$length> is undefined in C<aio_write>, use the remaining length of |
|
|
356 | C<$data>. |
352 | |
357 | |
353 | If C<$dataoffset> is less than zero, it will be counted from the end of |
358 | If C<$dataoffset> is less than zero, it will be counted from the end of |
354 | C<$data>. |
359 | C<$data>. |
355 | |
360 | |
356 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
361 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
… | |
… | |
528 | |
533 | |
529 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
534 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
530 | directory (i.e. opendir + readdir + closedir). The entries will not be |
535 | directory (i.e. opendir + readdir + closedir). The entries will not be |
531 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
536 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
532 | |
537 | |
533 | The callback a single argument which is either C<undef> or an array-ref |
538 | The callback is passed a single argument which is either C<undef> or an |
534 | with the filenames. |
539 | array-ref with the filenames. |
|
|
540 | |
|
|
541 | |
|
|
542 | =item aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
|
|
543 | |
|
|
544 | Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune |
|
|
545 | behaviour and output format. In case of an error, C<$entries> will be |
|
|
546 | C<undef>. |
|
|
547 | |
|
|
548 | The flags are a combination of the following constants, ORed together (the |
|
|
549 | flags will also be passed to the callback, possibly modified): |
|
|
550 | |
|
|
551 | =over 4 |
|
|
552 | |
|
|
553 | =item AIO::READDIR_DENTS |
|
|
554 | |
|
|
555 | When this flag is off, then the callback gets an arrayref with of names |
|
|
556 | only (as with C<aio_readdir>), otherwise it gets an arrayref with |
|
|
557 | C<[$name, $inode, $type]> arrayrefs, each describing a single directory |
|
|
558 | entry in more detail. |
|
|
559 | |
|
|
560 | C<$name> is the name of the entry. |
|
|
561 | |
|
|
562 | C<$inode> is the inode number (which might not be exact on systems with 64 |
|
|
563 | bit inode numbers and 32 bit perls). On systems that do not deliver the |
|
|
564 | inode information, this will always be zero. |
|
|
565 | |
|
|
566 | C<$type> is one of the C<AIO::DT_xxx> constants: |
|
|
567 | |
|
|
568 | C<AIO::DT_UNKNOWN>, C<AIO::DT_FIFO>, C<AIO::DT_CHR>, C<AIO::DT_DIR>, |
|
|
569 | C<AIO::DT_BLK>, C<AIO::DT_REG>, C<AIO::DT_LNK>, C<AIO::DT_SOCK>, |
|
|
570 | C<AIO::DT_WHT>. |
|
|
571 | |
|
|
572 | C<AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to |
|
|
573 | know, you have to run stat yourself. Also, for speed reasons, the C<$type> |
|
|
574 | scalars are read-only: you can not modify them. |
|
|
575 | |
|
|
576 | =item AIO::READDIR_DIRS_FIRST |
|
|
577 | |
|
|
578 | When this flag is set, then the names will be returned in an order where |
|
|
579 | likely directories come first. This is useful when you need to quickly |
|
|
580 | find directories, or you want to find all directories while avoiding to |
|
|
581 | stat() each entry. |
|
|
582 | |
|
|
583 | =item AIO::READDIR_STAT_ORDER |
|
|
584 | |
|
|
585 | When this flag is set, then the names will be returned in an order |
|
|
586 | suitable for stat()'ing each one. That is, when you plan to stat() |
|
|
587 | all files in the given directory, then the returned order will likely |
|
|
588 | be fastest. |
|
|
589 | |
|
|
590 | If both this flag and IO::READDIR_DIRS_FIRST are specified, then the |
|
|
591 | likely dirs come first, resulting in a less optimal stat order. |
|
|
592 | |
|
|
593 | =item AIO::READDIR_FOUND_UNKNOWN |
|
|
594 | |
|
|
595 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
|
|
596 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
|
|
597 | C<AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all |
|
|
598 | C<$type>'s are known, which can be used to speed up some algorithms. |
|
|
599 | |
|
|
600 | =back |
535 | |
601 | |
536 | |
602 | |
537 | =item aio_load $path, $data, $callback->($status) |
603 | =item aio_load $path, $data, $callback->($status) |
538 | |
604 | |
539 | This is a composite request that tries to fully load the given file into |
605 | This is a composite request that tries to fully load the given file into |
… | |
… | |
566 | |
632 | |
567 | Try to copy the I<file> (directories not supported as either source or |
633 | Try to copy the I<file> (directories not supported as either source or |
568 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
634 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
569 | the C<0> (error) or C<-1> ok. |
635 | the C<0> (error) or C<-1> ok. |
570 | |
636 | |
571 | This is a composite request that it creates the destination file with |
637 | This is a composite request that creates the destination file with |
572 | mode 0200 and copies the contents of the source file into it using |
638 | mode 0200 and copies the contents of the source file into it using |
573 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
639 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
574 | uid/gid, in that order. |
640 | uid/gid, in that order. |
575 | |
641 | |
576 | If an error occurs, the partial destination file will be unlinked, if |
642 | If an error occurs, the partial destination file will be unlinked, if |
… | |
… | |
586 | my $grp = aio_group $cb; |
652 | my $grp = aio_group $cb; |
587 | |
653 | |
588 | aioreq_pri $pri; |
654 | aioreq_pri $pri; |
589 | add $grp aio_open $src, O_RDONLY, 0, sub { |
655 | add $grp aio_open $src, O_RDONLY, 0, sub { |
590 | if (my $src_fh = $_[0]) { |
656 | if (my $src_fh = $_[0]) { |
591 | my @stat = stat $src_fh; |
657 | my @stat = stat $src_fh; # hmm, might bock over nfs? |
592 | |
658 | |
593 | aioreq_pri $pri; |
659 | aioreq_pri $pri; |
594 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
660 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
595 | if (my $dst_fh = $_[0]) { |
661 | if (my $dst_fh = $_[0]) { |
596 | aioreq_pri $pri; |
662 | aioreq_pri $pri; |
597 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
663 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
598 | if ($_[0] == $stat[7]) { |
664 | if ($_[0] == $stat[7]) { |
599 | $grp->result (0); |
665 | $grp->result (0); |
600 | close $src_fh; |
666 | close $src_fh; |
601 | |
667 | |
602 | # those should not normally block. should. should. |
668 | my $ch = sub { |
603 | utime $stat[8], $stat[9], $dst; |
669 | aioreq_pri $pri; |
604 | chmod $stat[2] & 07777, $dst_fh; |
670 | add $grp aio_chmod $dst_fh, $stat[2] & 07777, sub { |
605 | chown $stat[4], $stat[5], $dst_fh; |
671 | aioreq_pri $pri; |
|
|
672 | add $grp aio_chown $dst_fh, $stat[4], $stat[5], sub { |
|
|
673 | aioreq_pri $pri; |
|
|
674 | add $grp aio_close $dst_fh; |
|
|
675 | } |
|
|
676 | }; |
|
|
677 | }; |
606 | |
678 | |
607 | aioreq_pri $pri; |
679 | aioreq_pri $pri; |
608 | add $grp aio_close $dst_fh; |
680 | add $grp aio_utime $dst_fh, $stat[8], $stat[9], sub { |
|
|
681 | if ($_[0] < 0 && $! == ENOSYS) { |
|
|
682 | aioreq_pri $pri; |
|
|
683 | add $grp aio_utime $dst, $stat[8], $stat[9], $ch; |
|
|
684 | } else { |
|
|
685 | $ch->(); |
|
|
686 | } |
|
|
687 | }; |
609 | } else { |
688 | } else { |
610 | $grp->result (-1); |
689 | $grp->result (-1); |
611 | close $src_fh; |
690 | close $src_fh; |
612 | close $dst_fh; |
691 | close $dst_fh; |
613 | |
692 | |
… | |
… | |
632 | |
711 | |
633 | Try to move the I<file> (directories not supported as either source or |
712 | Try to move the I<file> (directories not supported as either source or |
634 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
713 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
635 | the C<0> (error) or C<-1> ok. |
714 | the C<0> (error) or C<-1> ok. |
636 | |
715 | |
637 | This is a composite request that tries to rename(2) the file first. If |
716 | This is a composite request that tries to rename(2) the file first; if |
638 | rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if |
717 | rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if |
639 | that is successful, unlinking the C<$srcpath>. |
718 | that is successful, unlinks the C<$srcpath>. |
640 | |
719 | |
641 | =cut |
720 | =cut |
642 | |
721 | |
643 | sub aio_move($$;$) { |
722 | sub aio_move($$;$) { |
644 | my ($src, $dst, $cb) = @_; |
723 | my ($src, $dst, $cb) = @_; |
… | |
… | |
736 | my $now = time; |
815 | my $now = time; |
737 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
816 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
738 | |
817 | |
739 | # read the directory entries |
818 | # read the directory entries |
740 | aioreq_pri $pri; |
819 | aioreq_pri $pri; |
741 | add $grp aio_readdir $path, sub { |
820 | add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub { |
742 | my $entries = shift |
821 | my $entries = shift |
743 | or return $grp->result (); |
822 | or return $grp->result (); |
744 | |
823 | |
745 | # stat the dir another time |
824 | # stat the dir another time |
746 | aioreq_pri $pri; |
825 | aioreq_pri $pri; |
… | |
… | |
856 | callback with the fdatasync result code. |
935 | callback with the fdatasync result code. |
857 | |
936 | |
858 | If this call isn't available because your OS lacks it or it couldn't be |
937 | If this call isn't available because your OS lacks it or it couldn't be |
859 | detected, it will be emulated by calling C<fsync> instead. |
938 | detected, it will be emulated by calling C<fsync> instead. |
860 | |
939 | |
|
|
940 | =item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
|
|
941 | |
|
|
942 | Sync the data portion of the file specified by C<$offset> and C<$length> |
|
|
943 | to disk (but NOT the metadata), by calling the Linux-specific |
|
|
944 | sync_file_range call. If sync_file_range is not available or it returns |
|
|
945 | ENOSYS, then fdatasync or fsync is being substituted. |
|
|
946 | |
|
|
947 | C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>, |
|
|
948 | C<IO::AIO::SYNC_FILE_RANGE_WRITE> and |
|
|
949 | C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range |
|
|
950 | manpage for details. |
|
|
951 | |
861 | =item aio_pathsync $path, $callback->($status) |
952 | =item aio_pathsync $path, $callback->($status) |
862 | |
953 | |
863 | This request tries to open, fsync and close the given path. This is a |
954 | This request tries to open, fsync and close the given path. This is a |
864 | composite request intended tosync directories after directory operations |
955 | composite request intended to sync directories after directory operations |
865 | (E.g. rename). This might not work on all operating systems or have any |
956 | (E.g. rename). This might not work on all operating systems or have any |
866 | specific effect, but usually it makes sure that directory changes get |
957 | specific effect, but usually it makes sure that directory changes get |
867 | written to disc. It works for anything that can be opened for read-only, |
958 | written to disc. It works for anything that can be opened for read-only, |
868 | not just directories. |
959 | not just directories. |
869 | |
960 | |
… | |
… | |
1014 | Their lifetime, simplified, looks like this: when they are empty, they |
1105 | Their lifetime, simplified, looks like this: when they are empty, they |
1015 | will finish very quickly. If they contain only requests that are in the |
1106 | will finish very quickly. If they contain only requests that are in the |
1016 | C<done> state, they will also finish. Otherwise they will continue to |
1107 | C<done> state, they will also finish. Otherwise they will continue to |
1017 | exist. |
1108 | exist. |
1018 | |
1109 | |
1019 | That means after creating a group you have some time to add requests. And |
1110 | That means after creating a group you have some time to add requests |
1020 | in the callbacks of those requests, you can add further requests to the |
1111 | (precisely before the callback has been invoked, which is only done within |
1021 | group. And only when all those requests have finished will the the group |
1112 | the C<poll_cb>). And in the callbacks of those requests, you can add |
1022 | itself finish. |
1113 | further requests to the group. And only when all those requests have |
|
|
1114 | finished will the the group itself finish. |
1023 | |
1115 | |
1024 | =over 4 |
1116 | =over 4 |
1025 | |
1117 | |
1026 | =item add $grp ... |
1118 | =item add $grp ... |
1027 | |
1119 | |
… | |
… | |
1060 | =item feed $grp $callback->($grp) |
1152 | =item feed $grp $callback->($grp) |
1061 | |
1153 | |
1062 | Sets a feeder/generator on this group: every group can have an attached |
1154 | Sets a feeder/generator on this group: every group can have an attached |
1063 | generator that generates requests if idle. The idea behind this is that, |
1155 | generator that generates requests if idle. The idea behind this is that, |
1064 | although you could just queue as many requests as you want in a group, |
1156 | although you could just queue as many requests as you want in a group, |
1065 | this might starve other requests for a potentially long time. For |
1157 | this might starve other requests for a potentially long time. For example, |
1066 | example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> |
1158 | C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests, |
1067 | requests, delaying any later requests for a long time. |
1159 | delaying any later requests for a long time. |
1068 | |
1160 | |
1069 | To avoid this, and allow incremental generation of requests, you can |
1161 | To avoid this, and allow incremental generation of requests, you can |
1070 | instead a group and set a feeder on it that generates those requests. The |
1162 | instead a group and set a feeder on it that generates those requests. The |
1071 | feed callback will be called whenever there are few enough (see C<limit>, |
1163 | feed callback will be called whenever there are few enough (see C<limit>, |
1072 | below) requests active in the group itself and is expected to queue more |
1164 | below) requests active in the group itself and is expected to queue more |
… | |
… | |
1076 | not impose any limits). |
1168 | not impose any limits). |
1077 | |
1169 | |
1078 | If the feed does not queue more requests when called, it will be |
1170 | If the feed does not queue more requests when called, it will be |
1079 | automatically removed from the group. |
1171 | automatically removed from the group. |
1080 | |
1172 | |
1081 | If the feed limit is C<0>, it will be set to C<2> automatically. |
1173 | If the feed limit is C<0> when this method is called, it will be set to |
|
|
1174 | C<2> automatically. |
1082 | |
1175 | |
1083 | Example: |
1176 | Example: |
1084 | |
1177 | |
1085 | # stat all files in @files, but only ever use four aio requests concurrently: |
1178 | # stat all files in @files, but only ever use four aio requests concurrently: |
1086 | |
1179 | |
… | |
… | |
1098 | Sets the feeder limit for the group: The feeder will be called whenever |
1191 | Sets the feeder limit for the group: The feeder will be called whenever |
1099 | the group contains less than this many requests. |
1192 | the group contains less than this many requests. |
1100 | |
1193 | |
1101 | Setting the limit to C<0> will pause the feeding process. |
1194 | Setting the limit to C<0> will pause the feeding process. |
1102 | |
1195 | |
|
|
1196 | The default value for the limit is C<0>, but note that setting a feeder |
|
|
1197 | automatically bumps it up to C<2>. |
|
|
1198 | |
1103 | =back |
1199 | =back |
1104 | |
1200 | |
1105 | =head2 SUPPORT FUNCTIONS |
1201 | =head2 SUPPORT FUNCTIONS |
1106 | |
1202 | |
1107 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
1203 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
… | |
… | |
1118 | See C<poll_cb> for an example. |
1214 | See C<poll_cb> for an example. |
1119 | |
1215 | |
1120 | =item IO::AIO::poll_cb |
1216 | =item IO::AIO::poll_cb |
1121 | |
1217 | |
1122 | Process some outstanding events on the result pipe. You have to call this |
1218 | Process some outstanding events on the result pipe. You have to call this |
1123 | regularly. Returns the number of events processed. Returns immediately |
1219 | regularly. Returns C<0> if all events could be processed, or C<-1> if it |
|
|
1220 | returned earlier for whatever reason. Returns immediately when no events |
1124 | when no events are outstanding. The amount of events processed depends on |
1221 | are outstanding. The amount of events processed depends on the settings of |
1125 | the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. |
1222 | C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. |
1126 | |
1223 | |
1127 | If not all requests were processed for whatever reason, the filehandle |
1224 | If not all requests were processed for whatever reason, the filehandle |
1128 | will still be ready when C<poll_cb> returns. |
1225 | will still be ready when C<poll_cb> returns, so normally you don't have to |
|
|
1226 | do anything special to have it called later. |
1129 | |
1227 | |
1130 | Example: Install an Event watcher that automatically calls |
1228 | Example: Install an Event watcher that automatically calls |
1131 | IO::AIO::poll_cb with high priority: |
1229 | IO::AIO::poll_cb with high priority: |
1132 | |
1230 | |
1133 | Event->io (fd => IO::AIO::poll_fileno, |
1231 | Event->io (fd => IO::AIO::poll_fileno, |
… | |
… | |
1342 | |
1440 | |
1343 | Known bugs will be fixed in the next release. |
1441 | Known bugs will be fixed in the next release. |
1344 | |
1442 | |
1345 | =head1 SEE ALSO |
1443 | =head1 SEE ALSO |
1346 | |
1444 | |
1347 | L<Coro::AIO>. |
1445 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
|
|
1446 | more natural syntax. |
1348 | |
1447 | |
1349 | =head1 AUTHOR |
1448 | =head1 AUTHOR |
1350 | |
1449 | |
1351 | Marc Lehmann <schmorp@schmorp.de> |
1450 | Marc Lehmann <schmorp@schmorp.de> |
1352 | http://home.schmorp.de/ |
1451 | http://home.schmorp.de/ |