lib/libc/net/sctp_connectx.3

   1 .\" Copyright (c) 1983, 1991, 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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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 June 19, 2007
  31 .Dt SCTP_CONNECTX 3
  32 .Os
  33 .Sh NAME
  34 .Nm sctp_connectx
  35 .Nd connect an SCTP socket with multiple destination addresses
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In sys/types.h
  40 .In sys/socket.h
  41 .In netinet/sctp.h
  42 .Ft int
  43 .Fn sctp_connectx "int sd" "struct sockaddr *addrs" "int addrcnt" "sctp_assoc_t *id"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn sctp_connectx
  47 call attempts to initiate an association to a peer SCTP
  48 endpoint.
  49 The call operates similarly to
  50 .Fn connect
  51 but it also provides the ability to specify multiple destination
  52 addresses for the peer.
  53 This allows a fault tolerant method
  54 of initiating an association.
  55 When one of the peers addresses
  56 is unreachable, the subsequent listed addresses will also be used
  57 to set up the association with the peer.
  58 .Pp
  59 The user also needs to consider that any address listed in an
  60 .Fn sctp_connectx
  61 call is also considered "confirmed".
  62 A confirmed address is one in
  63 which the SCTP transport will trust is a part of the association
  64 and it will not send a confirmation heartbeat to it with
  65 a random nonce.
  66 .Pp
  67 If the peer SCTP stack does not list one or more of
  68 the provided addresses in its response message then
  69 the extra addresses sent in the
  70 .Fn sctp_connectx
  71 call will be silently discarded from the association.
  72 On
  73 successful completion the provided
  74 .Fa id
  75 will be
  76 filled in with the association identification of the newly
  77 forming association.
  78 .Sh RETURN VALUES
  79 The call returns 0 on success and -1 upon failure.
  80 .Sh ERRORS
  81 The
  82 .Fn sctp_connectx
  83 function can return the following errors:
  84 .Bl -tag -width Er
  85 .It Bq Er EINVAL
  86 An address listed has an invalid family or no
  87 addresses were provided.
  88 .It Bq Er E2BIG
  89 The size of the address list exceeds the amount of
  90 data provided.
  91 .It Bq Er EBADF
  92 The argument
  93 .Fa s
  94 is not a valid descriptor.
  95 .It Bq Er ENOTSOCK
  96 The argument
  97 .Fa s
  98 is not a socket.
  99 .El
 100 .Sh SEE ALSO
 101 .Xr connect 2 ,
 102 .Xr sctp 4