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