The Regents of the University of California. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software
must display the following acknowledgement:
This product includes software developed by the University of
California, Berkeley and its contributors.
4. Neither the name of the University nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
@(#)bind.2 8.1 (Berkeley) 6/4/93
$FreeBSD: head/lib/libc/sys/bind.2 59954 2000-05-04 13:09:25Z phantom $
.Dd June 4, 1993 .Dt BIND 2 .Os BSD 4.2 .Sh NAME .Nm bind .Nd assign a local protocol address to a socket. .Sh LIBRARY .Lb libc .Sh SYNOPSIS .Fd #include <sys/types.h> .Fd #include <sys/socket.h> .Ft int .Fn bind "int s" "const struct sockaddr *addr" "socklen_t addrlen" .Sh DESCRIPTION .Fn Bind assigns the local protocol address to a socket. When a socket is created with .Xr socket 2 it exists in an address family space but has no protocol address assigned. .Fn Bind requests that .Fa addr be assigned to the socket. .Sh NOTES Binding an address in the UNIX domain creates a socket in the file system that must be deleted by the caller when it is no longer needed (using .Xr unlink 2 ) .
p The rules used in address binding vary between communication domains. Consult the manual entries in section 4 for detailed information. .Sh IMPLEMENTATION NOTES
p In the non-threaded library .Fn bind is implemented as the .Va bind syscall.
p In the threaded library, the .Va bind syscall is assembled to .Fn _thread_sys_bind and .Fn bind is implemented as a function which locks .Va s for read and write, then calls .Fn _thread_sys_bind . Before returning, .Fn bind unlocks .Va s . .Sh RETURN VALUES If the bind is successful, a 0 value is returned. A return value of -1 indicates an error, which is further specified in the global .Va errno . .Sh ERRORS The .Fn bind call will fail if: l -tag -width Er t Bq Er EAGAIN Kernel resources to complete the request are temporarily unavilable. t Bq Er EBADF .Fa S is not a valid descriptor. t Bq Er ENOTSOCK .Fa S is not a socket. t Bq Er EADDRNOTAVAIL The specified address is not available from the local machine. t Bq Er EADDRINUSE The specified address is already in use. t Bq Er EACCES The requested address is protected, and the current user has inadequate permission to access it. t Bq Er EFAULT The .Fa addr parameter is not in a valid part of the user address space. .El
p The following errors are specific to binding addresses in the UNIX domain. l -tag -width EADDRNOTAVA t Bq Er ENOTDIR A component of the path prefix is not a directory. t Bq Er ENAMETOOLONG A component of a pathname exceeded 255 characters, or an entire path name exceeded 1023 characters. t Bq Er ENOENT A prefix component of the path name does not exist. t Bq Er ELOOP Too many symbolic links were encountered in translating the pathname. t Bq Er EIO An I/O error occurred while making the directory entry or allocating the inode. t Bq Er EROFS The name would reside on a read-only file system. t Bq Er EISDIR An empty pathname was specified. .El .Sh SEE ALSO .Xr connect 2 , .Xr getsockname 2 , .Xr listen 2 , .Xr socket 2 .Sh HISTORY The .Fn bind function call appeared in x 4.2 .