summaryrefslogtreecommitdiffstats
path: root/lib/libc/net/sctp_getaddrlen.3
diff options
context:
space:
mode:
authorrrs <rrs@FreeBSD.org>2007-02-22 14:32:39 +0000
committerrrs <rrs@FreeBSD.org>2007-02-22 14:32:39 +0000
commitae6663525ac1c121369ed2987517cf2d29f6139a (patch)
treecd217c0beddbd5880de5487d7d696e782050ac87 /lib/libc/net/sctp_getaddrlen.3
parent5a82d0298943e1c4429659c6b6db3445d0ca3fc0 (diff)
downloadFreeBSD-src-ae6663525ac1c121369ed2987517cf2d29f6139a.zip
FreeBSD-src-ae6663525ac1c121369ed2987517cf2d29f6139a.tar.gz
First cut of the sctp man pages. Still need work.
Diffstat (limited to 'lib/libc/net/sctp_getaddrlen.3')
-rw-r--r--lib/libc/net/sctp_getaddrlen.380
1 files changed, 80 insertions, 0 deletions
diff --git a/lib/libc/net/sctp_getaddrlen.3 b/lib/libc/net/sctp_getaddrlen.3
new file mode 100644
index 0000000..64a83f6
--- /dev/null
+++ b/lib/libc/net/sctp_getaddrlen.3
@@ -0,0 +1,80 @@
+.\" Copyright (c) 1983, 1991, 1993
+.\" The Regents of the University of California. All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\" must display the following acknowledgement:
+.\" This product includes software developed by the University of
+.\" California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\" may be used to endorse or promote products derived from this software
+.\" without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" From: @(#)send.2 8.2 (Berkeley) 2/21/94
+.\" $FreeBSD$
+.\"
+.Dd December 15, 2006
+.Dt SCTP_GETADDRLEN 3
+.Os
+.Sh NAME
+.Nm sctp_getaddrlen
+.Nd return the address length of an address family
+.Sh LIBRARY
+.Lb libc
+.Sh SYNOPSIS
+.In sys/types.h
+.In sys/socket.h
+.In sys/sctp.h
+.Ft int
+.Fn sctp_getaddrlen "sa_family_t family""
+.Sh DESCRIPTION
+The
+.Fn sctp_getaddrlen
+returns the size of a specific address family. This function
+is provided for application binary compatability since it
+provides the application with the size the operating system
+thinks the specific address family is. Note that the function
+will actually create an SCTP socket and then gather the
+information via a
+.Fn getsockopt
+system calls. If for some reason a SCTP socket cannot
+be created or the getsockopt fails, an error will be returned
+with errno set as specified in the
+.Fn socket
+or
+.Fn getsockopt
+system call.
+.Sh RETURN VALUES
+The call returns the number of bytes that the operating
+system expects for the specific address family or -1.
+.Sh ERRORS
+The
+.Fn sctp_getaddrlen
+.Bl -tag -width Er
+.It Bq Er EINVAL
+The address family specified does NOT exist.
+.El
+.Sh SEE ALSO
+.Xr sctp 4 ,
+.Xr socket 2 ,
+.Xr getsockopt 2 ,
+
OpenPOWER on IntegriCloud