share/man/man3head/aio.h.3head

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" Copyright 1989 AT&T.
   4 .\" Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
   5 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   6 .\" http://www.opengroup.org/bookstore/.
   7 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
  10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  11 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  12 .TH AIO.H 3HEAD "Feb 5, 2008"
  13 .SH NAME
  14 aio.h, aio \- asynchronous input and output
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 \fB#include <aio.h>\fR
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The <\fBaio.h\fR> header defines the \fBaiocb\fR structure which includes the
  25 following members:
  26 .sp
  27 .in +2
  28 .nf
  29 int               aio_fildes       file descriptor
  30 off_t             aio_offset       file offset
  31 volatile void*    aio_buf          location of buffer
  32 size_t            aio_nbytes       length of transfer
  33 int               aio_reqprio      request priority offset
  34 struct sigevent   aio_sigevent     notification type
  35 int               aio_lio_opcode   listio operation
  36 .fi
  37 .in -2
  38
  39 .sp
  40 .LP
  41 This header also includes the following constants:
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fBAIO_ALLDONE\fR\fR
  46 .ad
  47 .RS 19n
  48 A return value indicating that none of the requested operations could be
  49 canceled since they are already complete.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBAIO_CANCELED\fR\fR
  56 .ad
  57 .RS 19n
  58 A return value indicating that all requested operations have been canceled.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBAIO_NOTCANCELED\fR\fR
  65 .ad
  66 .RS 19n
  67 A return value indicating that some of the requested operations could not be
  68 canceled since they are in progress.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fBLIO_NOP\fR\fR
  75 .ad
  76 .RS 19n
  77 A \fBlio_listio\fR(3C) element operation option indicating that no transfer is
  78 requested.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBLIO_NOWAIT\fR\fR
  85 .ad
  86 .RS 19n
  87 A \fBlio_listio()\fR synchronization operation indicating that the calling
  88 thread is to continue execution while the \fBlio_listio()\fR operation is being
  89 performed, and notification is to be given when the operation is complete.
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fBLIO_READ\fR\fR
  96 .ad
  97 .RS 19n
  98 A \fBlio_listio()\fR element operation option requesting a read.
  99 .RE
 100
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fBLIO_WAIT\fR\fR
 105 .ad
 106 .RS 19n
 107 A \fBlio_listio()\fR synchronization operation indicating that the calling
 108 thread is to suspend until the \fBlio_listio()\fR operation is complete.
 109 .RE
 110
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fBLIO_WRITE\fR\fR
 115 .ad
 116 .RS 19n
 117 A \fBlio_listio()\fR element operation option requesting a write.
 118 .RE
 119
 120 .SH SEE ALSO
 121 .sp
 122 .LP
 123 \fBlseek\fR(2), \fBread\fR(2), \fBwrite\fR(2), \fBfsync\fR(3C),
 124 \fBlibaio\fR(3LIB), \fBlio_listio\fR(3C)