AIO_SUSPEND(3)             POSIX Programmer's Manual            AIO_SUSPEND(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_suspend -- wait for an asynchronous I/O request

SSYYNNOOPPSSIISS
       #include <aio.h>

       int aio_suspend(const struct aiocb *const _l_i_s_t[], int _n_e_n_t,
           const struct timespec *_t_i_m_e_o_u_t);

DDEESSCCRRIIPPTTIIOONN
       The _a_i_o___s_u_s_p_e_n_d() function shall suspend the calling thread until at
       least one of the asynchronous I/O operations referenced by the _l_i_s_t
       argument has completed, until a signal interrupts the function, or, if
       _t_i_m_e_o_u_t is not NULL, until the time interval specified by _t_i_m_e_o_u_t has
       passed. If any of the aaiiooccbb structures in the list correspond to
       completed asynchronous I/O operations (that is, the error status for
       the operation is not equal to [[EEIINNPPRROOGGRREESSSS]]) at the time of the call,
       the function shall return without suspending the calling thread. The
       _l_i_s_t argument is an array of pointers to asynchronous I/O control
       blocks.  The _n_e_n_t argument indicates the number of elements in the
       array. Each aaiiooccbb structure pointed to has been used in initiating an
       asynchronous I/O request via _a_i_o___r_e_a_d(), _a_i_o___w_r_i_t_e(), or _l_i_o___l_i_s_t_i_o().
       This array may contain null pointers, which are ignored. If this array
       contains pointers that refer to aaiiooccbb structures that have not been
       used in submitting asynchronous I/O, the effect is undefined.

       If the time interval indicated in the ttiimmeessppeecc structure pointed to by
       _t_i_m_e_o_u_t passes before any of the I/O operations referenced by _l_i_s_t are
       completed, then _a_i_o___s_u_s_p_e_n_d() shall return with an error.  If the
       Monotonic Clock option is supported, the clock that shall be used to
       measure this time interval shall be the CLOCK_MONOTONIC clock.

RREETTUURRNN VVAALLUUEE
       If the _a_i_o___s_u_s_p_e_n_d() function returns after one or more asynchronous
       I/O operations have completed, the function shall return zero.
       Otherwise, the function shall return a value of -1 and set _e_r_r_n_o to
       indicate the error.

       The application may determine which asynchronous I/O completed by
       scanning the associated error and return status using _a_i_o___e_r_r_o_r() and
       _a_i_o___r_e_t_u_r_n(), respectively.

EERRRROORRSS
       The _a_i_o___s_u_s_p_e_n_d() function shall fail if:

       EEAAGGAAIINN No asynchronous I/O indicated in the list referenced by _l_i_s_t
              completed in the time interval indicated by _t_i_m_e_o_u_t.

       EEIINNTTRR  A signal interrupted the _a_i_o___s_u_s_p_e_n_d() function. Note that,
              since each asynchronous I/O operation may possibly provoke a
              signal when it completes, this error return may be caused by the
              completion of one (or more) of the very I/O operations being
              awaited.

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

EEXXAAMMPPLLEESS
       None.

AAPPPPLLIICCAATTIIOONN UUSSAAGGEE
       None.

RRAATTIIOONNAALLEE
       None.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       _a_i_o___r_e_a_d(), _a_i_o___w_r_i_t_e(), _l_i_o___l_i_s_t_i_o()

       The Base Definitions volume of POSIX.1-2017, <<aaiioo..hh>>

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_SUSPEND(3)
