libexplain/buffer/errno/socketpair.h File Reference

#include <libexplain/ac/sys/socket.h>
#include <libexplain/string_buffer.h>

Go to the source code of this file.

Functions
void	explain_buffer_errno_socketpair (explain_string_buffer_t *sb, int errnum, int domain, int type, int protocol, int *sv)
void	explain_buffer_errno_socketpair_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, int domain, int type, int protocol, int *sv)

---

Function Documentation

void explain_buffer_errno_socketpair	(	explain_string_buffer_t *	sb,
		int	errnum,
		int	domain,
		int	type,
		int	protocol,
		int *	sv
	)

The explain_buffer_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(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

Parameters:

sb	The string buffer to print the message into. If a suitable buffer is specified, this function is thread safe.
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.

Definition at line 79 of file socketpair.c.

void explain_buffer_errno_socketpair_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		int	domain,
		int	type,
		int	protocol,
		int *	sv
	)

The explain_buffer_errno_socketpair_explanation function is used to obtain the explanation (the part after "because") of an error returned by the socketpair(2) system call (and similar).

Parameters:

sb	The string buffer to print the message into. If a suitable buffer is specified, this function is thread safe.
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.
syscall_name	The name of the offending system call.
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.

Definition at line 49 of file socketpair.c.