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

Comparing IO-AIO/README (file contents):
Revision 1.61 by root, Sun Aug 12 06:07:06 2018 UTC vs.
Revision 1.66 by root, Tue Dec 29 15:20:12 2020 UTC

221 IO::AIO::idle_timeout $seconds 221 IO::AIO::idle_timeout $seconds
222 IO::AIO::max_outstanding $maxreqs 222 IO::AIO::max_outstanding $maxreqs
223 IO::AIO::nreqs 223 IO::AIO::nreqs
224 IO::AIO::nready 224 IO::AIO::nready
225 IO::AIO::npending 225 IO::AIO::npending
226 IO::AIO::reinit
227
226 $nfd = IO::AIO::get_fdlimit [EXPERIMENTAL] 228 $nfd = IO::AIO::get_fdlimit
227 IO::AIO::min_fdlimit $nfd [EXPERIMENTAL] 229 IO::AIO::min_fdlimit $nfd
228 230
229 IO::AIO::sendfile $ofh, $ifh, $offset, $count 231 IO::AIO::sendfile $ofh, $ifh, $offset, $count
230 IO::AIO::fadvise $fh, $offset, $len, $advice 232 IO::AIO::fadvise $fh, $offset, $len, $advice
233
231 IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] 234 IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
232 IO::AIO::munmap $scalar 235 IO::AIO::munmap $scalar
233 IO::AIO::mremap $scalar, $new_length, $flags[, $new_address] 236 IO::AIO::mremap $scalar, $new_length, $flags[, $new_address]
234 IO::AIO::madvise $scalar, $offset, $length, $advice 237 IO::AIO::madvise $scalar, $offset, $length, $advice
235 IO::AIO::mprotect $scalar, $offset, $length, $protect 238 IO::AIO::mprotect $scalar, $offset, $length, $protect
236 IO::AIO::munlock $scalar, $offset = 0, $length = undef 239 IO::AIO::munlock $scalar, $offset = 0, $length = undef
237 IO::AIO::munlockall 240 IO::AIO::munlockall
241
242 # stat extensions
243 $counter = IO::AIO::st_gen
244 $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime
245 ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
246 $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec
247 $seconds = IO::AIO::st_btimesec
248 ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
249
250 # very much unportable syscalls
251 IO::AIO::accept4 $r_fh, $sockaddr, $sockaddr_len, $flags
252 IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
253 IO::AIO::tee $r_fh, $w_fh, $length, $flags
254 $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
255 ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
256 $fh = IO::AIO::memfd_create $pathname[, $flags]
257 $fh = IO::AIO::eventfd [$initval, [$flags]]
258 $fh = IO::AIO::timerfd_create $clockid[, $flags]
259 ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
260 ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
238 261
239 API NOTES 262 API NOTES
240 All the "aio_*" calls are more or less thin wrappers around the syscall 263 All the "aio_*" calls are more or less thin wrappers around the syscall
241 with the same name (sans "aio_"). The arguments are similar or 264 with the same name (sans "aio_"). The arguments are similar or
242 identical, and they all accept an additional (and optional) $callback 265 identical, and they all accept an additional (and optional) $callback
469 will be emulated by simply reading the data, which would have a 492 will be emulated by simply reading the data, which would have a
470 similar effect. 493 similar effect.
471 494
472 aio_stat $fh_or_path, $callback->($status) 495 aio_stat $fh_or_path, $callback->($status)
473 aio_lstat $fh, $callback->($status) 496 aio_lstat $fh, $callback->($status)
474 Works like perl's "stat" or "lstat" in void context. The callback 497 Works almost exactly like perl's "stat" or "lstat" in void context.
475 will be called after the stat and the results will be available 498 The callback will be called after the stat and the results will be
476 using "stat _" or "-s _" etc... 499 available using "stat _" or "-s _" and other tests (with the
500 exception of "-B" and "-T").
477 501
478 The pathname passed to "aio_stat" must be absolute. See API NOTES, 502 The pathname passed to "aio_stat" must be absolute. See API NOTES,
479 above, for an explanation. 503 above, for an explanation.
480 504
481 Currently, the stats are always 64-bit-stats, i.e. instead of 505 Currently, the stats are always 64-bit-stats, i.e. instead of
548 aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 572 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
549 Works like perl's "utime" function (including the special case of 573 Works like perl's "utime" function (including the special case of
550 $atime and $mtime being undef). Fractional times are supported if 574 $atime and $mtime being undef). Fractional times are supported if
551 the underlying syscalls support them. 575 the underlying syscalls support them.
552 576
553 When called with a pathname, uses utimes(2) if available, otherwise 577 When called with a pathname, uses utimensat(2) or utimes(2) if
554 utime(2). If called on a file descriptor, uses futimes(2) if 578 available, otherwise utime(2). If called on a file descriptor, uses
555 available, otherwise returns ENOSYS, so this is not portable. 579 futimens(2) or futimes(2) if available, otherwise returns ENOSYS, so
580 this is not portable.
556 581
557 Examples: 582 Examples:
558 583
559 # set atime and mtime to current time (basically touch(1)): 584 # set atime and mtime to current time (basically touch(1)):
560 aio_utime "path", undef, undef; 585 aio_utime "path", undef, undef;
885 So in general, you should only use these calls for things that do 910 So in general, you should only use these calls for things that do
886 (filesystem) I/O, not for things that wait for other events 911 (filesystem) I/O, not for things that wait for other events
887 (network, other processes), although if you are careful and know 912 (network, other processes), although if you are careful and know
888 what you are doing, you still can. 913 what you are doing, you still can.
889 914
890 The following constants are available (missing ones are, as usual 915 The following constants are available and can be used for normal
891 0): 916 "ioctl" and "fcntl" as well (missing ones are, as usual 0):
892 917
893 "F_DUPFD_CLOEXEC", 918 "F_DUPFD_CLOEXEC",
894 919
895 "F_OFD_GETLK", "F_OFD_SETLK", "F_OFD_GETLKW", 920 "F_OFD_GETLK", "F_OFD_SETLK", "F_OFD_GETLKW",
896 921
897 "FIFREEZE", "FITHAW", "FITRIM", "FICLONE", "FICLONERANGE", 922 "FIFREEZE", "FITHAW", "FITRIM", "FICLONE", "FICLONERANGE",
898 "FIDEDUPERANGE". 923 "FIDEDUPERANGE".
924
925 "F_ADD_SEALS", "F_GET_SEALS", "F_SEAL_SEAL", "F_SEAL_SHRINK",
926 "F_SEAL_GROW" and "F_SEAL_WRITE".
899 927
900 "FS_IOC_GETFLAGS", "FS_IOC_SETFLAGS", "FS_IOC_GETVERSION", 928 "FS_IOC_GETFLAGS", "FS_IOC_SETFLAGS", "FS_IOC_GETVERSION",
901 "FS_IOC_SETVERSION", "FS_IOC_FIEMAP". 929 "FS_IOC_SETVERSION", "FS_IOC_FIEMAP".
902 930
903 "FS_IOC_FSGETXATTR", "FS_IOC_FSSETXATTR", 931 "FS_IOC_FSGETXATTR", "FS_IOC_FSSETXATTR",
1014 IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; 1042 IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
1015 aio_mlock $data; # mlock in background 1043 aio_mlock $data; # mlock in background
1016 1044
1017 aio_mlockall $flags, $callback->($status) 1045 aio_mlockall $flags, $callback->($status)
1018 Calls the "mlockall" function with the given $flags (a combination 1046 Calls the "mlockall" function with the given $flags (a combination
1019 of "IO::AIO::MCL_CURRENT" and "IO::AIO::MCL_FUTURE"). 1047 of "IO::AIO::MCL_CURRENT", "IO::AIO::MCL_FUTURE" and
1048 "IO::AIO::MCL_ONFAULT").
1020 1049
1021 On systems that do not implement "mlockall", this function returns 1050 On systems that do not implement "mlockall", this function returns
1022 -1 and sets errno to "ENOSYS". 1051 -1 and sets errno to "ENOSYS". Similarly, flag combinations not
1052 supported by the system result in a return value of -1 with errno
1053 being set to "EINVAL".
1023 1054
1024 Note that the corresponding "munlockall" is synchronous and is 1055 Note that the corresponding "munlockall" is synchronous and is
1025 documented under "MISCELLANEOUS FUNCTIONS". 1056 documented under "MISCELLANEOUS FUNCTIONS".
1026 1057
1027 Example: asynchronously lock all current and future pages into 1058 Example: asynchronously lock all current and future pages into
1216 fails the request with "ENOENT", there is often no need for error 1247 fails the request with "ENOENT", there is often no need for error
1217 checking in the "aio_wd" callback, as future requests using the 1248 checking in the "aio_wd" callback, as future requests using the
1218 value will fail in the expected way. 1249 value will fail in the expected way.
1219 1250
1220 IO::AIO::CWD 1251 IO::AIO::CWD
1221 This is a compiletime constant (object) that represents the process 1252 This is a compile time constant (object) that represents the process
1222 current working directory. 1253 current working directory.
1223 1254
1224 Specifying this object as working directory object for a pathname is 1255 Specifying this object as working directory object for a pathname is
1225 as if the pathname would be specified directly, without a directory 1256 as if the pathname would be specified directly, without a directory
1226 object. For example, these calls are functionally identical: 1257 object. For example, these calls are functionally identical:
1451 Strictly equivalent to: 1482 Strictly equivalent to:
1452 1483
1453 IO::AIO::poll_wait, IO::AIO::poll_cb 1484 IO::AIO::poll_wait, IO::AIO::poll_cb
1454 while IO::AIO::nreqs; 1485 while IO::AIO::nreqs;
1455 1486
1487 This function can be useful at program aborts, to make sure
1488 outstanding I/O has been done ("IO::AIO" uses an "END" block which
1489 already calls this function on normal exits), or when you are merely
1490 using "IO::AIO" for its more advanced functions, rather than for
1491 async I/O, e.g.:
1492
1493 my ($dirs, $nondirs);
1494 IO::AIO::aio_scandir "/tmp", 0, sub { ($dirs, $nondirs) = @_ };
1495 IO::AIO::flush;
1496 # $dirs, $nondirs are now set
1497
1456 IO::AIO::max_poll_reqs $nreqs 1498 IO::AIO::max_poll_reqs $nreqs
1457 IO::AIO::max_poll_time $seconds 1499 IO::AIO::max_poll_time $seconds
1458 These set the maximum number of requests (default 0, meaning 1500 These set the maximum number of requests (default 0, meaning
1459 infinity) that are being processed by "IO::AIO::poll_cb" in one 1501 infinity) that are being processed by "IO::AIO::poll_cb" in one
1460 call, respectively the maximum amount of time (default 0, meaning 1502 call, respectively the maximum amount of time (default 0, meaning
1614 1656
1615 On operating systems or file systems where subsecond time resolution is 1657 On operating systems or file systems where subsecond time resolution is
1616 not supported or could not be detected, a fractional part of 0 is 1658 not supported or could not be detected, a fractional part of 0 is
1617 returned, so it is always safe to call these functions. 1659 returned, so it is always safe to call these functions.
1618 1660
1619 $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime 1661 $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime,
1662 IO::AIO::st_btime
1620 Return the access, modication or change time, respectively, 1663 Return the access, modication, change or birth time, respectively,
1621 including fractional part. Due to the limited precision of floating 1664 including fractional part. Due to the limited precision of floating
1622 point, the accuracy on most platforms is only a bit better than 1665 point, the accuracy on most platforms is only a bit better than
1623 milliseconds for times around now - see the *nsec* function family, 1666 milliseconds for times around now - see the *nsec* function family,
1624 below, for full accuracy. 1667 below, for full accuracy.
1625 1668
1669 File birth time is only available when the OS and perl support it
1670 (on FreeBSD and NetBSD at the time of this writing, although support
1671 is adaptive, so if your OS/perl gains support, IO::AIO can take
1672 advantage of it). On systems where it isn't available, 0 is
1673 currently returned, but this might change to "undef" in a future
1674 version.
1675
1626 ($atime, $mtime, $ctime, ...) = IO::AIO::st_xtime 1676 ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
1627 Returns access, modification and change time all in one go, and 1677 Returns access, modification, change and birth time all in one go,
1628 maybe more times in the future version. 1678 and maybe more times in the future version.
1629 1679
1630 $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, 1680 $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec,
1631 IO::AIO::st_ctimensec 1681 IO::AIO::st_ctimensec, IO::AIO::st_btimensec
1632 Return the fractional access, modifcation or change time, in 1682 Return the fractional access, modifcation, change or birth time, in
1633 nanoseconds, as an integer in the range 0 to 999999999. 1683 nanoseconds, as an integer in the range 0 to 999999999.
1634 1684
1685 Note that no accessors are provided for access, modification and
1686 change times - you need to get those from "stat _" if required ("int
1687 IO::AIO::st_atime" and so on will *not* generally give you the
1688 correct value).
1689
1690 $seconds = IO::AIO::st_btimesec
1691 The (integral) seconds part of the file birth time, if available.
1692
1635 ($atime, $mtime, $ctime, ...) = IO::AIO::st_xtimensec 1693 ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
1636 Like the functions above, but returns all three times in one go (and 1694 Like the functions above, but returns all four times in one go (and
1637 maybe more in future versions). 1695 maybe more in future versions).
1696
1697 $counter = IO::AIO::st_gen
1698 Returns the generation counter (in practice this is just a random
1699 number) of the file. This is only available on platforms which have
1700 this member in their "struct stat" (most BSDs at the time of this
1701 writing) and generally only to the root usert. If unsupported, 0 is
1702 returned, but this might change to "undef" in a future version.
1638 1703
1639 Example: print the high resolution modification time of /etc, using 1704 Example: print the high resolution modification time of /etc, using
1640 "stat", and "IO::AIO::aio_stat". 1705 "stat", and "IO::AIO::aio_stat".
1641 1706
1642 if (stat "/etc") { 1707 if (stat "/etc") {
1662 some "Advanced I/O" function not available to in Perl, without going the 1727 some "Advanced I/O" function not available to in Perl, without going the
1663 "Asynchronous I/O" route. Many of these have an asynchronous "aio_*" 1728 "Asynchronous I/O" route. Many of these have an asynchronous "aio_*"
1664 counterpart. 1729 counterpart.
1665 1730
1666 $numfd = IO::AIO::get_fdlimit 1731 $numfd = IO::AIO::get_fdlimit
1667 This function is *EXPERIMENTAL* and subject to change.
1668
1669 Tries to find the current file descriptor limit and returns it, or 1732 Tries to find the current file descriptor limit and returns it, or
1670 "undef" and sets $! in case of an error. The limit is one larger 1733 "undef" and sets $! in case of an error. The limit is one larger
1671 than the highest valid file descriptor number. 1734 than the highest valid file descriptor number.
1672 1735
1673 IO::AIO::min_fdlimit [$numfd] 1736 IO::AIO::min_fdlimit [$numfd]
1674 This function is *EXPERIMENTAL* and subject to change.
1675
1676 Try to increase the current file descriptor limit(s) to at least 1737 Try to increase the current file descriptor limit(s) to at least
1677 $numfd by changing the soft or hard file descriptor resource limit. 1738 $numfd by changing the soft or hard file descriptor resource limit.
1678 If $numfd is missing, it will try to set a very high limit, although 1739 If $numfd is missing, it will try to set a very high limit, although
1679 this is not recommended when you know the actual minimum that you 1740 this is not recommended when you know the actual minimum that you
1680 require. 1741 require.
1815 version. 1876 version.
1816 1877
1817 On systems where this call is not supported or is not emulated, this 1878 On systems where this call is not supported or is not emulated, this
1818 call returns falls and sets $! to "ENOSYS". 1879 call returns falls and sets $! to "ENOSYS".
1819 1880
1881 IO::AIO::mlockall $flags
1882 Calls the "eio_mlockall_sync" function, which is like
1883 "aio_mlockall", but is blocking.
1884
1820 IO::AIO::munlock $scalar, $offset = 0, $length = undef 1885 IO::AIO::munlock $scalar, $offset = 0, $length = undef
1821 Calls the "munlock" function, undoing the effects of a previous 1886 Calls the "munlock" function, undoing the effects of a previous
1822 "aio_mlock" call (see its description for details). 1887 "aio_mlock" call (see its description for details).
1823 1888
1824 IO::AIO::munlockall 1889 IO::AIO::munlockall
1825 Calls the "munlockall" function. 1890 Calls the "munlockall" function.
1826 1891
1827 On systems that do not implement "munlockall", this function returns 1892 On systems that do not implement "munlockall", this function returns
1828 ENOSYS, otherwise the return value of "munlockall". 1893 ENOSYS, otherwise the return value of "munlockall".
1894
1895 $fh = IO::AIO::accept4 $r_fh, $sockaddr, $sockaddr_maxlen, $flags
1896 Uses the GNU/Linux accept4(2) syscall, if available, to accept a
1897 socket and return the new file handle on success, or sets $! and
1898 returns "undef" on error.
1899
1900 The remote name of the new socket will be stored in $sockaddr, which
1901 will be extended to allow for at least $sockaddr_maxlen octets. If
1902 the socket name does not fit into $sockaddr_maxlen octets, this is
1903 signaled by returning a longer string in $sockaddr, which might or
1904 might not be truncated.
1905
1906 To accept name-less sockets, use "undef" for $sockaddr and 0 for
1907 $sockaddr_maxlen.
1908
1909 The main reasons to use this syscall rather than portable accept(2)
1910 are that you can specify "SOCK_NONBLOCK" and/or "SOCK_CLOEXEC" flags
1911 and you can accept name-less sockets by specifying 0 for
1912 $sockaddr_maxlen, which is sadly not possible with perl's interface
1913 to "accept".
1829 1914
1830 IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags 1915 IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
1831 Calls the GNU/Linux splice(2) syscall, if available. If $r_off or 1916 Calls the GNU/Linux splice(2) syscall, if available. If $r_off or
1832 $w_off are "undef", then "NULL" is passed for these, otherwise they 1917 $w_off are "undef", then "NULL" is passed for these, otherwise they
1833 should be the file offset. 1918 should be the file offset.
1874 Example: create a pipe race-free w.r.t. threads and fork: 1959 Example: create a pipe race-free w.r.t. threads and fork:
1875 1960
1876 my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC 1961 my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC
1877 or die "pipe2: $!\n"; 1962 or die "pipe2: $!\n";
1878 1963
1964 $fh = IO::AIO::memfd_create $pathname[, $flags]
1965 This is a direct interface to the Linux memfd_create(2) system call.
1966 The (unhelpful) default for $flags is 0, but your default should be
1967 "IO::AIO::MFD_CLOEXEC".
1968
1969 On success, the new memfd filehandle is returned, otherwise returns
1970 "undef". If the memfd_create syscall is missing, fails with
1971 "ENOSYS".
1972
1973 Please refer to memfd_create(2) for more info on this call.
1974
1975 The following $flags values are available: "IO::AIO::MFD_CLOEXEC",
1976 "IO::AIO::MFD_ALLOW_SEALING" and "IO::AIO::MFD_HUGETLB".
1977
1978 Example: create a new memfd.
1979
1980 my $fh = IO::AIO::memfd_create "somenameforprocfd", IO::AIO::MFD_CLOEXEC
1981 or die "memfd_create: $!\n";
1982
1983 $fh = IO::AIO::pidfd_open $pid[, $flags]
1984 This is an interface to the Linux pidfd_open(2) system call. The
1985 default for $flags is 0.
1986
1987 On success, a new pidfd filehandle is returned (that is already set
1988 to close-on-exec), otherwise returns "undef". If the syscall is
1989 missing, fails with "ENOSYS".
1990
1991 Example: open pid 6341 as pidfd.
1992
1993 my $fh = IO::AIO::pidfd_open 6341
1994 or die "pidfd_open: $!\n";
1995
1996 $status = IO::AIO::pidfd_send_signal $pidfh, $signal[, $siginfo[,
1997 $flags]]
1998 This is an interface to the Linux pidfd_send_signal system call. The
1999 default for $siginfo is "undef" and the default for $flags is 0.
2000
2001 Returns the system call status. If the syscall is missing, fails
2002 with "ENOSYS".
2003
2004 When specified, $siginfo must be a reference to a hash with one or
2005 more of the following members:
2006
2007 code - the "si_code" member
2008 pid - the "si_pid" member
2009 uid - the "si_uid" member
2010 value_int - the "si_value.sival_int" member
2011 value_ptr - the "si_value.sival_ptr" member, specified as an integer
2012
2013 Example: send a SIGKILL to the specified process.
2014
2015 my $status = IO::AIO::pidfd_send_signal $pidfh, 9, undef
2016 and die "pidfd_send_signal: $!\n";
2017
2018 Example: send a SIGKILL to the specified process with extra data.
2019
2020 my $status = IO::AIO::pidfd_send_signal $pidfh, 9, { code => -1, value_int => 7 }
2021 and die "pidfd_send_signal: $!\n";
2022
2023 $fh = IO::AIO::pidfd_getfd $pidfh, $targetfd[, $flags]
2024 This is an interface to the Linux pidfd_getfd system call. The
2025 default for $flags is 0.
2026
2027 On success, returns a dup'ed copy of the target file descriptor
2028 (specified as an integer) returned (that is already set to
2029 close-on-exec), otherwise returns "undef". If the syscall is
2030 missing, fails with "ENOSYS".
2031
2032 Example: get a copy of standard error of another process and print
2033 soemthing to it.
2034
2035 my $errfh = IO::AIO::pidfd_getfd $pidfh, 2
2036 or die "pidfd_getfd: $!\n";
2037 print $errfh "stderr\n";
2038
1879 $fh = IO::AIO::eventfd [$initval, [$flags]] 2039 $fh = IO::AIO::eventfd [$initval, [$flags]]
1880 This is a direct interface to the Linux eventfd(2) system call. The 2040 This is a direct interface to the Linux eventfd(2) system call. The
1881 (unhelpful) defaults for $initval and $flags are 0 for both. 2041 (unhelpful) defaults for $initval and $flags are 0 for both.
1882 2042
1883 On success, the new eventfd filehandle is returned, otherwise 2043 On success, the new eventfd filehandle is returned, otherwise
1890 "IO::AIO::EFD_CLOEXEC", "IO::AIO::EFD_NONBLOCK" and 2050 "IO::AIO::EFD_CLOEXEC", "IO::AIO::EFD_NONBLOCK" and
1891 "IO::AIO::EFD_SEMAPHORE" (Linux 2.6.30). 2051 "IO::AIO::EFD_SEMAPHORE" (Linux 2.6.30).
1892 2052
1893 Example: create a new eventfd filehandle: 2053 Example: create a new eventfd filehandle:
1894 2054
1895 $fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC 2055 $fh = IO::AIO::eventfd 0, IO::AIO::EFD_CLOEXEC
1896 or die "eventfd: $!\n"; 2056 or die "eventfd: $!\n";
1897 2057
1898 $fh = IO::AIO::timerfd_create $clockid[, $flags] 2058 $fh = IO::AIO::timerfd_create $clockid[, $flags]
1899 This is a direct interface to the Linux timerfd_create(2) system 2059 This is a direct interface to the Linux timerfd_create(2) system
1900 call. The (unhelpful) default for $flags is 0. 2060 call. The (unhelpful) default for $flags is 0, but your default
2061 should be "IO::AIO::TFD_CLOEXEC".
1901 2062
1902 On success, the new timerfd filehandle is returned, otherwise 2063 On success, the new timerfd filehandle is returned, otherwise
1903 returns "undef". If the eventfd syscall is missing, fails with 2064 returns "undef". If the timerfd_create syscall is missing, fails
1904 "ENOSYS". 2065 with "ENOSYS".
1905 2066
1906 Please refer to timerfd_create(2) for more info on this call. 2067 Please refer to timerfd_create(2) for more info on this call.
1907 2068
1908 The following $clockid values are available: 2069 The following $clockid values are available:
1909 "IO::AIO::CLOCK_REALTIME", "IO::AIO::CLOCK_MONOTONIC" 2070 "IO::AIO::CLOCK_REALTIME", "IO::AIO::CLOCK_MONOTONIC"
2052 I am not sure anything can be done about this, so this is considered a 2213 I am not sure anything can be done about this, so this is considered a
2053 known issue, rather than a bug. 2214 known issue, rather than a bug.
2054 2215
2055SEE ALSO 2216SEE ALSO
2056 AnyEvent::AIO for easy integration into event loops, Coro::AIO for a 2217 AnyEvent::AIO for easy integration into event loops, Coro::AIO for a
2057 more natural syntax. 2218 more natural syntax and IO::FDPass for file descriptor passing.
2058 2219
2059AUTHOR 2220AUTHOR
2060 Marc Lehmann <schmorp@schmorp.de> 2221 Marc Lehmann <schmorp@schmorp.de>
2061 http://home.schmorp.de/ 2222 http://home.schmorp.de/
2062 2223

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines