lib/libc/sys/bind.2

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