Import translated manuals from JM CVS Repository.

[linuxjm/jm.git] / manual / LDP_man-pages / draft / man2 / io_getevents.2

.\" Copyright (C) 2003 Free Software Foundation, Inc.
.\" This file is distributed according to the GNU General Public License.
.\" See the file COPYING in the top level source directory for details.
.\"
.\" Japanese Version Copyright (c) 2003 Akihiro MOTOKI, all rights reserved.
.\" Translated Mon Mar  8 2003 by Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
.\"
.\"WORD:        completion queue        ´°Î»¥­¥å¡¼
.\"
.\" .de Sh \" Subsection
.\" .br
.\" .if t .Sp
.\" .ne 5
.\" .PP
.\" \fB\\$1\fP
.\" .PP
.\" ..
.\" .de Sp \" Vertical space (when we can't use .PP)
.\" .if t .sp .5v
.\" .if n .sp
.\" ..
.\" .de Ip \" List item
.\" .br
.\" .ie \\n(.$>=3 .ne \\$3
.\" .el .ne 3
.\" .IP "\\$1" \\$2
.\" ..
.TH IO_GETEVENTS 2 2008-07-04 "Linux" "Linux Programmer's Manual"
.\"O .SH NAME
.SH ̾Á°
.\"O io_getevents \- read asynchronous I/O events from the completion queue
io_getevents \- ´°Î»¥­¥å¡¼¤«¤éÈóƱ´ü I/O ¥¤¥Ù¥ó¥È¤òÆɤ߽Ф¹
.\"O .SH "SYNOPSIS"
.SH ½ñ¼°
.nf
.\" .ad l
.\" .hy 0
.B #include <linux/time.h>
.B #include <libaio.h>
.\" #include <linux/aio.h>
.sp
.\" .HP 19
.BI "int io_getevents(aio_context_t " ctx_id ", long " min_nr ", long " nr ,
.BI "                 struct io_event *" events \
", struct timespec *" timeout );
.\" .ad
.\" .hy
.sp
.\"O Link with \fI\-laio\fP.
\fI\-laio\fP ¤È¥ê¥ó¥¯¤¹¤ë¡£
.fi
.\"O .SH "DESCRIPTION"
.SH ÀâÌÀ
.PP
.\"O .BR io_getevents ()
.\"O attempts to read at least \fImin_nr\fP events and
.\"O up to \fInr\fP events from the completion queue of the AIO context
.\"O specified by \fIctx_id\fP.
.BR io_getevents ()
¤Ï¡¢¾¯¤Ê¤¯¤È¤â \fImin_nr\fP ¤Î¡¢ºÇÂç \fInr\fP ¸Ä¤Î
¥¤¥Ù¥ó¥È¤ò¡¢ \fIctx_id\fP ¤Ç»ØÄꤵ¤ì¤¿ AIO (ÈóƱ´ü I/O) ¥³¥ó¥Æ¥­¥¹¥È¤Î
´°Î»¥­¥å¡¼¤«¤éÆɤ߽Ф½¤¦¤È¤¹¤ë¡£
.\"O \fItimeout\fP specifies the amount of time to wait for events,
.\"O where a NULL timeout waits until at least \fImin_nr\fP events
.\"O have been seen.
\fItimeout\fP ¤Ï¥¤¥Ù¥ó¥ÈÆɤ߽Ф·¤ÎÂÔ¤Á»þ´Ö¤Î¹ç·×¤ò»ØÄꤹ¤ë¡£
¥¿¥¤¥à¥¢¥¦¥È¤Ë NULL ¤ò»ØÄꤷ¤¿¾ì¹ç¡¢¾¯¤Ê¤¯¤È¤â \fImin_nr\fP ¸Ä¤Î¥¤¥Ù¥ó¥È¤¬
Æɤ߽Фµ¤ì¤ë¤Þ¤ÇÂԤĤ³¤È¤ò°ÕÌ£¤¹¤ë¡£
.\"O Note that \fItimeout\fP is relative and will be updated if not NULL
.\"O and the operation blocks.
Ãí°ÕÅÀ¤ò°Ê²¼¤Ë¤¢¤²¤ë:
\fItimeout\fP ¤ÏÁêÂÐŪ¤Ê»ØÄê¤Ç¤¢¤ë¡£
NULL ¤Ç¤Ê¤¤¾ì¹ç¹¹¿·¤µ¤ì¤ë¤³¤È¤â¤¢¤ê¤¨¤ë¡£
¸Æ¤Ó½Ð¤·¸µ¤ÎÆ°ºî¤ÏÄä»ß¤¹¤ë¡£
.\"O .SH "RETURN VALUE"
.SH ÊÖ¤êÃÍ
.\"O On success,
.\"O .BR io_getevents ()
.\"O returns the number of events read: 0 if no events are
.\"O available, or less than \fImin_nr\fP if the \fItimeout\fP has elapsed.
.\"O For the failure return, see NOTES.
À®¸ù¤¹¤ë¤È¡¢
.BR io_getevents ()
¤ÏÆɤ߽Ф·¤¿¥¤¥Ù¥ó¥È¿ô¤òÊÖ¤¹¡£
¥¤¥Ù¥ó¥È¤¬°ì¤Ä¤âÆɤ߽Фµ¤ì¤Ê¤«¤Ã¤¿¾ì¹ç¤Ï 0 ¤¬ÊÖ¤µ¤ì¡¢
\fItimeout\fP »þ´Ö¤¬·Ð²á¤·¤¿¾ì¹ç¤Ï \fImin_nr\fP ̤Ëþ¤ÎÃͤ¬ÊÖ¤µ¤ì¤ë¡£
¼ºÇÔ»þ¤ÎÊÖ¤êÃͤˤĤ¤¤Æ¤Ï¡¢¡ÖÃí°Õ¡×¤ÎÀá¤ò»²¾È¤¹¤ë¤³¤È¡£
.\"O .SH "ERRORS"
.SH ¥¨¥é¡¼
.TP
.B EFAULT
.\"O Either \fIevents\fP or \fItimeout\fP is an invalid pointer.
\fIevents\fP ¤Þ¤¿¤Ï \fItimeout\fP ¤¬Ìµ¸ú¤Ê¥Ý¥¤¥ó¥¿¤Ç¤¢¤ë¡£
.TP
.B EINVAL
.\"O \fIctx_id\fP is invalid.
.\"O \fImin_nr\fP is out of range or \fInr\fP is
.\"O out of range.
\fIctx_id\fP ¤¬Ìµ¸ú¤Ç¤¢¤ë¡£¤â¤·¤¯¤Ï¡¢\fImin_nr\fP ¤Þ¤¿¤Ï \fInr\fP ¤¬
Èϰϳ°¤ÎÃͤǤ¢¤ë¡£
.TP
.B EINTR
.\"O Interrupted by a signal handler; see
.\"O .BR signal (7).
¥·¥°¥Ê¥ë¥Ï¥ó¥É¥é¤Ë¤è¤ê³ä¤ê¹þ¤Þ¤ì¤¿¡£
.BR signal (7)
»²¾È¡£
.TP
.B ENOSYS
.\"O .BR io_getevents ()
.\"O is not implemented on this architecture.
.BR io_getevents ()
¤¬¤³¤Î¥¢¡¼¥­¥Æ¥¯¥Á¥ã¤Ç¤Ï¼ÂÁõ¤µ¤ì¤Æ¤¤¤Ê¤¤¡£
.\"O .SH "VERSIONS"
.SH ¥Ð¡¼¥¸¥ç¥ó
.PP
.\"O The asynchronous I/O system calls first appeared in Linux 2.5, August 2002.
ÈóƱ´ü I/O ¥·¥¹¥Æ¥à¡¦¥³¡¼¥ë¤Ï 2002ǯ8·î¤Ë Linux 2.5 ¤Ç½é¤á¤ÆÅо줷¤¿¡£
.\"O .SH "CONFORMING TO"
.SH ½àµò
.PP
.\"O .BR io_getevents ()
.\"O is Linux-specific and should not be used in
.\"O programs that are intended to be portable.
.BR io_getevents ()
¤Ï Linux ¸ÇÍ­¤Ç¤¢¤ê¡¢°Ü¿¢¤òÁÛÄꤷ¤¿¥×¥í¥°¥é¥à¤Ç
»ÈÍѤ¹¤Ù¤­¤Ç¤Ï¤Ê¤¤¡£
.\"O .SH NOTES
.SH Ãí°Õ
.\"O Glibc does not provide a wrapper function for this system call.
glibc ¤Ï¤³¤Î¥·¥¹¥Æ¥à¥³¡¼¥ëÍѤΥé¥Ã¥Ñ¡¼´Ø¿ô¤òÄ󶡤·¤Æ¤¤¤Ê¤¤¡£

.\"O The wrapper provided in
.\"O .I libaio
.\"O for
.\"O .BR io_getevents ()
.\"O does not follow the usual C library conventions for indicating error:
.\"O on error it returns a negated error number
.\"O (the negative of one of the values listed in ERRORS).
.\"O If the system call is invoked via
.\"O .BR syscall (2),
.\"O then the return value follows the usual conventions for
.\"O indicating an error: \-1, with
.\"O .I errno
.\"O set to a (positive) value that indicates the error.
.I libaio
¤Ç
.BR io_getevents ()
ÍѤËÄ󶡤µ¤ì¤Æ¤¤¤ë¥é¥Ã¥Ñ¡¼´Ø¿ô¤Ï¡¢¥¨¥é¡¼¤ÎÄÌÃΤ¬Ä̾ï¤Î C ¥é¥¤¥Ö¥é¥ê¤Î
´·½¬¤Ë¤·¤¿¤¬¤Ã¤Æ¤ª¤é¤º¡¢¥¨¥é¡¼¤Î¾ì¹ç¤Ë¤ÏÉé¤Î¥¨¥é¡¼ÈÖ¹æ
(¥¨¥é¡¼¤ÎÀá¤ËÎóµó¤µ¤ì¤Æ¤¤¤ëÃͤΰì¤Ä¤òÉé¤Ë¤·¤¿¤â¤Î) ¤¬ÊÖ¤êÃͤȤʤ롣
.BR syscall (2)
·Ðͳ¤Ç¥·¥¹¥Æ¥à¥³¡¼¥ë¤òµ¯Æ°¤¹¤ë¤È¡¢ÊÖ¤êÃͤÏÄ̾ï¤Î¥¨¥é¡¼ÄÌÃΤδ·½¬¤Ë
¤·¤¿¤¬¤Ã¤Æ¤â¤Î¤È¤Ê¤ê¡¢¥¨¥é¡¼¤Î¾ì¹ç¤Ë¤Ï \-1 ¤¬Ê֤ꡢ
.I errno
¤Ë¥¨¥é¡¼¤ò¼¨¤¹ (Àµ¤Î) Ãͤ¬ÀßÄꤵ¤ì¤ë¡£
.\"O .SH "SEE ALSO"
.SH ´ØÏ¢¹àÌÜ
.PP
.BR io_cancel (2),
.BR io_destroy (2),
.BR io_setup (2),
.BR io_submit (2),
.BR time (7)
.\"O .\" .SH "NOTES"
.\" .SH Ãí
.\" .PP
.\"O .\" The asynchronous I/O system calls were written by Benjamin LaHaise.
.\" ÈóƱ´ü I/O ¥·¥¹¥Æ¥à¡¦¥³¡¼¥ë¤Ï Benjamin LaHaise ¤¬½ñ¤¤¤¿¡£
.\"O .\" .SH AUTHOR
.\" .SH Ãø¼Ô
.\" Kent Yoder.