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_OPT_INFO 3 37.Os 38.Sh NAME 39.Nm sctp_opt_info 40.Nd get SCTP socket information 41.Sh LIBRARY 42.Lb libc 43.Sh SYNOPSIS 44.In sys/types.h 45.In sys/socket.h 46.In netinet/sctp.h 47.Ft int 48.Fn sctp_opt_info "int s" "sctp_assoc_t" "int opt" "void *arg" "socklen_t *size" 49.Sh DESCRIPTION 50The 51.Fn sctp_opt_info 52call provides a multi-os compatible method for getting 53specific 54.Fn getsockopt 55data where an association identification needs to be passed 56into the operating system. 57For 58.Fx 59a direct 60.Fn getsockopt 61may be used, since 62.Fx 63has the ability to pass information 64into the operating system on a 65.Fn getsockopt 66call. 67Other operating systems may not have this ability. 68For those 69who wish to write portable code amongst multiple operating systems 70this call should be used for the following SCTP 71socket options. 72.Pp 73.Dv SCTP_RTOINFO 74.Pp 75.Dv SCTP_ASSOCINFO 76.Pp 77.Dv SCTP_PRIMARY_ADDR 78.Pp 79.Dv SCTP_SET_PEER_PRIMARY_ADDR 80.Pp 81.Dv SCTP_STATUS 82.Pp 83.Dv SCTP_GET_PEER_ADDR_INFO 84.Pp 85.Dv SCTP_AUTH_ACTIVE_KEY 86.Pp 87.Dv SCTP_PEER_AUTH_CHUNKS 88.Pp 89.Dv SCTP_LOCAL_AUTH_CHUNKS 90.Sh ERRORS 91The 92.Fn sctp_opt_info 93function can return the following errors. 94.Bl -tag -width Er 95.It Bq Er EINVAL 96The argument 97.Fa arg 98value was invalid. 99.It Bq Er EOPNOTSUPP 100The argument 101.Fa opt 102was not one of the above listed SCTP socket 103options. 104.It Bq Er EBADF 105The argument 106.Fa s 107is not a valid descriptor. 108.It Bq Er ENOTSOCK 109The argument 110.Fa s 111is not a socket. 112.El 113.Sh SEE ALSO 114.Xr getsockopt 2 , 115.Xr sctp 4 116