SCTP_OPT_INFO(3)

💖 SCTP_OPT_INFO(3) 💖

okay bestie, welcome to the SCTP_OPT_INFO page — Linux Programmer's Manual energy, but make it cute. this is a section 3 joint, so it's a library function, not a command. no cap. 🫶

✨ NAME ✨

sctp_optinfo — get options on a SCTP socket. that's it, that's the job. she's a getter. 💅

🌸 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);

like, look at her. five arguments. she's giving main character energy and honestly? she earned it. ✨

🎀 DESCRIPTION 🎀

so sctp_opt_info is a wrapper library function, which is a fancy way of saying she's the friendly little helper you call when you wanna get SCTP-level options on a socket. the way that she just… retrieves stuff for you. obsessed. 😭💖

here's the breakdown of her little squad of arguments:

• sd — the socket descriptor for the socket you're asking about. your socket. your girl. 🦋
• id — for one-to-many style sockets, this specifies the association to query. for one-to-one style sockets, id is ignored — she doesn't even look at it, she's above that. 🙈
• opt — specifies the SCTP socket option you wanna get. (yes, the original spells it "specifes", we don't talk about that, moving on.) 💀
• arg — an option-specific structure buffer that you, the caller, provide. you bring the container, she fills it. it's giving teamwork. 🫶
• size — this one is a value-result parameter and she's kinda the whole plot twist. you pass it in holding the size of the buffer that arg points to, and on return she modifies it to tell you the actual size of the value that came back. so she reads it, then she rewrites it. icon behaviour. 👑

💀 RETURN VALUE 💀

• on success, sctp_opt_info returns 0. slay. 🎉
• on failure, -1 is returned, and errno gets set to the appropriate error code. so if things go sideways, check your errno bestie, she's telling you what happened. 🔥

🌈 SEE ALSO 🌈

go read these next, they're all part of the same friend group:

• sctp(7)
• sctp_bindx(3)
• sctp_connectx(3)
• sctp_sendmsg(3)
• sctp_sendv(3)
• sctp_send(3)
• sctp_recvmsg(3)
• sctp_recvv(3)
• sctp_peeloff(3)
• sctp_getpaddrs(3)
• sctp_getladdrs(3)

and that's the whole page, bestie!! 💜 this one came from Linux 2.6, dated 2004-01-30, and lives under the name SCTP_OPT_INFO(3) — yes she's been around a while and yes she still ate. periodt. 🎀✨🦋