SCTP_OPT_INFO(3)

SCTP_OPT_INFO(3) | Library Functions Manual | SCTP_OPT_INFO(3)

# NAME

`sctp_opt_info` — get SCTP socket information

# LIBRARY

Standard C Library (libc, -lc)

# SYNOPSIS

`#include <sys/types.h>`
`#include <sys/socket.h>`
`#include <netinet/sctp.h>`

int
`sctp_opt_info`(int sd, sctp_assoc_t id, int opt, void *arg, socklen_t *size);

# DESCRIPTION

The `sctp_opt_info`() call provides a multi-os compatible method for getting specific `getsockopt`() data where an association identification needs to be passed into the operating system. For those who wish to write portable code amongst multiple operating systems this call should be used for the following SCTP socket options.

`SCTP_RTOINFO`

`SCTP_ASSOCINFO`

`SCTP_PRIMARY_ADDR`

`SCTP_PEER_ADDR_PARAMS`

`SCTP_DEFAULT_SEND_PARAM`

`SCTP_MAX_SEG`

`SCTP_AUTH_ACTIVE_KEY`

`SCTP_DELAYED_SACK`

`SCTP_MAX_BURST`

`SCTP_CONTEXT`

`SCTP_EVENT`

`SCTP_DEFAULT_SNDINFO`

`SCTP_DEFAULT_PRINFO`

`SCTP_STATUS`

`SCTP_GET_PEER_ADDR_INFO`

`SCTP_PEER_AUTH_CHUNKS`

`SCTP_LOCAL_AUTH_CHUNKS`

# RETURN VALUES

The call returns 0 on success and -1 upon error.

# ERRORS

The `sctp_opt_info`() function can return the following errors:

[`EBADF`]
  The argument s is not a valid descriptor.
[`EINVAL`]
  The argument arg value was invalid.
[`ENOTSOCK`]
  The argument s is not a socket.
[`EOPNOTSUPP`]
  The argument opt was not one of the above listed SCTP socket options.

# SEE ALSO

getsockopt(2), getsockopt2(2), sctp(4)

Sockets API Extensions for the Stream Control Transmission Protocol (SCTP), RFC, 6458, December 2011.

# HISTORY

This function first appeared in NetBSD 9.0.

August 1, 2018 | NetBSD 11.0