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.\" From: @(#)send.2 8.2 (Berkeley) 2/21/94 33.\" $FreeBSD$ 34.\" 35.Dd December 15, 2006 36.Dt SCTP_GETPADDR 3 37.Os 38.Sh NAME 39.Nm sctp_getpaddrs 40.Nm sctp_getladdrs 41.Nd return a list of addresses to the caller. 42.Sh LIBRARY 43.Lb libc 44.Sh SYNOPSIS 45.In sys/types.h 46.In sys/socket.h 47.In sys/sctp.h 48.Ft int 49.Fn sctp_getpaddrs "int s" "sctp_assoc_t asocid" "struct sockaddr **addrs" 50.Ft int 51.Fn sctp_getladdrs "int s" "sctp_assoc_t asocid" "struct sockaddr **addrs" 52.Sh DESCRIPTION 53The 54.Fn sctp_getpaddrs 55function is used to get the list of the peers addresses. 56The 57.Fn sctp_getladdrs 58function is used to get the list of the local addresses. 59The association of interest is identified by the 60.Fa asocid 61argument. The addresses are returned in a newly allocated 62array of socket addresses returned in the argument 63.Fa addrs 64upon success. 65 .Pp 66After the caller is through the function 67.Fn sctp_freepaddrs 68or 69.Fn sctp_freeladdrs 70should be used to release the memory allocated by these 71calls. 72.Sh RETURN VALUES 73The call returns -1 upon failure and a count of 74the number of addresses returned in 75.Fa addrs 76upon success. 77.Sh ERRORS 78The functions can return the following errors. 79.Bl -tag -width Er 80.It Bq Er EINVAL 81An address listed has an invalid family or no 82addresses were provided. 83.It Bq Er ENOMEM 84The call cannot allocate memory to hold the 85socket addresses. 86.It Bq Er EBADF 87The argument 88.Fa s 89is not a valid descriptor. 90.It Bq Er ENOTSOCK 91The argument 92.Fa s 93is not a socket. 94.El 95.Sh SEE ALSO 96.Xr sctp 4 , 97.Xr sctp_freepaddrs 3 , 98.Xr sctp_freeladdrs 3 , 99.Xr getsockopt 2 , 100 101