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