draft/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 .\"*******************************************************************
  24 .\"
  25 .\" This file was generated with po4a. Translate the source file.
  26 .\"
  27 .\"*******************************************************************
  28 .TH AIO_CANCEL 3 2011\-10\-04 "" "Linux Programmer's Manual"
  29 .SH 名前
  30 aio_cancel \- 完了していない非同期 I/O リクエストをキャンセルする
  31 .SH 書式
  32 \fB#include <aio.h>\fP
  33 .sp
  34 \fBint aio_cancel(int \fP\fIfd\fP\fB, struct aiocb *\fP\fIaiocbp\fP\fB);\fP
  35 .sp
  36 \fI\-lrt\fP でリンクする。
  37 .SH 説明
  38 \fBaio_cancel\fP() 関数は、ファイルディスクリプタ \fIfd\fP についての完了していない
  39 非同期 I/O リクエストをキャンセルしようとする。 \fIaiocbp\fP が NULL の場合、そ
  40 のような全てのリクエストがキャンセルされる。 \fIaiocbp\fP が NULL でない場合、
  41 \fIaiocbp\fP で指された制御ブロックで記述されたリクエストのみがキャンセルされる。
  42 (\fIaiocb\fP 構造体の説明は \fBaio\fP(7) を参照)
  43 .LP
  44 キャンセルされたリクエストに対して、通常の非同期通知が起こる。
  45 リクエストの返り値 (\fBaio_return\fP(3)) は \-1 に設定され、
  46 リクエストのエラー状態 (\fBaio_error\fP(3)) は \fBECANCELED\fP に設定される。
  47 キャンセルできないリクエストの制御ブロックは変更されない。
  48 .LP
  49 \fIaiocbp\fP が NULL でなく、かつ \fIfd\fP が非同期操作が開始されたファイルディスクリプタと異なる場合、 生じる結果は不定である。
  50 .LP
  51 .\" FreeBSD: not those on raw disk devices.
  52 どの操作をキャンセルできるかは、実装定義である。
  53 .SH 返り値
  54 全てのリクエストのキャンセルが成功した場合、この関数は \fBAIO_CANCELED\fP を返す。 指定されたリクエストのうち少なくとも 1
  55 つが進行中であるために キャンセルできなかった場合は、 \fBAIO_NOTCANCELED\fP が返される。 この場合は、 \fBaio_error\fP(3)
  56 を使って個々のリクエストの状態をチェックすることができる。 呼び出される前に全てのリクエストが完了していた場合、 この関数は
  57 \fBAIO_ALLDONE\fP を返す。 何らかのエラーが起こった場合は、\-1 が返されて、 \fIerrno\fP が適切に設定される。
  58 .SH エラー
  59 .TP
  60 \fBEBADF\fP
  61 \fIfd\fP が有効なファイルディスクリプタでない。
  62 .SH バージョン
  63 \fBaio_cancel\fP() 関数は glibc 2.1 以降で利用できる。
  64 .SH 準拠
  65 POSIX.1\-2001, POSIX.1\-2008.
  66 .SH 例
  67 \fBaio\fP(7) を参照。
  68 .SH 関連項目
  69 \fBaio_error\fP(3), \fBaio_fsync\fP(3), \fBaio_read\fP(3), \fBaio_return\fP(3),
  70 \fBaio_suspend\fP(3), \fBaio_write\fP(3), \fBlio_listio\fP(3), \fBaio\fP(7)