xref: /freebsd-12.1/lib/libc/sys/bindat.2 (revision e2811155)
1.\" Copyright (c) 2013 The FreeBSD Foundation
2.\" All rights reserved.
3.\"
4.\" This documentation was written by Pawel Jakub Dawidek under sponsorship from
5.\" the FreeBSD Foundation.
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.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\" $FreeBSD$
29.\"
30.Dd February 13, 2013
31.Dt BINDAT 2
32.Os
33.Sh NAME
34.Nm bindat
35.Nd assign a local protocol address to a socket
36.Sh LIBRARY
37.Lb libc
38.Sh SYNOPSIS
39.In sys/types.h
40.In sys/socket.h
41.Pp
42.In fcntl.h
43.Ft int
44.Fn bindat "int fd" "int s" "const struct sockaddr *addr" "socklen_t addrlen"
45.Sh DESCRIPTION
46The
47.Fn bindat
48system call assigns the local protocol address to a socket.
49When passed the special value
50.Dv AT_FDCWD
51in the
52.Fa fd
53parameter, the behavior is identical to a call to
54.Xr bind 2 .
55Otherwise,
56.Fn bindat
57works like the
58.Xr bind 2
59system call with two exceptions:
60.Pp
61.Bl -enum -offset indent -compact
62.It
63It is limited to sockets in the PF_LOCAL domain.
64.Pp
65.It
66If the file path stored in the
67.Fa sun_path
68field of the sockaddr_un structure is a relative path, it is located relative
69to the directory associated with the file descriptor
70.Fa fd .
71.El
72.Sh RETURN VALUES
73.Rv -std bindat
74.Sh ERRORS
75The
76.Fn bindat
77system call may fail with the same errors as the
78.Xr bind 2
79system call or with the following errors:
80.Bl -tag -width Er
81.It Bq Er EBADF
82The
83.Fa sun_path
84field does not specify an absolute path and the
85.Fa fd
86argument is neither
87.Dv AT_FDCWD
88nor a valid file descriptor.
89.It Bq Er ENOTDIR
90The
91.Fa sun_path
92field is not an absolute path and
93.Fa fd
94is neither
95.Dv AT_FDCWD
96nor a file descriptor associated with a directory.
97.El
98.Sh SEE ALSO
99.Xr bind 2 ,
100.Xr connectat 2 ,
101.Xr socket 2 ,
102.Xr unix 4
103.Sh AUTHORS
104The
105.Nm
106was developed by
107.An Pawel Jakub Dawidek Aq Mt [email protected]
108under sponsorship from the FreeBSD Foundation.
109