aio.h(3)                   POSIX Programmer's Manual                  aio.h(3)



PPRROOLLOOGG
       This manual page is part of the POSIX Programmer's Manual.  The OS
       implementation of this interface may differ (consult the corresponding
       OS manual page for details of OS behavior), or the interface may not be
       implemented on OS.

NNAAMMEE
       aio.h -- asynchronous input and output

SSYYNNOOPPSSIISS
       #include <aio.h>

DDEESSCCRRIIPPTTIIOONN
       The _<_a_i_o_._h_> header shall define the aaiiooccbb structure, which shall
       include at least the following members:


           int             aio_fildes     File descriptor.
           off_t           aio_offset     File offset.
           volatile void  *aio_buf        Location of buffer.
           size_t          aio_nbytes     Length of transfer.
           int             aio_reqprio    Request priority offset.
           struct sigevent aio_sigevent   Signal number and value.
           int             aio_lio_opcode Operation to be performed.

       The _<_a_i_o_._h_> header shall define the ooffff__tt, pptthhrreeaadd__aattttrr__tt, ssiizzee__tt, and
       ssssiizzee__tt types as described in _<_s_y_s_/_t_y_p_e_s_._h_>.

       The _<_a_i_o_._h_> header shall define the ssttrruucctt ttiimmeessppeecc structure as
       described in _<_t_i_m_e_._h_>.

       The _<_a_i_o_._h_> header shall define the ssiiggeevveenntt structure and ssiiggvvaall union
       as described in <<ssiiggnnaall..hh>>.

       The _<_a_i_o_._h_> header shall define the following symbolic constants:

       AIO_ALLDONE   A return value indicating that none of the requested
                     operations could be canceled since they are already
                     complete.

       AIO_CANCELED  A return value indicating that all requested operations
                     have been canceled.

       AIO_NOTCANCELED
                     A return value indicating that some of the requested
                     operations could not be canceled since they are in
                     progress.

       LIO_NOP       A _l_i_o___l_i_s_t_i_o() element operation option indicating that
                     no transfer is requested.

       LIO_NOWAIT    A _l_i_o___l_i_s_t_i_o() synchronization operation indicating that
                     the calling thread is to continue execution while the
                     _l_i_o___l_i_s_t_i_o() operation is being performed, and no
                     notification is given when the operation is complete.

       LIO_READ      A _l_i_o___l_i_s_t_i_o() element operation option requesting a
                     read.

       LIO_WAIT      A _l_i_o___l_i_s_t_i_o() synchronization operation indicating that
                     the calling thread is to suspend until the _l_i_o___l_i_s_t_i_o()
                     operation is complete.

       LIO_WRITE     A _l_i_o___l_i_s_t_i_o() element operation option requesting a
                     write.

       The following shall be declared as functions and may also be defined as
       macros. Function prototypes shall be provided.


           int      aio_cancel(int, struct aiocb *);
           int      aio_error(const struct aiocb *);
           int      aio_fsync(int, struct aiocb *);
           int      aio_read(struct aiocb *);
           ssize_t  aio_return(struct aiocb *);
           int      aio_suspend(const struct aiocb *const [], int,
                        const struct timespec *);
           int      aio_write(struct aiocb *);
           int      lio_listio(int, struct aiocb *restrict const [restrict], int,
                        struct sigevent *restrict);

       Inclusion of the _<_a_i_o_._h_> header may make visible symbols defined in the
       headers _<_f_c_n_t_l_._h_>, _<_s_i_g_n_a_l_._h_>, and _<_t_i_m_e_._h_>.

       _T_h_e _f_o_l_l_o_w_i_n_g _s_e_c_t_i_o_n_s _a_r_e _i_n_f_o_r_m_a_t_i_v_e_.

AAPPPPLLIICCAATTIIOONN UUSSAAGGEE
       None.

RRAATTIIOONNAALLEE
       None.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       <<ffccnnttll..hh>>, <<ssiiggnnaall..hh>>, <<ssyyss__ttyyppeess..hh>>, <<ttiimmee..hh>>

       The System Interfaces volume of POSIX.1-2017, _a_i_o___c_a_n_c_e_l(),
       _a_i_o___e_r_r_o_r(), _a_i_o___f_s_y_n_c(), _a_i_o___r_e_a_d(), _a_i_o___r_e_t_u_r_n(), _a_i_o___s_u_s_p_e_n_d(),
       _a_i_o___w_r_i_t_e(), _f_s_y_n_c(), _l_i_o___l_i_s_t_i_o(), _l_s_e_e_k(), _r_e_a_d(), _w_r_i_t_e()

CCOOPPYYRRIIGGHHTT
       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1-2017, Standard for Information Technology --
       Portable Operating System Interface (POSIX), The Open Group Base
       Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the
       Institute of Electrical and Electronics Engineers, Inc and The Open
       Group.  In the event of any discrepancy between this version 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 .

       Any typographical or formatting errors that appear in this page are
       most likely to have been introduced during the conversion of the source
       files to man page format. To report such errors, see
       https://www.kernel.org/doc/man-pages/reporting_bugs.html .



IEEE/The Open Group                  2017                             aio.h(3)
