xref: /freebsd/lib/libc/net/sctp_getaddrlen.3 (revision 7c3768006d0adbe052143f13f0d969f422c9fd3e)
1d8b5fd91SRandall Stewart.\" Copyright (c) 1983, 1991, 1993
2d8b5fd91SRandall Stewart.\"	The Regents of the University of California.  All rights reserved.
3d8b5fd91SRandall Stewart.\"
4d8b5fd91SRandall Stewart.\" Redistribution and use in source and binary forms, with or without
5d8b5fd91SRandall Stewart.\" modification, are permitted provided that the following conditions
6d8b5fd91SRandall Stewart.\" are met:
7d8b5fd91SRandall Stewart.\" 1. Redistributions of source code must retain the above copyright
8d8b5fd91SRandall Stewart.\"    notice, this list of conditions and the following disclaimer.
9d8b5fd91SRandall Stewart.\" 2. Redistributions in binary form must reproduce the above copyright
10d8b5fd91SRandall Stewart.\"    notice, this list of conditions and the following disclaimer in the
11d8b5fd91SRandall Stewart.\"    documentation and/or other materials provided with the distribution.
12d8b5fd91SRandall Stewart.\" 3. All advertising materials mentioning features or use of this software
13d8b5fd91SRandall Stewart.\"    must display the following acknowledgement:
14d8b5fd91SRandall Stewart.\"	This product includes software developed by the University of
15d8b5fd91SRandall Stewart.\"	California, Berkeley and its contributors.
16d8b5fd91SRandall Stewart.\" 4. Neither the name of the University nor the names of its contributors
17d8b5fd91SRandall Stewart.\"    may be used to endorse or promote products derived from this software
18d8b5fd91SRandall Stewart.\"    without specific prior written permission.
19d8b5fd91SRandall Stewart.\"
20d8b5fd91SRandall Stewart.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21d8b5fd91SRandall Stewart.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22d8b5fd91SRandall Stewart.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23d8b5fd91SRandall Stewart.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24d8b5fd91SRandall Stewart.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25d8b5fd91SRandall Stewart.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26d8b5fd91SRandall Stewart.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27d8b5fd91SRandall Stewart.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28d8b5fd91SRandall Stewart.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29d8b5fd91SRandall Stewart.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30d8b5fd91SRandall Stewart.\" SUCH DAMAGE.
31d8b5fd91SRandall Stewart.\"
32d8b5fd91SRandall Stewart.\"     From: @(#)send.2	8.2 (Berkeley) 2/21/94
33d8b5fd91SRandall Stewart.\" $FreeBSD$
34d8b5fd91SRandall Stewart.\"
35d8b5fd91SRandall Stewart.Dd December 15, 2006
36d8b5fd91SRandall Stewart.Dt SCTP_GETADDRLEN 3
37d8b5fd91SRandall Stewart.Os
38d8b5fd91SRandall Stewart.Sh NAME
39d8b5fd91SRandall Stewart.Nm sctp_getaddrlen
40d8b5fd91SRandall Stewart.Nd return the address length of an address family
41d8b5fd91SRandall Stewart.Sh LIBRARY
42d8b5fd91SRandall Stewart.Lb libc
43d8b5fd91SRandall Stewart.Sh SYNOPSIS
44d8b5fd91SRandall Stewart.In sys/types.h
45d8b5fd91SRandall Stewart.In sys/socket.h
467c376800SRandall Stewart.In netinet/sctp.h
47d8b5fd91SRandall Stewart.Ft int
48d8b5fd91SRandall Stewart.Fn sctp_getaddrlen "sa_family_t family""
49d8b5fd91SRandall Stewart.Sh DESCRIPTION
50d8b5fd91SRandall StewartThe
51d8b5fd91SRandall Stewart.Fn sctp_getaddrlen
52d8b5fd91SRandall Stewartreturns the size of a specific address family. This function
53d8b5fd91SRandall Stewartis provided for application binary compatability since it
54d8b5fd91SRandall Stewartprovides the application with the size the operating system
55d8b5fd91SRandall Stewartthinks the specific address family is. Note that the function
56d8b5fd91SRandall Stewartwill actually create an SCTP socket and then gather the
57d8b5fd91SRandall Stewartinformation via a
58d8b5fd91SRandall Stewart.Fn getsockopt
59d8b5fd91SRandall Stewartsystem calls. If for some reason a SCTP socket cannot
60d8b5fd91SRandall Stewartbe created or the getsockopt fails, an error will be returned
61d8b5fd91SRandall Stewartwith errno set as specified in the
62d8b5fd91SRandall Stewart.Fn socket
63d8b5fd91SRandall Stewartor
64d8b5fd91SRandall Stewart.Fn getsockopt
65d8b5fd91SRandall Stewartsystem call.
66d8b5fd91SRandall Stewart.Sh RETURN VALUES
67d8b5fd91SRandall StewartThe call returns the number of bytes that the operating
68d8b5fd91SRandall Stewartsystem expects for the specific address family or -1.
69d8b5fd91SRandall Stewart.Sh ERRORS
70d8b5fd91SRandall StewartThe
71d8b5fd91SRandall Stewart.Fn sctp_getaddrlen
72d8b5fd91SRandall Stewart.Bl -tag -width Er
73d8b5fd91SRandall Stewart.It Bq Er EINVAL
74d8b5fd91SRandall StewartThe address family specified does NOT exist.
75d8b5fd91SRandall Stewart.El
76d8b5fd91SRandall Stewart.Sh SEE ALSO
77d8b5fd91SRandall Stewart.Xr sctp 4 ,
78d8b5fd91SRandall Stewart.Xr socket 2 ,
79d8b5fd91SRandall Stewart.Xr getsockopt 2 ,
80d8b5fd91SRandall Stewart
81