draft/man3/aio_suspend.3

   1 .\" Copyright (c) 2003 Andries Brouwer (aeb@cwi.nl)
   2 .\"
   3 .\" This is free documentation; you can redistribute it and/or
   4 .\" modify it under the terms of the GNU General Public License as
   5 .\" published by the Free Software Foundation; either version 2 of
   6 .\" the License, or (at your option) any later version.
   7 .\"
   8 .\" The GNU General Public License's references to "object code"
   9 .\" and "executables" are to be interpreted as the output of any
  10 .\" document formatting or typesetting system, including
  11 .\" intermediate and printed output.
  12 .\"
  13 .\" This manual is distributed in the hope that it will be useful,
  14 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 .\" GNU General Public License for more details.
  17 .\"
  18 .\" You should have received a copy of the GNU General Public
  19 .\" License along with this manual; if not, write to the Free
  20 .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
  21 .\" USA.
  22 .\"
  23 .\" Japanese Version Copyright (c) 2004 Yuichi SATO
  24 .\"         all rights reserved.
  25 .\" Translated Sat Jul 10 03:18:23 JST 2004
  26 .\"         by Yuichi SATO <ysato444@yahoo.co.jp>
  27 .\"
  28 .TH AIO_SUSPEND 3 2003-11-14  "" "Linux Programmer's Manual"
  29 .\"O .SH NAME
  30 .SH Ì¾Á°
  31 .\"O aio_suspend \- wait for asynchronous I/O operation or timeout
  32 aio_suspend \- ÈóÆ±´ü I/O Áàºî¤Þ¤¿¤Ï¥¿¥¤¥à¥¢¥¦¥È¤òÂÔ¤Ä
  33 .\"O .SH SYNOPSIS
  34 .SH ½ñ¼°
  35 .nf
  36 .sp
  37 .B "#include <aio.h>"
  38 .sp
  39 .BI "int aio_suspend(const struct aiocb * const " cblist [],
  40 .br
  41 .BI "                int " n ", const struct timespec *" timeout );
  42 .sp
  43 .\"O Link with \fI\-lrt\fP.
  44 \fI\-lrt\fP ¤Ç¥ê¥ó¥¯¤¹¤ë¡£
  45 .fi
  46 .\"O .SH DESCRIPTION
  47 .SH ÀâÌÀ
  48 .\"O The
  49 .\"O .BR aio_suspend ()
  50 .\"O function suspends the calling process until at least one of the
  51 .\"O asynchronous I/O requests in the list
  52 .\"O .I cblist
  53 .\"O of length
  54 .\"O .I n
  55 .\"O have completed, a signal is delivered, or
  56 .\"O .I timeout
  57 .\"O is not NULL and the time interval it indicates has passed.
  58 .BR aio_suspend ()
  59 ´Ø¿ô¤Ï¡¢Ä¹¤µ
  60 .I n
  61 ¤Î¥ê¥¹¥È
  62 .I cblist
  63 ¤Ë´Þ¤Þ¤ì¤ëÈóÆ±´ü I/O ¥ê¥¯¥¨¥¹¥È¤Î¤¦¤Á¾¯¤Ê¤¯¤È¤â 1 ¤Ä¤¬´°Î»¤¹¤ë¤«¡¢
  64 ¥·¥°¥Ê¥ë¤¬ÇÛÁ÷¤µ¤ì¤ë¤«¡¢
  65 .I timeout
  66 ¤¬ NULL ¤Ç¤Ê¤¯¡¢¤«¤Ä¤½¤Î»þ´Ö¤¬²á¤®¤ë¤Þ¤Ç¡¢
  67 ¸Æ¤Ó½Ð¤·¤¿¥×¥í¥»¥¹¤òÄä»ß (suspend) ¤¹¤ë¡£
  68 .LP
  69 .\"O Each item in the list must either be NULL (and then is ignored),
  70 .\"O or a pointer to a control block on which I/O was initiated using
  71 .\"O .BR aio_read (3),
  72 .\"O .BR aio_write (3),
  73 .\"O or
  74 .\"O .BR lio_listio (3).
  75 ¥ê¥¹¥È¤Î³Æ¥¢¥¤¥Æ¥à¤Ï¡¢NULL (¤³¤ì¤ÏÌµ»ë¤µ¤ì¤ë) ¤«¡¢
  76 .BR aio_read (3),
  77 .BR aio_write (3),
  78 .BR lio_listio (3)
  79 ¤ò»È¤Ã¤Æ I/O ¤¬³«»Ï¤µ¤ì¤¿À©¸æ¥Ö¥í¥Ã¥¯¤Ø¤Î¥Ý¥¤¥ó¥¿¤Ç¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
  80 .LP
  81 .\"O If
  82 .\"O .B CLOCK_MONOTONIC
  83 .\"O is supported, this clock is used to measure
  84 .\"O the timeout interval.
  85 .B CLOCK_MONOTONIC
  86 ¤¬¥µ¥Ý¡¼¥È¤µ¤ì¤ë¾ì¹ç¡¢
  87 ¤³¤Î¥¯¥í¥Ã¥¯¤ò»È¤Ã¤Æ¥¿¥¤¥à¥¢¥¦¥È¤Î´Ö³Ö¤¬·×Â¬¤µ¤ì¤ë¡£
  88 .\"O .SH "RETURN VALUE"
  89 .SH ÊÖ¤êÃÍ
  90 .\"O If this function returns after completion of one of the indicated
  91 .\"O requests, it returns 0.
  92 .\"O Otherwise it returns \-1 and sets
  93 .\"O .I errno
  94 .\"O appropriately.
  95 »Ø¼¨¤µ¤ì¤¿¥ê¥¯¥¨¥¹¥È¤Î 1 ¤Ä¤¬´°Î»¤·¤¿¸å¤Ë¤³¤Î´Ø¿ô¤¬ÊÖ¤ë¾ì¹ç¤Ï¡¢0 ¤òÊÖ¤¹¡£
  96 ¤½¤ì°Ê³°¤Î¾ì¹ç¤Ï \-1 ¤òÊÖ¤·¤Æ¡¢
  97 .I errno
  98 ¤òÅ¬ÀÚ¤ËÀßÄê¤¹¤ë¡£
  99 .\"O .SH ERRORS
 100 .SH ¥¨¥é¡¼
 101 .TP
 102 .B EAGAIN
 103 .\"O The call was ended by timeout, before any of the indicated operations
 104 .\"O had completed.
 105 »Ø¼¨¤µ¤ì¤¿Áàºî¤Î¤É¤ì¤â´°Î»¤·¤Ê¤¤¤¦¤Á¤Ë¡¢
 106 ¤³¤Î¸Æ¤Ó½Ð¤·¤¬¥¿¥¤¥à¥¢¥¦¥È¤Ë¤è¤Ã¤Æ½ªÎ»¤µ¤»¤é¤ì¤¿¡£
 107 .TP
 108 .B EINTR
 109 .\"O The call was ended by signal; see
 110 .\"O .BR signal (7).
 111 .\"O (Possibly the completion signal of one of the operations we were
 112 .\"O waiting for.)
 113 ¤³¤Î¸Æ¤Ó½Ð¤·¤¬¥·¥°¥Ê¥ë¤Ë¤è¤Ã¤Æ½ªÎ»¤µ¤»¤é¤ì¤¿¡£
 114 .BR signal (7)
 115 »²¾È¡£
 116 (¤³¤Î¥·¥°¥Ê¥ë¤Ï¡¢´°Î»¤òÂÔ¤Ã¤Æ¤¤¤¿Áàºî¤Î¤¤¤º¤ì¤«¤Î´°Î»¥·¥°¥Ê¥ë¤Î²ÄÇ½À¤â¤¢¤ë¡£)
 117 .\"O .SH "CONFORMING TO"
 118 .SH ½àµò
 119 POSIX.1-2001.
 120 .\"O .SH NOTES
 121 .SH Ãí°Õ
 122 .\"O One can achieve polling by using a non-NULL
 123 .\"O .I timeout
 124 .\"O that specifies a zero time interval.
 125 »þ´Ö´Ö³Ö¤¬ 0 ¤Ç¤¢¤ë¤³¤È¤ò»ØÄê¤¹¤ë NULL ¤Ç¤Ï¤Ê¤¤
 126 .I timeout
 127 ¤ò»È¤Ã¤Æ¡¢¥Ý¡¼¥ê¥ó¥°¤ò¹Ô¤¦¤³¤È¤â¤Ç¤¤ë¡£
 128 .\"O .SH "SEE ALSO"
 129 .SH ´ØÏ¢¹àÌÜ
 130 .BR aio_cancel (3),
 131 .BR aio_error (3),
 132 .BR aio_fsync (3),
 133 .BR aio_read (3),
 134 .BR aio_return (3),
 135 .BR aio_write (3),
 136 .BR time (7)