1.\" $OpenBSD: bind.2,v 1.18 2013/07/17 05:42:11 schwarze 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 $Mdocdate: July 17 2013 $ 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/socket.h> 41.Ft int 42.Fn bind "int s" "const struct sockaddr *name" "socklen_t namelen" 43.Sh DESCRIPTION 44.Fn bind 45assigns a name to an unnamed socket. 46When a socket is created with 47.Xr socket 2 48it exists in a name space (address family) but has no name assigned. 49.Fn bind 50requests that 51.Fa name 52be assigned to the socket. 53.Fa namelen 54indicates the amount of space pointed to by 55.Fa name , 56in bytes. 57.Sh NOTES 58Binding a name in the 59.Ux Ns -domain 60creates a socket in the file system that must be deleted by the caller 61when it is no longer needed (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, or 88.Fa namelen 89is not a valid length for the supplied address. 90.It Bq Er EAFNOSUPPORT 91The family of the socket and that requested in 92.Va name->sa_family 93are not equivalent. 94.It Bq Er ENOBUFS 95Insufficient buffer space is available. 96.It Bq Er EACCES 97The requested address is protected, and the current user 98has inadequate permission to access it. 99.It Bq Er EFAULT 100The 101.Fa name 102parameter is not in a valid part of the user address space. 103.El 104.Pp 105The following errors are specific to binding names in the 106.Ux Ns -domain . 107.Bl -tag -width Er 108.It Bq Er ENOTDIR 109A component of the path prefix is not a directory. 110.It Bq Er ENAMETOOLONG 111A component of a pathname exceeded 112.Dv {NAME_MAX} 113characters, or an entire path name exceeded 114.Dv {PATH_MAX} 115characters. 116.It Bq Er ENOENT 117A prefix component of the path name does not exist. 118.It Bq Er ELOOP 119Too many symbolic links were encountered in translating the pathname. 120.It Bq Er EIO 121An I/O error occurred while making the directory entry or allocating the inode. 122.It Bq Er EROFS 123The name would reside on a read-only file system. 124.It Bq Er EISDIR 125An empty pathname was specified. 126.El 127.Sh SEE ALSO 128.Xr connect 2 , 129.Xr getsockname 2 , 130.Xr listen 2 , 131.Xr socket 2 132.Sh STANDARDS 133The 134.Fn bind 135function conforms to 136.St -p1003.1-2008 . 137.Sh HISTORY 138The 139.Fn bind 140system call first appeared in 141.Bx 4.1c . 142