.\" Hey Emacs! This file is -*- nroff -*- source. .\" .\" Copyright 1993 Rickard E. Faith (faith@cs.unc.edu) .\" Portions extracted from /usr/include/sys/socket.h, which does not have .\" any authorship information in it. It is probably available under the GPL. .\" .\" Permission is granted to make and distribute verbatim copies of this .\" manual provided the copyright notice and this permission notice are .\" preserved on all copies. .\" .\" Permission is granted to copy and distribute modified versions of this .\" manual under the conditions for verbatim copying, provided that the .\" entire resulting derived work is distributed under the terms of a .\" permission notice identical to this one .\" .\" Since the Linux kernel and libraries are constantly changing, this .\" manual page may be incorrect or out-of-date. The author(s) assume no .\" responsibility for errors or omissions, or for damages resulting from .\" the use of the information contained herein. The author(s) may not .\" have taken the same level of care in the production of this manual, .\" which is licensed free of charge, as they might when working .\" professionally. .\" .\" Formatted or processed versions of this manual, if unaccompanied by .\" the source, must acknowledge the copyright and authors of this work. .\" .\" .\" Other portions are from the 6.9 (Berkeley) 3/10/91 man page: .\" .\" Copyright (c) 1983 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. .\" .TH BIND 2 "23 July 1993" "Linux 0.99.11" "Linux Programmer's Manual" .SH NAME bind \- bind a name to a socket .SH SYNOPSIS .B #include .br .B #include .sp .BI "int bind(int " sockfd ", struct sockaddr *" my_addr ", int " addrlen ); .SH DESCRIPTION .B bind gives the socket, .IR sockfd , the local address .IR my_addr . .I my_addr is .I addrlen bytes long. Traditionally, this is called "assigning a name to a socket" (when a socket is created with .BR socket (2), it exists in a name space (address family) but has no name assigned.) .SH NOTES Binding a name 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 .BR unlink (2)). The rules used in name binding vary between communication domains. Consult the manual entries in section 4 for detailed information. .SH "RETURN VALUE" On success, zero is returned. On error, \-1 is returned, and .I errno is set appropriately. .SH ERRORS .TP 0.8i .B EBADF .I sockfd is not a valid descriptor. .TP .B EINVAL The socket is already bound to an address. This may change in the future: see .I linux/unix/sock.c for details. .TP .B EACCES The address is protected, and the user is not the super-user. .PP The following errors are specific to UNIX domain (AF_UNIX) sockets: .TP 0.8i .B EINVAL The .I addr_len was wrong, or the socket was not in the .B AF_UNIX family. .TP .B EROFS The socket inode would reside on a read-only file system. .TP .B EFAULT .I my_addr points outside your accessible address space. .TP .B ENAMETOOLONG .I my_addr is too long. .TP .B ENOENT The file does not exist. .TP .B ENOMEM Insufficient kernel memory was available. .TP .B ENOTDIR A component of the path prefix is not a directory. .TP .B EACCES Search permission is denied on a component of the path prefix. .TP .B ELOOP .I my_addr contains a circular reference (i.e., via a symbolic link) .SH HISTORY The .B bind function call appeared in BSD 4.2. .SH "SEE ALSO" .BR accept "(2), " connect "(2), " listen "(2), " .BR socket "(2), " getsockname (2)