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