explain_socketpair(3)

💖 explain_socketpair(3) 💖

okay bestie, so this is a library functions manual page, and it's literally all about explaining the errors that socketpair(2) throws at you. no cap, it's giving "therapist for your syscalls" energy. 🫶

---

✨ NAME ✨

explain_socketpair — explain socketpair(2) errors

like, it takes a cryptic errno situation and turns it into an actual sentence you can read. 💅

---

🌸 SYNOPSIS 🌸

#include <libexplain/socketpair.h>
const char *explain_socketpair(int domain, int type, int protocol, int
*sv);
const char *explain_errno_socketpair(int errnum, int domain, int type,
int protocol, int *sv);
void explain_message_socketpair(char *message, int message_size, int
domain, int type, int protocol, int *sv);
void explain_message_errno_socketpair(char *message, int message_size,
int errnum, int domain, int type, int protocol, int *sv);

four whole functions. four. it's a whole squad. 🔥

---

🦋 DESCRIPTION 🦋

so these functions? they're how you get explanations for errors that the socketpair(2) system call hands back to you. they translate the chaos into words. ✨

---

💜 explain_socketpair

const char *explain_socketpair(int domain, int type, int protocol, int
*sv);

the explain_socketpair function is your girl for getting an explanation of an error returned by the socketpair(2) system call. the least the message will contain is the value of strerror(errno), but usually it does so much better and points at the underlying cause in way more detail. it ate. 👑

the errno global variable will be used to obtain the error value to be decoded.

• domain — the original domain, exactly as passed to the socketpair(2) system call.
• type — the original type, exactly as passed to the socketpair(2) system call.
• protocol — the original protocol, exactly as passed to the socketpair(2) system call.
• sv — the original sv, exactly as passed to the socketpair(2) system call.

Returns: the message explaining the error. this message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. it will be overwritten by the next call to any libexplain function which shares this buffer, including other threads. 💀

Note: this function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library. be careful out there bestie, she's not monogamous with her buffer. 😭

Example: this function is intended to be used in a fashion similar to the following example:

if (socketpair(domain, type, protocol, sv) < 0)
{
    fprintf(stderr, "%s\n", explain_socketpair(domain, type,
    protocol, sv));
    exit(EXIT_FAILURE);
}

the above code example is available pre‐packaged as the explain_socketpair_or_die(3) function. 🌈

---

💖 explain_errno_socketpair

const char *explain_errno_socketpair(int errnum, int domain, int type,
int protocol, int *sv);

the explain_errno_socketpair function is used to obtain an explanation of an error returned by the socketpair(2) system call. the least the message will contain is the value of strerror(errno), but usually it will do much better, and indicate the underlying cause in more detail. periodt. ✨

• errnum — the error value to be decoded, usually obtained from the errno global variable just before this function is called. this is necessary if you need to call any code between the system call to be explained and this function, because many libc functions will alter the value of errno. (rude of them, honestly. 🙈)
• domain — the original domain, exactly as passed to the socketpair(2) system call.
• type — the original type, exactly as passed to the socketpair(2) system call.
• protocol — the original protocol, exactly as passed to the socketpair(2) system call.
• sv — the original sv, exactly as passed to the socketpair(2) system call.

Returns: the message explaining the error. this message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. this will be overwritten by the next call to any libexplain function which shares this buffer, including other threads. 😭

Note: this function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

Example: this function is intended to be used in a fashion similar to the following example:

if (socketpair(domain, type, protocol, sv) < 0)
{
    int err = errno;
    fprintf(stderr, "%s\n", explain_errno_socketpair(err, domain,
    type, protocol, sv));
    exit(EXIT_FAILURE);
}

the above code example is available pre‐packaged as the explain_socketpair_or_die(3) function. 🎀

---

🧚 explain_message_socketpair

void explain_message_socketpair(char *message, int message_size, int
domain, int type, int protocol, int *sv);

the explain_message_socketpair function is used to obtain an explanation of an error returned by the socketpair(2) system call. the least the message will contain is the value of strerror(errno), but usually it will do much better, and indicate the underlying cause in more detail. it's giving "tell me everything, no gatekeeping". 💅

the errno global variable will be used to obtain the error value to be decoded.

• message — the location in which to store the returned message. if a suitable message return buffer is supplied, this function is thread safe. (slay, we love a safe queen. 👑)
• message_size — the size in bytes of the location in which to store the returned message.
• domain — the original domain, exactly as passed to the socketpair(2) system call.
• type — the original type, exactly as passed to the socketpair(2) system call.
• protocol — the original protocol, exactly as passed to the socketpair(2) system call.
• sv — the original sv, exactly as passed to the socketpair(2) system call.

Example: this function is intended to be used in a fashion similar to the following example:

if (socketpair(domain, type, protocol, sv) < 0)
{
    char message[3000];
    explain_message_socketpair(message, sizeof(message), domain,
    type, protocol, sv);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

the above code example is available pre‐packaged as the explain_socketpair_or_die(3) function. 🌸

---

⭐ explain_message_errno_socketpair

void explain_message_errno_socketpair(char *message, int message_size,
int errnum, int domain, int type, int protocol, int *sv);

the explain_message_errno_socketpair function is used to obtain an explanation of an error returned by the socketpair(2) system call. the least the message will contain is the value of strerror(errno), but usually it will do much better, and indicate the underlying cause in more detail. main character function energy fr fr. 🔥

• message — the location in which to store the returned message. if a suitable message return buffer is supplied, this function is thread safe.
• message_size — the size in bytes of the location in which to store the returned message.
• errnum — the error value to be decoded, usually obtained from the errno global variable just before this function is called. this is necessary if you need to call any code between the system call to be explained and this function, because many libc functions will alter the value of errno. 😤
• domain — the original domain, exactly as passed to the socketpair(2) system call.
• type — the original type, exactly as passed to the socketpair(2) system call.
• protocol — the original protocol, exactly as passed to the socketpair(2) system call.
• sv — the original sv, exactly as passed to the socketpair(2) system call.

Example: this function is intended to be used in a fashion similar to the following example:

if (socketpair(domain, type, protocol, sv) < 0)
{
    int err = errno;
    char message[3000];
    explain_message_errno_socketpair(message, sizeof(message),
    err, domain, type, protocol, sv);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

the above code example is available pre‐packaged as the explain_socketpair_or_die(3) function. 💖

---

👀 SEE ALSO 👀

• socketpair(2) — create a pair of connected sockets
• explain_socketpair_or_die(3) — create a pair of connected sockets and report errors

like bestie, read those too. iykyk. 🦋

---

📜 COPYRIGHT 📜

libexplain version 1.4 Copyright (C) 2010 Peter Miller

---

and that's the whole page, bestie!! 💜 huge shoutout to libexplain version 1.4 and to Copyright (C) 2010 Peter Miller for making this possible — go off, legends, we're obsessed. and yes, the page title at the bottom is literally just explain_socketpair(3) again, bc she said "i'm my own footer, periodt." 💅✨🎀