… | |
… | |
28 | |
28 | |
29 | # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...) |
29 | # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...) |
30 | use AnyEvent::AIO; |
30 | use AnyEvent::AIO; |
31 | |
31 | |
32 | # EV integration |
32 | # EV integration |
33 | my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
33 | my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
34 | |
34 | |
35 | # Event integration |
35 | # Event integration |
36 | Event->io (fd => IO::AIO::poll_fileno, |
36 | Event->io (fd => IO::AIO::poll_fileno, |
37 | poll => 'r', |
37 | poll => 'r', |
38 | cb => \&IO::AIO::poll_cb); |
38 | cb => \&IO::AIO::poll_cb); |
… | |
… | |
49 | Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => |
49 | Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => |
50 | \&IO::AIO::poll_cb); |
50 | \&IO::AIO::poll_cb); |
51 | |
51 | |
52 | DESCRIPTION |
52 | DESCRIPTION |
53 | This module implements asynchronous I/O using whatever means your |
53 | This module implements asynchronous I/O using whatever means your |
54 | operating system supports. |
54 | operating system supports. It is implemented as an interface to "libeio" |
|
|
55 | (<http://software.schmorp.de/pkg/libeio.html>). |
55 | |
56 | |
56 | Asynchronous means that operations that can normally block your program |
57 | Asynchronous means that operations that can normally block your program |
57 | (e.g. reading from disk) will be done asynchronously: the operation will |
58 | (e.g. reading from disk) will be done asynchronously: the operation will |
58 | still block, but you can do something else in the meantime. This is |
59 | still block, but you can do something else in the meantime. This is |
59 | extremely useful for programs that need to stay interactive even when |
60 | extremely useful for programs that need to stay interactive even when |
… | |
… | |
64 | operations concurrently. |
65 | operations concurrently. |
65 | |
66 | |
66 | While most of this works on all types of file descriptors (for example |
67 | While most of this works on all types of file descriptors (for example |
67 | sockets), using these functions on file descriptors that support |
68 | sockets), using these functions on file descriptors that support |
68 | nonblocking operation (again, sockets, pipes etc.) is very inefficient. |
69 | nonblocking operation (again, sockets, pipes etc.) is very inefficient. |
69 | Use an event loop for that (such as the Event module): IO::AIO will |
70 | Use an event loop for that (such as the EV module): IO::AIO will |
70 | naturally fit into such an event loop itself. |
71 | naturally fit into such an event loop itself. |
71 | |
72 | |
72 | In this version, a number of threads are started that execute your |
73 | In this version, a number of threads are started that execute your |
73 | requests and signal their completion. You don't need thread support in |
74 | requests and signal their completion. You don't need thread support in |
74 | perl, and the threads created by this module will not be visible to |
75 | perl, and the threads created by this module will not be visible to |
… | |
… | |
83 | it is currently not reentrant in any way, so use appropriate locking |
84 | it is currently not reentrant in any way, so use appropriate locking |
84 | yourself, always call "poll_cb" from within the same thread, or never |
85 | yourself, always call "poll_cb" from within the same thread, or never |
85 | call "poll_cb" (or other "aio_" functions) recursively. |
86 | call "poll_cb" (or other "aio_" functions) recursively. |
86 | |
87 | |
87 | EXAMPLE |
88 | EXAMPLE |
88 | This is a simple example that uses the Event module and loads |
89 | This is a simple example that uses the EV module and loads /etc/passwd |
89 | /etc/passwd asynchronously: |
90 | asynchronously: |
90 | |
91 | |
91 | use Fcntl; |
92 | use Fcntl; |
92 | use Event; |
93 | use EV; |
93 | use IO::AIO; |
94 | use IO::AIO; |
94 | |
95 | |
95 | # register the IO::AIO callback with Event |
96 | # register the IO::AIO callback with EV |
96 | Event->io (fd => IO::AIO::poll_fileno, |
97 | my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
97 | poll => 'r', |
|
|
98 | cb => \&IO::AIO::poll_cb); |
|
|
99 | |
98 | |
100 | # queue the request to open /etc/passwd |
99 | # queue the request to open /etc/passwd |
101 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
100 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
102 | my $fh = shift |
101 | my $fh = shift |
103 | or die "error while opening: $!"; |
102 | or die "error while opening: $!"; |
… | |
… | |
115 | |
114 | |
116 | # file contents now in $contents |
115 | # file contents now in $contents |
117 | print $contents; |
116 | print $contents; |
118 | |
117 | |
119 | # exit event loop and program |
118 | # exit event loop and program |
120 | Event::unloop; |
119 | EV::unloop; |
121 | }; |
120 | }; |
122 | }; |
121 | }; |
123 | |
122 | |
124 | # possibly queue up other requests, or open GUI windows, |
123 | # possibly queue up other requests, or open GUI windows, |
125 | # check for sockets etc. etc. |
124 | # check for sockets etc. etc. |
126 | |
125 | |
127 | # process events as long as there are some: |
126 | # process events as long as there are some: |
128 | Event::loop; |
127 | EV::loop; |
129 | |
128 | |
130 | REQUEST ANATOMY AND LIFETIME |
129 | REQUEST ANATOMY AND LIFETIME |
131 | Every "aio_*" function creates a request. which is a C data structure |
130 | Every "aio_*" function creates a request. which is a C data structure |
132 | not directly visible to Perl. |
131 | not directly visible to Perl. |
133 | |
132 | |
… | |
… | |
275 | Or in other words: the file descriptor will be closed, but it will |
274 | Or in other words: the file descriptor will be closed, but it will |
276 | not be free for reuse until the perl filehandle is closed. |
275 | not be free for reuse until the perl filehandle is closed. |
277 | |
276 | |
278 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
277 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
279 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
278 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
280 | Reads or writes $length bytes from the specified $fh and $offset |
279 | Reads or writes $length bytes from or to the specified $fh and |
281 | into the scalar given by $data and offset $dataoffset and calls the |
280 | $offset into the scalar given by $data and offset $dataoffset and |
282 | callback without the actual number of bytes read (or -1 on error, |
281 | calls the callback without the actual number of bytes read (or -1 on |
283 | just like the syscall). |
282 | error, just like the syscall). |
|
|
283 | |
|
|
284 | "aio_read" will, like "sysread", shrink or grow the $data scalar to |
|
|
285 | offset plus the actual number of bytes read. |
284 | |
286 | |
285 | If $offset is undefined, then the current file descriptor offset |
287 | If $offset is undefined, then the current file descriptor offset |
286 | will be used (and updated), otherwise the file descriptor offset |
288 | will be used (and updated), otherwise the file descriptor offset |
287 | will not be changed by these calls. |
289 | will not be changed by these calls. |
288 | |
290 | |
… | |
… | |
313 | |
315 | |
314 | This call tries to make use of a native "sendfile" syscall to |
316 | This call tries to make use of a native "sendfile" syscall to |
315 | provide zero-copy operation. For this to work, $out_fh should refer |
317 | provide zero-copy operation. For this to work, $out_fh should refer |
316 | to a socket, and $in_fh should refer to mmap'able file. |
318 | to a socket, and $in_fh should refer to mmap'able file. |
317 | |
319 | |
318 | If the native sendfile call fails or is not implemented, it will be |
320 | If a native sendfile cannot be found or it fails with "ENOSYS", |
|
|
321 | "ENOTSUP", "EOPNOTSUPP", "EAFNOSUPPORT", "EPROTOTYPE" or "ENOTSOCK", |
319 | emulated, so you can call "aio_sendfile" on any type of filehandle |
322 | it will be emulated, so you can call "aio_sendfile" on any type of |
320 | regardless of the limitations of the operating system. |
323 | filehandle regardless of the limitations of the operating system. |
321 | |
324 | |
322 | Please note, however, that "aio_sendfile" can read more bytes from |
325 | Please note, however, that "aio_sendfile" can read more bytes from |
323 | $in_fh than are written, and there is no way to find out how many |
326 | $in_fh than are written, and there is no way to find out how many |
324 | bytes have been read from "aio_sendfile" alone, as "aio_sendfile" |
327 | bytes have been read from "aio_sendfile" alone, as "aio_sendfile" |
325 | only provides the number of bytes written to $out_fh. Only if the |
328 | only provides the number of bytes written to $out_fh. Only if the |
… | |
… | |
439 | aio_readdir $pathname, $callback->($entries) |
442 | aio_readdir $pathname, $callback->($entries) |
440 | Unlike the POSIX call of the same name, "aio_readdir" reads an |
443 | Unlike the POSIX call of the same name, "aio_readdir" reads an |
441 | entire directory (i.e. opendir + readdir + closedir). The entries |
444 | entire directory (i.e. opendir + readdir + closedir). The entries |
442 | will not be sorted, and will NOT include the "." and ".." entries. |
445 | will not be sorted, and will NOT include the "." and ".." entries. |
443 | |
446 | |
444 | The callback a single argument which is either "undef" or an |
447 | The callback is passed a single argument which is either "undef" or |
445 | array-ref with the filenames. |
448 | an array-ref with the filenames. |
|
|
449 | |
|
|
450 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
|
|
451 | Quite similar to "aio_readdir", but the $flags argument allows to |
|
|
452 | tune behaviour and output format. In case of an error, $entries will |
|
|
453 | be "undef". |
|
|
454 | |
|
|
455 | The flags are a combination of the following constants, ORed |
|
|
456 | together (the flags will also be passed to the callback, possibly |
|
|
457 | modified): |
|
|
458 | |
|
|
459 | IO::AIO::READDIR_DENTS |
|
|
460 | When this flag is off, then the callback gets an arrayref with |
|
|
461 | of names only (as with "aio_readdir"), otherwise it gets an |
|
|
462 | arrayref with "[$name, $type, $inode]" arrayrefs, each |
|
|
463 | describing a single directory entry in more detail. |
|
|
464 | |
|
|
465 | $name is the name of the entry. |
|
|
466 | |
|
|
467 | $type is one of the "IO::AIO::DT_xxx" constants: |
|
|
468 | |
|
|
469 | "IO::AIO::DT_UNKNOWN", "IO::AIO::DT_FIFO", "IO::AIO::DT_CHR", |
|
|
470 | "IO::AIO::DT_DIR", "IO::AIO::DT_BLK", "IO::AIO::DT_REG", |
|
|
471 | "IO::AIO::DT_LNK", "IO::AIO::DT_SOCK", "IO::AIO::DT_WHT". |
|
|
472 | |
|
|
473 | "IO::AIO::DT_UNKNOWN" means just that: readdir does not know. If |
|
|
474 | you need to know, you have to run stat yourself. Also, for speed |
|
|
475 | reasons, the $type scalars are read-only: you can not modify |
|
|
476 | them. |
|
|
477 | |
|
|
478 | $inode is the inode number (which might not be exact on systems |
|
|
479 | with 64 bit inode numbers and 32 bit perls). This field has |
|
|
480 | unspecified content on systems that do not deliver the inode |
|
|
481 | information. |
|
|
482 | |
|
|
483 | IO::AIO::READDIR_DIRS_FIRST |
|
|
484 | When this flag is set, then the names will be returned in an |
|
|
485 | order where likely directories come first. This is useful when |
|
|
486 | you need to quickly find directories, or you want to find all |
|
|
487 | directories while avoiding to stat() each entry. |
|
|
488 | |
|
|
489 | If the system returns type information in readdir, then this is |
|
|
490 | used to find directories directly. Otherwise, likely directories |
|
|
491 | are files beginning with ".", or otherwise files with no dots, |
|
|
492 | of which files with short names are tried first. |
|
|
493 | |
|
|
494 | IO::AIO::READDIR_STAT_ORDER |
|
|
495 | When this flag is set, then the names will be returned in an |
|
|
496 | order suitable for stat()'ing each one. That is, when you plan |
|
|
497 | to stat() all files in the given directory, then the returned |
|
|
498 | order will likely be fastest. |
|
|
499 | |
|
|
500 | If both this flag and "IO::AIO::READDIR_DIRS_FIRST" are |
|
|
501 | specified, then the likely dirs come first, resulting in a less |
|
|
502 | optimal stat order. |
|
|
503 | |
|
|
504 | IO::AIO::READDIR_FOUND_UNKNOWN |
|
|
505 | This flag should not be set when calling "aio_readdirx". |
|
|
506 | Instead, it is being set by "aio_readdirx", when any of the |
|
|
507 | $type's found were "IO::AIO::DT_UNKNOWN". The absense of this |
|
|
508 | flag therefore indicates that all $type's are known, which can |
|
|
509 | be used to speed up some algorithms. |
446 | |
510 | |
447 | aio_load $path, $data, $callback->($status) |
511 | aio_load $path, $data, $callback->($status) |
448 | This is a composite request that tries to fully load the given file |
512 | This is a composite request that tries to fully load the given file |
449 | into memory. Status is the same as with aio_read. |
513 | into memory. Status is the same as with aio_read. |
450 | |
514 | |
451 | aio_copy $srcpath, $dstpath, $callback->($status) |
515 | aio_copy $srcpath, $dstpath, $callback->($status) |
452 | Try to copy the *file* (directories not supported as either source |
516 | Try to copy the *file* (directories not supported as either source |
453 | or destination) from $srcpath to $dstpath and call the callback with |
517 | or destination) from $srcpath to $dstpath and call the callback with |
454 | the 0 (error) or -1 ok. |
518 | a status of 0 (ok) or -1 (error, see $!). |
455 | |
519 | |
456 | This is a composite request that creates the destination file with |
520 | This is a composite request that creates the destination file with |
457 | mode 0200 and copies the contents of the source file into it using |
521 | mode 0200 and copies the contents of the source file into it using |
458 | "aio_sendfile", followed by restoring atime, mtime, access mode and |
522 | "aio_sendfile", followed by restoring atime, mtime, access mode and |
459 | uid/gid, in that order. |
523 | uid/gid, in that order. |
… | |
… | |
463 | uid/gid, where errors are being ignored. |
527 | uid/gid, where errors are being ignored. |
464 | |
528 | |
465 | aio_move $srcpath, $dstpath, $callback->($status) |
529 | aio_move $srcpath, $dstpath, $callback->($status) |
466 | Try to move the *file* (directories not supported as either source |
530 | Try to move the *file* (directories not supported as either source |
467 | or destination) from $srcpath to $dstpath and call the callback with |
531 | or destination) from $srcpath to $dstpath and call the callback with |
468 | the 0 (error) or -1 ok. |
532 | a status of 0 (ok) or -1 (error, see $!). |
469 | |
533 | |
470 | This is a composite request that tries to rename(2) the file first; |
534 | This is a composite request that tries to rename(2) the file first; |
471 | if rename fails with "EXDEV", it copies the file with "aio_copy" |
535 | if rename fails with "EXDEV", it copies the file with "aio_copy" |
472 | and, if that is successful, unlinks the $srcpath. |
536 | and, if that is successful, unlinks the $srcpath. |
473 | |
537 | |
… | |
… | |
497 | Implementation notes. |
561 | Implementation notes. |
498 | |
562 | |
499 | The "aio_readdir" cannot be avoided, but "stat()"'ing every entry |
563 | The "aio_readdir" cannot be avoided, but "stat()"'ing every entry |
500 | can. |
564 | can. |
501 | |
565 | |
|
|
566 | If readdir returns file type information, then this is used directly |
|
|
567 | to find directories. |
|
|
568 | |
502 | After reading the directory, the modification time, size etc. of the |
569 | Otherwise, after reading the directory, the modification time, size |
503 | directory before and after the readdir is checked, and if they match |
570 | etc. of the directory before and after the readdir is checked, and |
504 | (and isn't the current time), the link count will be used to decide |
571 | if they match (and isn't the current time), the link count will be |
505 | how many entries are directories (if >= 2). Otherwise, no knowledge |
572 | used to decide how many entries are directories (if >= 2). |
506 | of the number of subdirectories will be assumed. |
573 | Otherwise, no knowledge of the number of subdirectories will be |
|
|
574 | assumed. |
507 | |
575 | |
508 | Then entries will be sorted into likely directories (everything |
576 | Then entries will be sorted into likely directories a non-initial |
509 | without a non-initial dot currently) and likely non-directories |
577 | dot currently) and likely non-directories (see "aio_readdirx"). Then |
510 | (everything else). Then every entry plus an appended "/." will be |
578 | every entry plus an appended "/." will be "stat"'ed, likely |
511 | "stat"'ed, likely directories first. If that succeeds, it assumes |
579 | directories first, in order of their inode numbers. If that |
512 | that the entry is a directory or a symlink to directory (which will |
580 | succeeds, it assumes that the entry is a directory or a symlink to |
513 | be checked seperately). This is often faster than stat'ing the entry |
581 | directory (which will be checked seperately). This is often faster |
514 | itself because filesystems might detect the type of the entry |
582 | than stat'ing the entry itself because filesystems might detect the |
515 | without reading the inode data (e.g. ext2fs filetype feature). |
583 | type of the entry without reading the inode data (e.g. ext2fs |
|
|
584 | filetype feature), even on systems that cannot return the filetype |
|
|
585 | information on readdir. |
516 | |
586 | |
517 | If the known number of directories (link count - 2) has been |
587 | If the known number of directories (link count - 2) has been |
518 | reached, the rest of the entries is assumed to be non-directories. |
588 | reached, the rest of the entries is assumed to be non-directories. |
519 | |
589 | |
520 | This only works with certainty on POSIX (= UNIX) filesystems, which |
590 | This only works with certainty on POSIX (= UNIX) filesystems, which |
… | |
… | |
562 | operations (E.g. rename). This might not work on all operating |
632 | operations (E.g. rename). This might not work on all operating |
563 | systems or have any specific effect, but usually it makes sure that |
633 | systems or have any specific effect, but usually it makes sure that |
564 | directory changes get written to disc. It works for anything that |
634 | directory changes get written to disc. It works for anything that |
565 | can be opened for read-only, not just directories. |
635 | can be opened for read-only, not just directories. |
566 | |
636 | |
|
|
637 | Future versions of this function might fall back to other methods |
|
|
638 | when "fsync" on the directory fails (such as calling "sync"). |
|
|
639 | |
567 | Passes 0 when everything went ok, and -1 on error. |
640 | Passes 0 when everything went ok, and -1 on error. |
|
|
641 | |
|
|
642 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, |
|
|
643 | $callback->($status) |
|
|
644 | This is a rather advanced IO::AIO call, which only works on |
|
|
645 | mmap(2)ed scalars (see the Sys::Mmap or Mmap modules for details on |
|
|
646 | this, note that the scalar must only be modified in-place while an |
|
|
647 | aio operation is pending on it). |
|
|
648 | |
|
|
649 | It calls the "msync" function of your OS, if available, with the |
|
|
650 | memory area starting at $offset in the string and ending $length |
|
|
651 | bytes later. If $length is negative, counts from the end, and if |
|
|
652 | $length is "undef", then it goes till the end of the string. The |
|
|
653 | flags can be a combination of "IO::AIO::MS_ASYNC", |
|
|
654 | "IO::AIO::MS_INVALIDATE" and "IO::AIO::MS_SYNC". |
|
|
655 | |
|
|
656 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, |
|
|
657 | $callback->($status) |
|
|
658 | This is a rather advanced IO::AIO call, which works best on |
|
|
659 | mmap(2)ed scalars. |
|
|
660 | |
|
|
661 | It touches (reads or writes) all memory pages in the specified range |
|
|
662 | inside the scalar. All caveats and parameters are the same as for |
|
|
663 | "aio_msync", above, except for flags, which must be either 0 (which |
|
|
664 | reads all pages and ensures they are instantiated) or |
|
|
665 | "IO::AIO::MT_MODIFY", which modifies the memory page s(by reading |
|
|
666 | and writing an octet from it, which dirties the page). |
568 | |
667 | |
569 | aio_group $callback->(...) |
668 | aio_group $callback->(...) |
570 | This is a very special aio request: Instead of doing something, it |
669 | This is a very special aio request: Instead of doing something, it |
571 | is a container for other aio requests, which is useful if you want |
670 | is a container for other aio requests, which is useful if you want |
572 | to bundle many requests into a single, composite, request with a |
671 | to bundle many requests into a single, composite, request with a |
… | |
… | |
615 | |
714 | |
616 | cancel $req |
715 | cancel $req |
617 | Cancels the request, if possible. Has the effect of skipping |
716 | Cancels the request, if possible. Has the effect of skipping |
618 | execution when entering the execute state and skipping calling the |
717 | execution when entering the execute state and skipping calling the |
619 | callback when entering the the result state, but will leave the |
718 | callback when entering the the result state, but will leave the |
620 | request otherwise untouched. That means that requests that currently |
719 | request otherwise untouched (with the exception of readdir). That |
621 | execute will not be stopped and resources held by the request will |
720 | means that requests that currently execute will not be stopped and |
622 | not be freed prematurely. |
721 | resources held by the request will not be freed prematurely. |
623 | |
722 | |
624 | cb $req $callback->(...) |
723 | cb $req $callback->(...) |
625 | Replace (or simply set) the callback registered to the request. |
724 | Replace (or simply set) the callback registered to the request. |
626 | |
725 | |
627 | IO::AIO::GRP CLASS |
726 | IO::AIO::GRP CLASS |
… | |
… | |
688 | |
787 | |
689 | $grp->cancel_subs |
788 | $grp->cancel_subs |
690 | Cancel all subrequests and clears any feeder, but not the group |
789 | Cancel all subrequests and clears any feeder, but not the group |
691 | request itself. Useful when you queued a lot of events but got a |
790 | request itself. Useful when you queued a lot of events but got a |
692 | result early. |
791 | result early. |
|
|
792 | |
|
|
793 | The group request will finish normally (you cannot add requests to |
|
|
794 | the group). |
693 | |
795 | |
694 | $grp->result (...) |
796 | $grp->result (...) |
695 | Set the result value(s) that will be passed to the group callback |
797 | Set the result value(s) that will be passed to the group callback |
696 | when all subrequests have finished and set the groups errno to the |
798 | when all subrequests have finished and set the groups errno to the |
697 | current value of errno (just like calling "errno" without an error |
799 | current value of errno (just like calling "errno" without an error |
… | |
… | |
757 | SUPPORT FUNCTIONS |
859 | SUPPORT FUNCTIONS |
758 | EVENT PROCESSING AND EVENT LOOP INTEGRATION |
860 | EVENT PROCESSING AND EVENT LOOP INTEGRATION |
759 | $fileno = IO::AIO::poll_fileno |
861 | $fileno = IO::AIO::poll_fileno |
760 | Return the *request result pipe file descriptor*. This filehandle |
862 | Return the *request result pipe file descriptor*. This filehandle |
761 | must be polled for reading by some mechanism outside this module |
863 | must be polled for reading by some mechanism outside this module |
762 | (e.g. Event or select, see below or the SYNOPSIS). If the pipe |
864 | (e.g. EV, Glib, select and so on, see below or the SYNOPSIS). If the |
763 | becomes readable you have to call "poll_cb" to check the results. |
865 | pipe becomes readable you have to call "poll_cb" to check the |
|
|
866 | results. |
764 | |
867 | |
765 | See "poll_cb" for an example. |
868 | See "poll_cb" for an example. |
766 | |
869 | |
767 | IO::AIO::poll_cb |
870 | IO::AIO::poll_cb |
768 | Process some outstanding events on the result pipe. You have to call |
871 | Process some outstanding events on the result pipe. You have to call |
… | |
… | |
775 | If not all requests were processed for whatever reason, the |
878 | If not all requests were processed for whatever reason, the |
776 | filehandle will still be ready when "poll_cb" returns, so normally |
879 | filehandle will still be ready when "poll_cb" returns, so normally |
777 | you don't have to do anything special to have it called later. |
880 | you don't have to do anything special to have it called later. |
778 | |
881 | |
779 | Example: Install an Event watcher that automatically calls |
882 | Example: Install an Event watcher that automatically calls |
780 | IO::AIO::poll_cb with high priority: |
883 | IO::AIO::poll_cb with high priority (more examples can be found in |
|
|
884 | the SYNOPSIS section, at the top of this document): |
781 | |
885 | |
782 | Event->io (fd => IO::AIO::poll_fileno, |
886 | Event->io (fd => IO::AIO::poll_fileno, |
783 | poll => 'r', async => 1, |
887 | poll => 'r', async => 1, |
784 | cb => \&IO::AIO::poll_cb); |
888 | cb => \&IO::AIO::poll_cb); |
785 | |
889 | |
… | |
… | |
925 | |
1029 | |
926 | IO::AIO::npending |
1030 | IO::AIO::npending |
927 | Returns the number of requests currently in the pending state |
1031 | Returns the number of requests currently in the pending state |
928 | (executed, but not yet processed by poll_cb). |
1032 | (executed, but not yet processed by poll_cb). |
929 | |
1033 | |
|
|
1034 | MISCELLANEOUS FUNCTIONS |
|
|
1035 | IO::AIO implements some functions that might be useful, but are not |
|
|
1036 | asynchronous. |
|
|
1037 | |
|
|
1038 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
|
|
1039 | Calls the "eio_sendfile_sync" function, which is like |
|
|
1040 | "aio_sendfile", but is blocking (this makes most sense if you know |
|
|
1041 | the input data is likely cached already and the output filehandle is |
|
|
1042 | set to non-blocking operations). |
|
|
1043 | |
|
|
1044 | Returns the number of bytes copied, or -1 on error. |
|
|
1045 | |
|
|
1046 | IO::AIO::fadvise $fh, $offset, $len, $advice |
|
|
1047 | Simply calls the "posix_fadvise" function (see it's manpage for |
|
|
1048 | details). The following advice constants are avaiable: |
|
|
1049 | "IO::AIO::FADV_NORMAL", "IO::AIO::FADV_SEQUENTIAL", |
|
|
1050 | "IO::AIO::FADV_RANDOM", "IO::AIO::FADV_NOREUSE", |
|
|
1051 | "IO::AIO::FADV_WILLNEED", "IO::AIO::FADV_DONTNEED". |
|
|
1052 | |
|
|
1053 | On systems that do not implement "posix_fadvise", this function |
|
|
1054 | returns ENOSYS, otherwise the return value of "posix_fadvise". |
|
|
1055 | |
930 | FORK BEHAVIOUR |
1056 | FORK BEHAVIOUR |
931 | This module should do "the right thing" when the process using it forks: |
1057 | This module should do "the right thing" when the process using it forks: |
932 | |
1058 | |
933 | Before the fork, IO::AIO enters a quiescent state where no requests can |
1059 | Before the fork, IO::AIO enters a quiescent state where no requests can |
934 | be added in other threads and no results will be processed. After the |
1060 | be added in other threads and no results will be processed. After the |