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