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