libexplain  1.4.D001
Functions
libexplain/message/signalfd.c File Reference
#include <libexplain/ac/errno.h>
#include <libexplain/ac/signal.h>
#include <libexplain/signalfd.h>

Go to the source code of this file.

Functions

void explain_message_signalfd (char *message, int message_size, int fildes, const sigset_t *mask, int flags)

Function Documentation

void explain_message_signalfd ( char *  message,
int  message_size,
int  fildes,
const sigset_t *  mask,
int  flags 
)

The explain_message_signalfd function is used to obtain an explanation of an error returned by the signalfd(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.

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

Parameters:
messageThe location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
message_sizeThe size in bytes of the location in which to store the returned message.
fildesThe original fildes, exactly as passed to the signalfd(2) system call.
maskThe original mask, exactly as passed to the signalfd(2) system call.
flagsThe original flags, exactly as passed to the signalfd(2) system call.
Example:
This function is intended to be used in a fashion similar to the following example:
 int result = signalfd(fildes, mask, flags);
 if (result < 0)
 {
     char message[3000];
     explain_message_signalfd(message, sizeof(message), fildes, mask, flags);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }
The above code example is available pre-packaged as the explain_signalfd_or_die function.

Definition at line 26 of file signalfd.c.