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