xref: /illumos-gate/usr/src/man/man3c/aio_error.3c (revision bbf21555)

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
http://www.opengroup.org/bookstore/.

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 SunOS 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.

This notice shall appear on any product containing this material.

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.

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.

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]


Copyright 1989 AT&T
Portions Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.

AIO_ERROR 3C "Feb 5, 2008"
NAME
aio_error - retrieve errors status for an asynchronous I/O operation
SYNOPSIS

#include <aio.h>

int aio_error(const struct aiocb *aiocbp);
DESCRIPTION

The aio_error() function returns the error status associated with the aiocb structure referenced by the aiocbp argument. The error status for an asynchronous I/O operation is the errno value that would be set by the corresponding read(2), write(2), or fsync(3C) operation. If the operation has not yet completed, then the error status will be equal to EINPROGRESS.

RETURN VALUES

If the asynchronous I/O operation has completed successfully, then 0 is returned. If the asynchronous operation has completed unsuccessfully, then the error status, as described for read(2), write(2), and fsync(3C), is returned. If the asynchronous I/O operation has not yet completed, then EINPROGRESS is returned.

ERRORS

The aio_error() function may fail if: EINVAL

The aiocbp argument does not refer to an asynchronous operation whose return status has not yet been retrieved.

USAGE

The aio_error() function has a transitional interface for 64-bit file offsets. See lf64(7).

EXAMPLES

Example 1 The following is an example of an error handling routine using the aio_error() function.

#include <aio.h>
#include <errno.h>
#include <signal.h>
struct aiocb my_aiocb;
struct sigaction my_sigaction;
void my_aio_handler(int, siginfo_t *, void *);
\|.\|.\|.
my_sigaction.sa_flags = SA_SIGINFO;
my_sigaction.sa_sigaction = my_aio_handler;
sigemptyset(&my_sigaction.sa_mask);
(void) sigaction(SIGRTMIN, &my_sigaction, NULL);
\|.\|.\|.
my_aiocb.aio_sigevent.sigev_notify = SIGEV_SIGNAL;
my_aiocb.aio_sigevent.sigev_signo = SIGRTMIN;
my_aiocb.aio_sigevent.sigev_value.sival_ptr = &myaiocb;
\|.\|.\|.
(void) aio_read(&my_aiocb);
\|.\|.\|.
void
my_aio_handler(int signo, siginfo_t *siginfo, void *context) {
int my_errno;
struct aiocb *my_aiocbp;

my_aiocbp = siginfo->si_value.sival_ptr;
 if ((my_errno = aio_error(my_aiocb)) != EINPROGRESS) {
 int my_status = aio_return(my_aiocb);
 if (my_status >= 0){ /* start another operation */
 \|.\|.\|.
 } else { /* handle I/O error */
 \|.\|.\|.
 }
 }
}
ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
MT-Level Async-Signal-Safe
Standard See standards(7).
SEE ALSO

_Exit (2), close (2), fork (2), lseek (2), read (2), write (2), aio_cancel (3C), aio_fsync (3C), aio_read (3C), aio_return (3C), aio_write (3C), lio_listio (3C), aio.h (3HEAD), signal.h (3HEAD), attributes (7), lf64 (7), standards (7)