GETPEERNAME(3)             POSIX Programmer's Manual            GETPEERNAME(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
       getpeername -- get the name of the peer socket

SSYYNNOOPPSSIISS
       #include <sys/socket.h>

       int getpeername(int _s_o_c_k_e_t, struct sockaddr *restrict _a_d_d_r_e_s_s,
           socklen_t *restrict _a_d_d_r_e_s_s___l_e_n);

DDEESSCCRRIIPPTTIIOONN
       The _g_e_t_p_e_e_r_n_a_m_e() function shall retrieve the peer address of the
       specified socket, store this address in the ssoocckkaaddddrr structure pointed
       to by the _a_d_d_r_e_s_s argument, and store the length of this address in the
       object pointed to by the _a_d_d_r_e_s_s___l_e_n argument.

       The _a_d_d_r_e_s_s___l_e_n argument points to a ssoocckklleenn__tt object which on input
       specifies the length of the supplied ssoocckkaaddddrr structure, and on output
       specifies the length of the stored address.  If the actual length of
       the address is greater than the length of the supplied ssoocckkaaddddrr
       structure, the stored address shall be truncated.

       If the protocol permits connections by unbound clients, and the peer is
       not bound, then the value stored in the object pointed to by _a_d_d_r_e_s_s is
       unspecified.

RREETTUURRNN VVAALLUUEE
       Upon successful completion, 0 shall be returned. Otherwise, -1 shall be
       returned and _e_r_r_n_o set to indicate the error.

EERRRROORRSS
       The _g_e_t_p_e_e_r_n_a_m_e() function shall fail if:

       EEBBAADDFF  The _s_o_c_k_e_t argument is not a valid file descriptor.

       EEIINNVVAALL The socket has been shut down.

       EENNOOTTCCOONNNN
              The socket is not connected or otherwise has not had the peer
              pre-specified.

       EENNOOTTSSOOCCKK
              The _s_o_c_k_e_t argument does not refer to a socket.

       EEOOPPNNOOTTSSUUPPPP
              The operation is not supported for the socket protocol.

       The _g_e_t_p_e_e_r_n_a_m_e() function may fail if:

       EENNOOBBUUFFSS
              Insufficient resources were available in the system to complete
              the call.

       _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_c_c_e_p_t(), _b_i_n_d(), _g_e_t_s_o_c_k_n_a_m_e(), _s_o_c_k_e_t()

       The Base Definitions volume of POSIX.1-2017, <<ssyyss__ssoocckkeett..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                       GETPEERNAME(3)
