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 49.Fn Bind 50assigns the local protocol address to a socket. 51When a socket is created 52with 53.Xr socket 2 54it exists in an address family space but has no protocol address assigned. 55.Fn Bind 56requests that 57.Fa addr 58be assigned to the socket. 59.Sh NOTES 60Binding an address in the UNIX domain creates a socket in the file 61system that must be deleted by the caller when it is no longer 62needed (using 63.Xr unlink 2 ) . 64.Pp 65The rules used in address binding vary between communication domains. 66Consult the manual entries in section 4 for detailed information. 67.Pp 68For maximum portability, you should always zero the socket address structure 69before populating it and passing it to 70.Fn bind . 71.Sh RETURN VALUES 72.Rv -std bind 73.Sh ERRORS 74The 75.Fn bind 76call will fail if: 77.Bl -tag -width Er 78.It Bq Er EAGAIN 79Kernel resources to complete the request are 80temporarily unavilable. 81.It Bq Er EBADF 82.Fa S 83is not a valid descriptor. 84.It Bq Er ENOTSOCK 85.Fa S 86is not a socket. 87.It Bq Er EADDRNOTAVAIL 88The specified address is not available from the local machine. 89.It Bq Er EADDRINUSE 90The specified address is already in use. 91.It Bq Er EACCES 92The requested address is protected, and the current user 93has inadequate permission to access it. 94.It Bq Er EFAULT 95The 96.Fa addr 97parameter is not in a valid part of the user 98address space. 99.El 100.Pp 101The following errors are specific to binding addresses in the UNIX domain. 102.Bl -tag -width EADDRNOTAVA 103.It Bq Er ENOTDIR 104A component of the path prefix is not a directory. 105.It Bq Er ENAMETOOLONG 106A component of a pathname exceeded 255 characters, 107or an entire path name exceeded 1023 characters. 108.It Bq Er ENOENT 109A prefix component of the path name does not exist. 110.It Bq Er ELOOP 111Too many symbolic links were encountered in translating the pathname. 112.It Bq Er EIO 113An I/O error occurred while making the directory entry or allocating the inode. 114.It Bq Er EROFS 115The name would reside on a read-only file system. 116.It Bq Er EISDIR 117An empty pathname was specified. 118.El 119.Sh SEE ALSO 120.Xr connect 2 , 121.Xr getsockname 2 , 122.Xr listen 2 , 123.Xr socket 2 124.Sh HISTORY 125The 126.Fn bind 127function call appeared in 128.Bx 4.2 . 129