getsockname(2) — Linux manual page


GETSOCKNAME(2)          Linux Programmer's Manual         GETSOCKNAME(2)

NAME         top

       getsockname - get socket name

SYNOPSIS         top

       #include <sys/socket.h>

       int getsockname(int sockfd, struct sockaddr *restrict addr,
                       socklen_t *restrict addrlen);

DESCRIPTION         top

       getsockname() returns the current address to which the socket
       sockfd is bound, in the buffer pointed to by addr.  The addrlen
       argument should be initialized to indicate the amount of space
       (in bytes) pointed to by addr.  On return it contains the actual
       size of the socket address.

       The returned address is truncated if the buffer provided is too
       small; in this case, addrlen will return a value greater than was
       supplied to the call.

RETURN VALUE         top

       On success, zero is returned.  On error, -1 is returned, and
       errno is set to indicate the error.

ERRORS         top

       EBADF  The argument sockfd is not a valid file descriptor.

       EFAULT The addr argument points to memory not in a valid part of
              the process address space.

       EINVAL addrlen is invalid (e.g., is negative).

              Insufficient resources were available in the system to
              perform the operation.

              The file descriptor sockfd does not refer to a socket.

CONFORMING TO         top

       POSIX.1-2001, POSIX.1-2008, SVr4, 4.4BSD (getsockname() first
       appeared in 4.2BSD).

NOTES         top

       For background on the socklen_t type, see accept(2).

SEE ALSO         top

       bind(2), socket(2), getifaddrs(3), ip(7), socket(7), unix(7)

COLOPHON         top

       This page is part of release 5.13 of the Linux man-pages project.
       A description of the project, information about reporting bugs,
       and the latest version of this page, can be found at

Linux                          2021-03-22                 GETSOCKNAME(2)

Pages that refer to this page: bind(2)connect(2)getpeername(2)socket(2)socketcall(2)syscalls(2)bindresvport(3)getifaddrs(3)getnameinfo(3)if_nameindex(3)signal-safety(7)socket(7)system_data_types(7)unix(7)