release/man3/aio_cancel.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 Thu Jul 01 02:44:30 JST 2004
  26 .\"         by Yuichi SATO <ysato444@yahoo.co.jp>
  27 .\"
  28 .TH AIO_CANCEL 3 2003-11-14  "" "Linux Programmer's Manual"
  29 .SH 名前
  30 aio_cancel \- 完了していない非同期 I/O リクエストをキャンセルする
  31 .SH 書式
  32 .B "#include <aio.h>"
  33 .sp
  34 .BI "int aio_cancel(int " fd ", struct aiocb *" aiocbp );
  35 .sp
  36 \fI\-lrt\fP でリンクする。
  37 .SH 説明
  38 .BR aio_cancel ()
  39 関数は、ファイルディスクリプタ
  40 .I fd
  41 についての完了していない非同期 I/O リクエストをキャンセルしようとする。
  42 .I aiocbp
  43 が NULL の場合、そのような全てのリクエストがキャンセルされる。
  44 .I aiocbp
  45 が NULL でない場合、
  46 .I aiocbp
  47 で指された制御ブロックで記述されたリクエストのみがキャンセルされる。
  48 .LP
  49 キャンセルされたリクエストに対して、通常の非同期通知が起こる。
  50 リクエストの返り値は \-1 に設定され、
  51 リクエストのエラー状態は
  52 .B ECANCELED
  53 に設定される。
  54 キャンセルできなかったリクエストの制御ブロックは変更されない。
  55 .LP
  56 .I aiocbp
  57 が NULL でなく、かつ
  58 .I fd
  59 が非同期操作が開始されたファイルディスクリプタと異なる場合、
  60 生じる結果は不定である。
  61 .LP
  62 どの操作をキャンセルできるかは、実装定義である。
  63 .\" FreeBSD: raw ディスクデバイスへのリクエストはキャンセルできない。
  64 .SH 返り値
  65 全てのリクエストのキャンセルが成功した場合、この関数は
  66 .B AIO_CANCELED
  67 を返す。
  68 指定されたリクエストのうち少なくとも 1 つが進行中であるために
  69 キャンセルできなかった場合は、
  70 .B AIO_NOTCANCELED
  71 が返される。
  72 この場合は、
  73 .BR aio_error (3)
  74 を使って個々のリクエストの状態をチェックすることができる。
  75 呼び出される前に全てのリクエストが完了していた場合、
  76 この関数は
  77 .B AIO_ALLDONE
  78 を返す。
  79 何らかのエラーが起こった場合は、\-1 が返されて、
  80 .I errno
  81 が適切に設定される。
  82 .SH エラー
  83 .TP
  84 .B EBADF
  85 .I fd
  86 が有効なファイルディスクリプタでない。
  87 .SH 準拠
  88 POSIX.1-2001.
  89 .SH 関連項目
  90 .BR aio_error (3),
  91 .BR aio_fsync (3),
  92 .BR aio_read (3),
  93 .BR aio_return (3),
  94 .BR aio_suspend (3),
  95 .BR aio_write (3)