1.\" Copyright (c) 1983, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 3. All advertising materials mentioning features or use of this software 13.\" must display the following acknowledgement: 14.\" This product includes software developed by the University of 15.\" California, Berkeley and its contributors. 16.\" 4. Neither the name of the University nor the names of its contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)bind.2 8.1 (Berkeley) 6/4/93 33.\" $FreeBSD$ 34.\" 35.Dd June 4, 1993 36.Dt BIND 2 37.Os 38.Sh NAME 39.Nm bind 40.Nd assign a local protocol address to a socket 41.Sh LIBRARY 42.Lb libc 43.Sh SYNOPSIS 44.In sys/types.h 45.In sys/socket.h 46.Ft int 47.Fn bind "int s" "const struct sockaddr *addr" "socklen_t addrlen" 48.Sh DESCRIPTION 49The 50.Fn bind 51system call 52assigns the local protocol address to a socket. 53When a socket is created 54with 55.Xr socket 2 56it exists in an address family space but has no protocol address assigned. 57The 58.Fn bind 59system call requests that 60.Fa addr 61be assigned to the socket. 62.Sh NOTES 63Binding an address in the UNIX domain creates a socket in the file 64system that must be deleted by the caller when it is no longer 65needed (using 66.Xr unlink 2 ) . 67.Pp 68The rules used in address binding vary between communication domains. 69Consult the manual entries in section 4 for detailed information. 70.Pp 71For maximum portability, you should always zero the socket address structure 72before populating it and passing it to 73.Fn bind . 74.Sh RETURN VALUES 75.Rv -std bind 76.Sh ERRORS 77The 78.Fn bind 79system call will fail if: 80.Bl -tag -width Er 81.It Bq Er EAGAIN 82Kernel resources to complete the request are 83temporarily unavailable. 84.It Bq Er EBADF 85The 86.Fa s 87argument 88is not a valid descriptor. 89.It Bq Er ENOTSOCK 90The 91.Fa s 92argument 93is not a socket. 94.It Bq Er EADDRNOTAVAIL 95The specified address is not available from the local machine. 96.It Bq Er EADDRINUSE 97The specified address is already in use. 98.It Bq Er EACCES 99The requested address is protected, and the current user 100has inadequate permission to access it. 101.It Bq Er EFAULT 102The 103.Fa addr 104argument is not in a valid part of the user 105address space. 106.El 107.Pp 108The following errors are specific to binding addresses in the UNIX domain. 109.Bl -tag -width EADDRNOTAVA 110.It Bq Er ENOTDIR 111A component of the path prefix is not a directory. 112.It Bq Er ENAMETOOLONG 113A component of a pathname exceeded 255 characters, 114or an entire path name exceeded 1023 characters. 115.It Bq Er ENOENT 116A prefix component of the path name does not exist. 117.It Bq Er ELOOP 118Too many symbolic links were encountered in translating the pathname. 119.It Bq Er EIO 120An I/O error occurred while making the directory entry or allocating the inode. 121.It Bq Er EROFS 122The name would reside on a read-only file system. 123.It Bq Er EISDIR 124An empty pathname was specified. 125.El 126.Sh SEE ALSO 127.Xr connect 2 , 128.Xr getsockname 2 , 129.Xr listen 2 , 130.Xr socket 2 131.Sh HISTORY 132The 133.Fn bind 134system call appeared in 135.Bx 4.2 . 136