| Austin Schuh | 8d0a285 | 2019-12-28 22:54:28 -0800 | [diff] [blame^] | 1 | .\" (C) Copyright Sridhar Samudrala IBM Corp. 2004, 2005. |
| 2 | .\" |
| 3 | .\" Permission is granted to distribute possibly modified copies |
| 4 | .\" of this manual provided the header is included verbatim, |
| 5 | .\" and in case of nontrivial modification author and date |
| 6 | .\" of the modification is added to the header. |
| 7 | .\" |
| 8 | .TH SCTP_OPT_INFO 3 2004-01-30 "Linux 2.6" "Linux Programmer's Manual" |
| 9 | .SH NAME |
| 10 | sctp_optinfo \- Get options on a SCTP socket. |
| 11 | .SH SYNOPSIS |
| 12 | .nf |
| 13 | .B #include <sys/types.h> |
| 14 | .B #include <sys/socket.h> |
| 15 | .B #include <netinet/sctp.h> |
| 16 | .sp |
| 17 | .BI "int sctp_opt_info(int " sd ", sctp_assoc_t " id ", int " opt , |
| 18 | .BI " void * " arg ", socklen_t * " size); |
| 19 | .fi |
| 20 | .SH DESCRIPTION |
| 21 | .BR sctp_opt_info |
| 22 | is a wrapper library function that can be used to get SCTP level options on |
| 23 | a socket. |
| 24 | .I sd |
| 25 | is the socket descriptor for which the option is requested. For one-to-many |
| 26 | style sockets, |
| 27 | .I id |
| 28 | specifies the association to query. For one-to-one style sockets, |
| 29 | .I id |
| 30 | is ignored. |
| 31 | .I opt |
| 32 | specifes the SCTP socket option to get. |
| 33 | .I arg |
| 34 | is an option-specific structure buffer provided by the caller. |
| 35 | .I size |
| 36 | is a value-result parameter, initially containing the size of the buffer |
| 37 | pointed to by |
| 38 | .I arg |
| 39 | and modifed on return to indicate the actual size of the value returned. |
| 40 | .SH "RETURN VALUE" |
| 41 | On success, |
| 42 | .BR sctp_opt_info |
| 43 | returns 0 and on failure -1 is returned with errno set to the appropriate |
| 44 | error code. |
| 45 | .SH "SEE ALSO" |
| 46 | .BR sctp (7) |
| 47 | .BR sctp_bindx (3), |
| 48 | .BR sctp_connectx (3), |
| 49 | .BR sctp_sendmsg (3), |
| 50 | .BR sctp_sendv (3), |
| 51 | .BR sctp_send (3), |
| 52 | .BR sctp_recvmsg (3), |
| 53 | .BR sctp_recvv (3), |
| 54 | .BR sctp_peeloff (3), |
| 55 | .BR sctp_getpaddrs (3), |
| 56 | .BR sctp_getladdrs (3), |