1.\" $NetBSD: sctp_getpaddrs.3,v 1.2 2018/08/13 06:00:21 wiz Exp $ 2.\" 3.\" Copyright (c) 1983, 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 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.\" 3. Neither the name of the University nor the names of its contributors 15.\" may be used to endorse or promote products derived from this software 16.\" without specific prior written permission. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28.\" SUCH DAMAGE. 29.\" 30.\" From: @(#)send.2 8.2 (Berkeley) 2/21/94 31.\" 32.Dd August 1, 2018 33.Dt SCTP_GETPADDRS 3 34.Os 35.Sh NAME 36.Nm sctp_getpaddrs , 37.Nm sctp_getladdrs 38.Nd return a list of addresses to the caller 39.Sh LIBRARY 40.Lb libc 41.Sh SYNOPSIS 42.In sys/types.h 43.In sys/socket.h 44.In netinet/sctp.h 45.Ft int 46.Fn sctp_getpaddrs "int s" "sctp_assoc_t asocid" "struct sockaddr **addrs" 47.Ft int 48.Fn sctp_getladdrs "int s" "sctp_assoc_t asocid" "struct sockaddr **addrs" 49.Sh DESCRIPTION 50The 51.Fn sctp_getpaddrs 52function is used to get the list of the peers addresses. 53The 54.Fn sctp_getladdrs 55function is used to get the list of the local addresses. 56The association of interest is identified by the 57.Fa asocid 58argument. 59The addresses are returned in a newly allocated 60array of socket addresses returned in the argument 61.Fa addrs 62upon success. 63.Pp 64After the caller is finished, the function 65.Xr sctp_freepaddrs 3 66or 67.Xr sctp_freeladdrs 3 68should be used to release the memory allocated by these 69calls. 70.Sh RETURN VALUES 71The call returns \-1 upon failure and a count of 72the number of addresses returned in 73.Fa addrs 74upon success. 75.Sh ERRORS 76The functions can return the following errors: 77.Bl -tag -width Er 78.It Bq Er EBADF 79The argument 80.Fa s 81is not a valid descriptor. 82.It Bq Er EINVAL 83An address listed has an invalid family or no 84addresses were provided. 85.It Bq Er ENOMEM 86The call cannot allocate memory to hold the 87socket addresses. 88.It Bq Er ENOTSOCK 89The argument 90.Fa s 91is not a socket. 92.El 93.Sh SEE ALSO 94.Xr getsockopt 2 , 95.Xr sctp_freeladdrs 3 , 96.Xr sctp_freepaddrs 3 , 97.Xr sctp 4 98.Rs 99.%R RFC 100.%N 6458 101.%T "Sockets API Extensions for the Stream Control Transmission Protocol (SCTP)" 102.%D December 2011 103.Re 104.Sh HISTORY 105These functions first appeared in 106.Nx 9.0 . 107