icon Top 9 categories map      RocketAware > man pages >


Tips: Browse or Search all pages for efficient awareness of more than 6000 of the most popular reusable and open source applications, functions, libraries, and FAQs.

The "RKT couplings" below include links to source code, updates, additional information, advice, FAQs, and overviews.


Search all pages


By activity
Professions, Sciences, Humanities, Business, ...

User Interface
Text-based, GUI, Audio, Video, Keyboards, Mouse, Images,...

Text Strings
Conversions, tests, processing, manipulation,...

Integer, Floating point, Matrix, Statistics, Boolean, ...

Algorithms, Memory, Process control, Debugging, ...

Stored Data
Data storage, Integrity, Encryption, Compression, ...

Networks, protocols, Interprocess, Remote, Client Server, ...

Hard World
Timing, Calendar and Clock, Audio, Video, Printer, Controls...

File System
Management, Filtering, File & Directory access, Viewers, ...


RocketLink!--> Man page versions: OpenBSD FreeBSD NetBSD RedHat Others

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

     getsockname - get socket name

     #include <sys/types.h>
     #include <sys/socket.h>

     getsockname(int s, struct sockaddr *name, socklen_t *namelen);

     getsockname() returns the locally bound address information for a speci-
     fied socket.

     Common uses of this function are as follows:

     -   When bind(2) is called with a port number of 0 (indicating the kernel
         should pick an ephemeral port) getsockname() is used to retrieve the
         kernel-assigned port number.

     -   When a process calls bind(2) on a wildcard IP address, getsockname()
         is used to retrieve the local IP address for the connection.

     -   When a function wishes to know the address family of a socket,
         getsockname() can be used.

     getsockname() takes three parameters:

     s, Contains the file desriptor for the socket to be looked up.

     name points to a sockaddr structure which will hold the resulting address
     information.  Normal use requires one to use a structure specific to the
     protocol family in use, such as sockaddr_in (IPv4) or sockaddr_in6
     (IPv6), cast to a (struct sockaddr *).

     For greater portability (such as newer protocol families) the new struc-
     ture sockaddr_storage exists. sockaddr_storage is large enough to hold
     any of the other sockaddr_* variants.  On return, it should be cast to
     the correct sockaddr type, according to the current protocol family.

     namelen Indicates the amount of space pointed to by name, in bytes. Upon
     return, namelen is set to the actual size of the returned address infor-

     If the address of the destination socket for a given socket connection is
     needed, the getpeername(2) function should be used instead.

     If name does not point to enough space to hold the entire socket address,
     the result will be truncated to namelen bytes.

     On success, getsockname() returns a 0, and namelen is set to the actual
     size of the socket address returned in name. Otherwise, errno is set, and
     a value of -1 is returned.

     If getsockname() fails, errno is set to one of the following:

     [EBADF]       The argument s is not a valid descriptor.

     [ENOTSOCK]    The argument s is a file, not a socket.

     [ENOBUFS]     Insufficient resources were available in the system to per-

                   form the operation.

     [EFAULT]      The name parameter points to memory not in a valid part of
                   the process address space.

     accept(2),  bind(2),  getpeername(2),  socket(2)

     Names bound to sockets in the UNIX domain are inaccessible; getsockname
     returns a zero length name.

     The getsockname() function call appeared in 4.2BSD.

OpenBSD 2.6                      July 17, 1999                               2

Source: OpenBSD 2.6 man pages. Copyright: Portions are copyrighted by BERKELEY
SOFTWARE DESIGN, INC., The Regents of the University of California, Massachusetts
Institute of Technology, Free Software Foundation, FreeBSD Inc., and others.

(Corrections, notes, and links courtesy of RocketAware.com)

[Detailed Topics]

[Overview Topics]

Up to: Socket and I/O Operations - socket() and related functions.

RocketLink!--> Man page versions: OpenBSD FreeBSD NetBSD RedHat Others

Rapid-Links: Search | About | Comments | Submit Path: RocketAware > man pages > getsockname.2/
RocketAware.com is a service of Mib Software
Copyright 1999, Forrest J. Cavalier III. All Rights Reserved.
We welcome submissions and comments