Путеводитель по Руководству Linux

  User  |  Syst  |  Libr  |  Device  |  Files  |  Other  |  Admin  |  Head  |



   getpeername.3p    ( 3 )

получить имя однорангового сокета (get the name of the peer socket)

Пролог (Prolog)

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

Имя (Name)

getpeername — get the name of the peer socket

Синопсис (Synopsis)

#include <sys/socket.h>

int getpeername(int socket, struct sockaddr *restrict address, socklen_t *restrict address_len);


Описание (Description)

The getpeername() function shall retrieve the peer address of the
       specified socket, store this address in the sockaddr structure
       pointed to by the address argument, and store the length of this
       address in the object pointed to by the address_len argument.

The address_len argument points to a socklen_t object which on input specifies the length of the supplied sockaddr 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 sockaddr 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 address is unspecified.


Возвращаемое значение (Return value)

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

Ошибки (Error)

The getpeername() function shall fail if:

EBADF The socket argument is not a valid file descriptor.

EINVAL The socket has been shut down.

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

ENOTSOCK The socket argument does not refer to a socket.

EOPNOTSUPP The operation is not supported for the socket protocol.

The getpeername() function may fail if:

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

The following sections are informative.


Примеры (Examples)

None.

Использование в приложениях (Application usage)

None.

Обоснование (Rationale)

None.

Будущие направления (Future directions)

None.

Смотри также (See also)

accept(3p), bind(3p), getsockname(3p), socket(3p)

The Base Definitions volume of POSIX.1‐2017, sys_socket.h(0p)