… | |
… | |
168 | use common::sense; |
168 | use common::sense; |
169 | |
169 | |
170 | use base 'Exporter'; |
170 | use base 'Exporter'; |
171 | |
171 | |
172 | BEGIN { |
172 | BEGIN { |
173 | our $VERSION = '3.72'; |
173 | our $VERSION = '3.8'; |
174 | |
174 | |
175 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
175 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
176 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
176 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
177 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
177 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
178 | aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead |
178 | aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead |
… | |
… | |
668 | |
668 | |
669 | =over 4 |
669 | =over 4 |
670 | |
670 | |
671 | =item IO::AIO::READDIR_DENTS |
671 | =item IO::AIO::READDIR_DENTS |
672 | |
672 | |
673 | When this flag is off, then the callback gets an arrayref with of names |
673 | When this flag is off, then the callback gets an arrayref consisting of |
674 | only (as with C<aio_readdir>), otherwise it gets an arrayref with |
674 | names only (as with C<aio_readdir>), otherwise it gets an arrayref with |
675 | C<[$name, $type, $inode]> arrayrefs, each describing a single directory |
675 | C<[$name, $type, $inode]> arrayrefs, each describing a single directory |
676 | entry in more detail. |
676 | entry in more detail. |
677 | |
677 | |
678 | C<$name> is the name of the entry. |
678 | C<$name> is the name of the entry. |
679 | |
679 | |
… | |
… | |
692 | systems that do not deliver the inode information. |
692 | systems that do not deliver the inode information. |
693 | |
693 | |
694 | =item IO::AIO::READDIR_DIRS_FIRST |
694 | =item IO::AIO::READDIR_DIRS_FIRST |
695 | |
695 | |
696 | When this flag is set, then the names will be returned in an order where |
696 | When this flag is set, then the names will be returned in an order where |
697 | likely directories come first. This is useful when you need to quickly |
697 | likely directories come first, in optimal stat order. This is useful when |
698 | find directories, or you want to find all directories while avoiding to |
698 | you need to quickly find directories, or you want to find all directories |
699 | stat() each entry. |
699 | while avoiding to stat() each entry. |
700 | |
700 | |
701 | If the system returns type information in readdir, then this is used |
701 | If the system returns type information in readdir, then this is used |
702 | to find directories directly. Otherwise, likely directories are files |
702 | to find directories directly. Otherwise, likely directories are names |
703 | beginning with ".", or otherwise files with no dots, of which files with |
703 | beginning with ".", or otherwise names with no dots, of which names with |
704 | short names are tried first. |
704 | short names are tried first. |
705 | |
705 | |
706 | =item IO::AIO::READDIR_STAT_ORDER |
706 | =item IO::AIO::READDIR_STAT_ORDER |
707 | |
707 | |
708 | When this flag is set, then the names will be returned in an order |
708 | When this flag is set, then the names will be returned in an order |
… | |
… | |
1406 | |
1406 | |
1407 | See C<poll_cb> for an example. |
1407 | See C<poll_cb> for an example. |
1408 | |
1408 | |
1409 | =item IO::AIO::poll_cb |
1409 | =item IO::AIO::poll_cb |
1410 | |
1410 | |
1411 | Process some outstanding events on the result pipe. You have to call this |
1411 | Process some outstanding events on the result pipe. You have to call |
1412 | regularly. Returns C<0> if all events could be processed, or C<-1> if it |
1412 | this regularly. Returns C<0> if all events could be processed (or there |
1413 | returned earlier for whatever reason. Returns immediately when no events |
1413 | were no events to process), or C<-1> if it returned earlier for whatever |
1414 | are outstanding. The amount of events processed depends on the settings of |
1414 | reason. Returns immediately when no events are outstanding. The amount of |
1415 | C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. |
1415 | events processed depends on the settings of C<IO::AIO::max_poll_req> and |
|
|
1416 | C<IO::AIO::max_poll_time>. |
1416 | |
1417 | |
1417 | If not all requests were processed for whatever reason, the filehandle |
1418 | If not all requests were processed for whatever reason, the filehandle |
1418 | will still be ready when C<poll_cb> returns, so normally you don't have to |
1419 | will still be ready when C<poll_cb> returns, so normally you don't have to |
1419 | do anything special to have it called later. |
1420 | do anything special to have it called later. |
|
|
1421 | |
|
|
1422 | Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes |
|
|
1423 | ready, it can be beneficial to call this function from loops which submit |
|
|
1424 | a lot of requests, to make sure the results get processed when they become |
|
|
1425 | available and not just when the loop is finished and the event loop takes |
|
|
1426 | over again. This function returns very fast when there are no outstanding |
|
|
1427 | requests. |
1420 | |
1428 | |
1421 | Example: Install an Event watcher that automatically calls |
1429 | Example: Install an Event watcher that automatically calls |
1422 | IO::AIO::poll_cb with high priority (more examples can be found in the |
1430 | IO::AIO::poll_cb with high priority (more examples can be found in the |
1423 | SYNOPSIS section, at the top of this document): |
1431 | SYNOPSIS section, at the top of this document): |
1424 | |
1432 | |