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

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