[unix-history] / usr / src / lib / libc / sys / getpeername.2

.\" Copyright (c) 1983 Regents of the University of California.
.\" All rights reserved.  The Berkeley software License Agreement
.\" specifies the terms and conditions for redistribution.
.\"
.\"	@(#)getpeername.2	6.2 (Berkeley) %G%
.\"
.TH GETPEERNAME 2 ""
.UC 5
.SH NAME
getpeername \- get name of connected peer
.SH SYNOPSIS
.nf
.PP
.ft B
getpeername(s, name, namelen)
int s;
struct sockaddr *name;
int *namelen;
.fi
.SH DESCRIPTION
.I Getpeername
returns the name of the peer connected to
socket
.IR s .
The
.I namelen
parameter should be initialized to indicate
the amount of space pointed to by
.IR name .
On return it contains the actual size of the name
returned (in bytes).
The name is truncated if the buffer provided is too small.
.SH DIAGNOSTICS
A 0 is returned if the call succeeds, \-1 if it fails.
.SH ERRORS
The call succeeds unless:
.TP 15
[EBADF]
The argument \fIs\fP is not a valid descriptor.
.TP 15
[ENOTSOCK]
The argument \fIs\fP is a file, not a socket.
.TP 15
[ENOTCONN]
The socket is not connected.
.TP 15
[ENOBUFS]
Insufficient resources were available in the system
to perform the operation.
.TP 15
[EFAULT]
The 
.I name
parameter points to memory not in a valid part of the
process address space.
.SH "SEE ALSO"
accept(2), bind(2), socket(2), getsockname(2)
Commit	Line	Data
c93f2ba8 KM	1	.\" Copyright (c) 1983 Regents of the University of California.
	2	.\" All rights reserved. The Berkeley software License Agreement
	3	.\" specifies the terms and conditions for redistribution.
	4	.\"
e4589241	5	.\" @(#)getpeername.2 6.2 (Berkeley) %G%
c93f2ba8	6	.\"
cb0beb2a	7	.TH GETPEERNAME 2 ""
c93f2ba8 KM	8	.UC 5
	9	.SH NAME
	10	getpeername \- get name of connected peer
	11	.SH SYNOPSIS
	12	.nf
	13	.PP
	14	.ft B
	15	getpeername(s, name, namelen)
	16	int s;
	17	struct sockaddr *name;
	18	int *namelen;
	19	.fi
	20	.SH DESCRIPTION
	21	.I Getpeername
	22	returns the name of the peer connected to
	23	socket
	24	.IR s .
	25	The
	26	.I namelen
	27	parameter should be initialized to indicate
	28	the amount of space pointed to by
	29	.IR name .
	30	On return it contains the actual size of the name
	31	returned (in bytes).
e4589241	32	The name is truncated if the buffer provided is too small.
c93f2ba8 KM	33	.SH DIAGNOSTICS
	34	A 0 is returned if the call succeeds, \-1 if it fails.
	35	.SH ERRORS
	36	The call succeeds unless:
	37	.TP 15
	38	[EBADF]
	39	The argument \fIs\fP is not a valid descriptor.
	40	.TP 15
	41	[ENOTSOCK]
	42	The argument \fIs\fP is a file, not a socket.
	43	.TP 15
	44	[ENOTCONN]
	45	The socket is not connected.
	46	.TP 15
	47	[ENOBUFS]
	48	Insufficient resources were available in the system
	49	to perform the operation.
	50	.TP 15
	51	[EFAULT]
	52	The
	53	.I name
	54	parameter points to memory not in a valid part of the
	55	process address space.
	56	.SH "SEE ALSO"
e4589241	57	accept(2), bind(2), socket(2), getsockname(2)