sys_uio.h(3)               POSIX Programmer's Manual              sys_uio.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
       sys/uio.h -- definitions for vector I/O operations

SSYYNNOOPPSSIISS
       #include <sys/uio.h>

DDEESSCCRRIIPPTTIIOONN
       The _<_s_y_s_/_u_i_o_._h_> header shall define the iioovveecc structure, which shall
       include at least the following members:

           vvooiidd   **iioovv__bbaassee  Base address of a memory region for input or output.
           size_t  iov_len   The size of the memory pointed to by _i_o_v___b_a_s_e_.

       The _<_s_y_s_/_u_i_o_._h_> header uses the iioovveecc structure for scatter/gather I/O.

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

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

           ssssiizzee__tt rreeaaddvv((iinntt,, ccoonnsstt ssttrruucctt iioovveecc **,, iinntt));;
           ssssiizzee__tt wwrriitteevv((iinntt,, ccoonnsstt ssttrruucctt iioovveecc **,, iinntt));;

       _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
       The implementation can put a limit on the number of scatter/gather
       elements which can be processed in one call. The symbol {IOV_MAX}
       defined in _<_l_i_m_i_t_s_._h_> should always be used to learn about the limits
       instead of assuming a fixed value.

RRAATTIIOONNAALLEE
       Traditionally, the maximum number of scatter/gather elements the system
       can process in one call were described by the symbolic value
       {UIO_MAXIOV}.  In IEEE Std 1003.1-2001 this value is replaced by the
       constant {IOV_MAX} which can be found in _<_l_i_m_i_t_s_._h_>.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       <<lliimmiittss..hh>>, <<ssyyss__ttyyppeess..hh>>

       The System Interfaces volume of POSIX.1-2008, _r_e_a_d(), _r_e_a_d_v(), _w_r_i_t_e(),
       _w_r_i_t_e_v()

CCOOPPYYRRIIGGHHTT
       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
       -- Portable Operating System Interface (POSIX), The Open Group Base
       Specifications Issue 7, Copyright (C) 2013 by the Institute of
       Electrical and Electronics Engineers, Inc and The Open Group.  (This is
       POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) 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.unix.org/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                  2013                         sys_uio.h(3)
