Home Man
Today's Posts

Linux & Unix Commands - Search Man Pages
Man Page or Keyword Search:
Select Section of Man Page:
Select Man Page Repository:

NetBSD 6.1.5 - man page for getpeername (netbsd section 2)

GETPEERNAME(2)			     BSD System Calls Manual			   GETPEERNAME(2)

     getpeername -- get name of connected peer

     Standard C Library (libc, -lc)

     #include <sys/socket.h>

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

     The getpeername() function returns the name of the peer connected to the socket s.  One com-
     mon use occurs when a process inherits an open socket, such as TCP servers forked from
     inetd(8).	In this scenario, getpeername() is used to determine the connecting client's IP

     The function takes three parameters:

	   s	    contains the file descriptor of the socket whose peer should be looked up.

	   name     points to a sockaddr structure that will hold the address information for the
		    connected peer.  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, especially with the newer protocol families, the new
		    struct sockaddr_storage should be used.  sockaddr_storage is large enough to
		    hold any of the other sockaddr_* variants.	On return, it can be cast to the
		    correct sockaddr type, based on the protocol family contained in its ss_fam-
		    ily field.

	   namelen  indicates the amount of space pointed to by name, in bytes.

     If address information for the local end of the socket is required, the getsockname(2) func-
     tion 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.

     If the call succeeds, a 0 is returned 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.

     The call succeeds unless:

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

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

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

     [ENOTCONN] 	The socket is not connected.

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

     accept(2), bind(2), getsockname(2), socket(2)

     The function conforms to IEEE Std 1003.1-2008 (``POSIX.1'').

     The getpeername() function call appeared in 4.2BSD.

BSD					   June 3, 2011 				      BSD

All times are GMT -4. The time now is 05:07 AM.

Unix & Linux Forums Content Copyrightę1993-2018. All Rights Reserved.
Show Password