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