SOCKATMARK(3)              POSIX Programmer's Manual             SOCKATMARK(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
       sockatmark -- determine whether a socket is at the out-of-band mark

SSYYNNOOPPSSIISS
       #include <sys/socket.h>

       int sockatmark(int _s);

DDEESSCCRRIIPPTTIIOONN
       The _s_o_c_k_a_t_m_a_r_k() function shall determine whether the socket specified
       by the descriptor _s is at the out-of-band data mark (see _S_e_c_t_i_o_n
       _2_._1_0_._1_2, _S_o_c_k_e_t _O_u_t_-_o_f_-_B_a_n_d _D_a_t_a _S_t_a_t_e).  If the protocol for the
       socket supports out-of-band data by marking the stream with an out-of-
       band data mark, the _s_o_c_k_a_t_m_a_r_k() function shall return 1 when all data
       preceding the mark has been read and the out-of-band data mark is the
       first element in the receive queue. The _s_o_c_k_a_t_m_a_r_k() function shall not
       remove the mark from the stream.

RREETTUURRNN VVAALLUUEE
       Upon successful completion, the _s_o_c_k_a_t_m_a_r_k() function shall return a
       value indicating whether the socket is at an out-of-band data mark. If
       the protocol has marked the data stream and all data preceding the mark
       has been read, the return value shall be 1; if there is no mark, or if
       data precedes the mark in the receive queue, the _s_o_c_k_a_t_m_a_r_k() function
       shall return 0. Otherwise, it shall return a value of -1 and set _e_r_r_n_o
       to indicate the error.

EERRRROORRSS
       The _s_o_c_k_a_t_m_a_r_k() function shall fail if:

       EEBBAADDFF  The _s argument is not a valid file descriptor.

       EENNOOTTTTYY The file associated with the _s argument is not a socket.

       _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
       The use of this function between receive operations allows an
       application to determine which received data precedes the out-of-band
       data and which follows the out-of-band data.

       There is an inherent race condition in the use of this function. On an
       empty receive queue, the current read of the location might well be at
       the ``mark'', but the system has no way of knowing that the next data
       segment that will arrive from the network will carry the mark, and
       _s_o_c_k_a_t_m_a_r_k() will return false, and the next read operation will
       silently consume the mark.

       Hence, this function can only be used reliably when the application
       already knows that the out-of-band data has been seen by the system or
       that it is known that there is data waiting to be read at the socket
       (via SIGURG or _s_e_l_e_c_t()).  See _S_e_c_t_i_o_n _2_._1_0_._1_1, _S_o_c_k_e_t _R_e_c_e_i_v_e _Q_u_e_u_e,
       _S_e_c_t_i_o_n _2_._1_0_._1_2, _S_o_c_k_e_t _O_u_t_-_o_f_-_B_a_n_d _D_a_t_a _S_t_a_t_e, _S_e_c_t_i_o_n _2_._1_0_._1_4,
       _S_i_g_n_a_l_s, and _p_s_e_l_e_c_t() for details.

RRAATTIIOONNAALLEE
       The _s_o_c_k_a_t_m_a_r_k() function replaces the historical SIOCATMARK command to
       _i_o_c_t_l() which implemented the same functionality on many
       implementations. Using a wrapper function follows the adopted
       conventions to avoid specifying commands to the _i_o_c_t_l() function, other
       than those now included to support XSI STREAMS. The _s_o_c_k_a_t_m_a_r_k()
       function could be implemented as follows:

           ##iinncclluuddee <<ssyyss//iiooccttll..hh>>

           int sockatmark(int s)
           {
               int val;
               if (ioctl(s,SIOCATMARK,&val)==-1)
                   return(-1);
               return(val);
           }

       The use of [[EENNOOTTTTYY]] to indicate an incorrect descriptor type matches
       the historical behavior of SIOCATMARK.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       _S_e_c_t_i_o_n _2_._1_0_._1_2, _S_o_c_k_e_t _O_u_t_-_o_f_-_B_a_n_d _D_a_t_a _S_t_a_t_e, _p_s_e_l_e_c_t(), _r_e_c_v(),
       _r_e_c_v_m_s_g()

       The Base Definitions volume of POSIX.1-2008, <<ssyyss__ssoocckkeett..hh>>

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