freebsd-dev/lib/libc/sys/bind.2

.\" Copyright (c) 1983, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)bind.2	8.1 (Berkeley) 6/4/93
.\" $FreeBSD$
.\"
.Dd June 4, 1993
.Dt BIND 2
.Os
.Sh NAME
.Nm bind
.Nd assign a local protocol address to a socket
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In sys/types.h
.In sys/socket.h
.Ft int
.Fn bind "int s" "const struct sockaddr *addr" "socklen_t addrlen"
.Sh DESCRIPTION
The
.Fn bind
function
assigns the local protocol address to a socket.
When a socket is created
with
.Xr socket 2
it exists in an address family space but has no protocol address assigned.
The
.Fn bind
function requests that
.Fa addr
be assigned to the socket.
.Sh NOTES
Binding an address in the UNIX domain creates a socket in the file
system that must be deleted by the caller when it is no longer
needed (using
.Xr unlink 2 ) .
.Pp
The rules used in address binding vary between communication domains.
Consult the manual entries in section 4 for detailed information.
.Pp
For maximum portability, you should always zero the socket address structure
before populating it and passing it to
.Fn bind .
.Sh RETURN VALUES
.Rv -std bind
.Sh ERRORS
The
.Fn bind
call will fail if:
.Bl -tag -width Er
.It Bq Er EAGAIN
Kernel resources to complete the request are
temporarily unavailable.
.It Bq Er EBADF
.Fa S
is not a valid descriptor.
.It Bq Er ENOTSOCK
.Fa S
is not a socket.
.It Bq Er EADDRNOTAVAIL
The specified address is not available from the local machine.
.It Bq Er EADDRINUSE
The specified address is already in use.
.It Bq Er EACCES
The requested address is protected, and the current user
has inadequate permission to access it.
.It Bq Er EFAULT
The
.Fa addr
parameter is not in a valid part of the user
address space.
.El
.Pp
The following errors are specific to binding addresses in the UNIX domain.
.Bl -tag -width EADDRNOTAVA
.It Bq Er ENOTDIR
A component of the path prefix is not a directory.
.It Bq Er ENAMETOOLONG
A component of a pathname exceeded 255 characters,
or an entire path name exceeded 1023 characters.
.It Bq Er ENOENT
A prefix component of the path name does not exist.
.It Bq Er ELOOP
Too many symbolic links were encountered in translating the pathname.
.It Bq Er EIO
An I/O error occurred while making the directory entry or allocating the inode.
.It Bq Er EROFS
The name would reside on a read-only file system.
.It Bq Er EISDIR
An empty pathname was specified.
.El
.Sh SEE ALSO
.Xr connect 2 ,
.Xr getsockname 2 ,
.Xr listen 2 ,
.Xr socket 2
.Sh HISTORY
The
.Fn bind
function call appeared in
.Bx 4.2 .
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" Copyright (c) 1983, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 3. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed by the University of`
			`.\" California, Berkeley and its contributors.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)bind.2 8.1 (Berkeley) 6/4/93`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\"`
			`.Dd June 4, 1993`
			`.Dt BIND 2`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 13:41:46 +00:00			`.Os`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh NAME`
			`.Nm bind`
mdoc(7) police: normalize .Nd. 2001-04-18 15:54:10 +00:00			`.Nd assign a local protocol address to a socket`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
			`.Lb libc`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In sys/types.h`
			`.In sys/socket.h`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Ft int`
General clean-up of socket.h and associated sources to synchronise up with NetBSD and the Single Unix Specification v2. This updates some structures with other, almost equivalent types and effort is under way to get the whole more consistent. Also removes a double definition of INET6 and some other clean-ups. Reviewed by: green, bde, phk Some part obtained from: NetBSD, SUSv2 specification 1999-11-24 20:49:04 +00:00			`.Fn bind "int s" "const struct sockaddr *addr" "socklen_t addrlen"`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh DESCRIPTION`
The .Fn function 2002-07-15 19:56:24 +00:00			`The`
			`.Fn bind`
			`function`
Improvement in the description of what this does. Prompted by (and thanks to): W Richard Stevens 1999-06-10 22:48:27 +00:00			`assigns the local protocol address to a socket.`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`When a socket is created`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`with`
			`.Xr socket 2`
Improvement in the description of what this does. Prompted by (and thanks to): W Richard Stevens 1999-06-10 22:48:27 +00:00			`it exists in an address family space but has no protocol address assigned.`
The .Fn function 2002-07-15 19:56:24 +00:00			`The`
			`.Fn bind`
			`function requests that`
Improvement in the description of what this does. Prompted by (and thanks to): W Richard Stevens 1999-06-10 22:48:27 +00:00			`.Fa addr`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`be assigned to the socket.`
			`.Sh NOTES`
Improvement in the description of what this does. Prompted by (and thanks to): W Richard Stevens 1999-06-10 22:48:27 +00:00			`Binding an address in the UNIX domain creates a socket in the file`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`system that must be deleted by the caller when it is no longer`
			`needed (using`
			`.Xr unlink 2 ) .`
			`.Pp`
Improvement in the description of what this does. Prompted by (and thanks to): W Richard Stevens 1999-06-10 22:48:27 +00:00			`The rules used in address binding vary between communication domains.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`Consult the manual entries in section 4 for detailed information.`
Add warning about zeroing-out the socket structure before populating it. 2001-10-13 17:20:51 +00:00			`.Pp`
- There is no such thing as a socket structure. sockets are integers. I'm assuming that the comment was regarding socket address structures, so correct the comment about pre-zero'ing socket structures to recommend pre-zero'ing socket address structures. - Fix some minor grammar nits. - This isn't directly submitted by the PR below but is related to it and was inspired by it. PR: 31704 2001-11-05 18:05:56 +00:00			`For maximum portability, you should always zero the socket address structure`
			`before populating it and passing it to`
Add warning about zeroing-out the socket structure before populating it. 2001-10-13 17:20:51 +00:00			`.Fn bind .`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh RETURN VALUES`
Use the ``.Rv -std'' mdoc(7) macro in appropriate cases. Reviewed by: ru 2001-08-09 13:32:13 +00:00			`.Rv -std bind`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh ERRORS`
			`The`
			`.Fn bind`
			`call will fail if:`
Use `Er' variable to define first column width in ERRORS section. It was initially suggested by mdoc(7) style, but was broken over the years 2000-05-04 13:09:25 +00:00			`.Bl -tag -width Er`
Document that bind(2) can fail with EAGAIN. PR: docs/14173 docs/14181 Submitted by: Charles Randall <crandall@matchlogic.com> Submitted by: Kelly Yancey <kbyanc@posi.net> 1999-11-01 19:43:07 +00:00			`.It Bq Er EAGAIN`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`Kernel resources to complete the request are`
s/unavilable/unavailable/ PR: 39446 Submitted by: Stefan Farfeleder <e0026813@stud3.tuwien.ac.at> MFC after: 1 day 2002-07-07 18:08:51 +00:00			`temporarily unavailable.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.It Bq Er EBADF`
			`.Fa S`
			`is not a valid descriptor.`
			`.It Bq Er ENOTSOCK`
			`.Fa S`
			`is not a socket.`
			`.It Bq Er EADDRNOTAVAIL`
			`The specified address is not available from the local machine.`
			`.It Bq Er EADDRINUSE`
			`The specified address is already in use.`
			`.It Bq Er EACCES`
			`The requested address is protected, and the current user`
			`has inadequate permission to access it.`
			`.It Bq Er EFAULT`
			`The`
Improvement in the description of what this does. Prompted by (and thanks to): W Richard Stevens 1999-06-10 22:48:27 +00:00			`.Fa addr`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`parameter is not in a valid part of the user`
			`address space.`
			`.El`
			`.Pp`
Improvement in the description of what this does. Prompted by (and thanks to): W Richard Stevens 1999-06-10 22:48:27 +00:00			`The following errors are specific to binding addresses in the UNIX domain.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Bl -tag -width EADDRNOTAVA`
			`.It Bq Er ENOTDIR`
			`A component of the path prefix is not a directory.`
			`.It Bq Er ENAMETOOLONG`
			`A component of a pathname exceeded 255 characters,`
			`or an entire path name exceeded 1023 characters.`
			`.It Bq Er ENOENT`
			`A prefix component of the path name does not exist.`
			`.It Bq Er ELOOP`
			`Too many symbolic links were encountered in translating the pathname.`
			`.It Bq Er EIO`
			`An I/O error occurred while making the directory entry or allocating the inode.`
			`.It Bq Er EROFS`
			`The name would reside on a read-only file system.`
			`.It Bq Er EISDIR`
			`An empty pathname was specified.`
			`.El`
			`.Sh SEE ALSO`
			`.Xr connect 2 ,`
Sort cross references. 1997-01-20 23:23:22 +00:00			`.Xr getsockname 2 ,`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Xr listen 2 ,`
Sort cross references. 1997-01-20 23:23:22 +00:00			`.Xr socket 2`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh HISTORY`
			`The`
Update a bunch of man pages to use .Fn instead of .Nm when referencing funciton names. 1996-08-22 22:05:59 +00:00			`.Fn bind`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`function call appeared in`
			`.Bx 4.2 .`