lib/libc/sys/connectat.2

   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 CONNECTAT 2
  32 .Os
  33 .Sh NAME
  34 .Nm connectat
  35 .Nd initiate a connection on 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 connectat "int fd" "int s" "const struct sockaddr *name" "socklen_t namelen"
  45 .Sh DESCRIPTION
  46 The
  47 .Fn connectat
  48 system call initiates a connection on a socket.
  49 It works just like the
  50 .Xr connect 2
  51 system call with two exceptions:
  52 .Pp
  53 .Bl -enum -offset indent -compact
  54 .It
  55 It is limited to sockets in the PF_LOCAL domain.
  56 .Pp
  57 .It
  58 If the file path stored in the
  59 .Fa sun_path
  60 field of the sockaddr_un structure is a relative path, it is located relative
  61 to the directory associated with the file descriptor
  62 .Fa fd .
  63 If
  64 .Fn connectat
  65 is passed the special value
  66 .Dv AT_FDCWD
  67 in the
  68 .Fa fd
  69 parameter, the current working directory is used and the behavior is identical
  70 to a call to
  71 .Xr connect 2 .
  72 .El
  73 .Sh RETURN VALUES
  74 .Rv -std connectat
  75 .Sh ERRORS
  76 The
  77 .Fn connectat
  78 system call may fail with the same errors as the
  79 .Xr connect 2
  80 system call for a UNIX domain socket or with the following errors:
  81 .Bl -tag -width Er
  82 .It Bq Er EBADF
  83 The
  84 .Fa sun_path
  85 field does not specify an absolute path and the
  86 .Fa fd
  87 argument is neither
  88 .Dv AT_FDCWD
  89 nor a valid file descriptor.
  90 .It Bq Er ENOTDIR
  91 The
  92 .Fa sun_path
  93 field is not an absolute path and
  94 .Fa fd
  95 is neither
  96 .Dv AT_FDCWD
  97 nor a file descriptor associated with a directory.
  98 .El
  99 .Sh SEE ALSO
 100 .Xr bindat 2 ,
 101 .Xr connect 2 ,
 102 .Xr socket 2 ,
 103 .Xr unix 4
 104 .Sh AUTHORS
 105 The
 106 .Nm
 107 was developed by
 108 .An Pawel Jakub Dawidek Aq pawel@dawidek.net
 109 under sponsorship from the FreeBSD Foundation.