errno.hxx File Reference

#include <iosfwd>
#include <errno.h>
#include <cosmos/dso_export.h>

Go to the source code of this file.

Enumerations
enum class	cosmos::Errno : int {   NO_ERROR = 0 , TOOBIG = E2BIG , ACCESS = EACCES , ADDRESS_IN_USE = EADDRINUSE ,   ADDRESS_NOT_AVAILABLE = EADDRNOTAVAIL , AF_NOT_SUPPORTED = EAFNOSUPPORT , AGAIN = EAGAIN , ALREADY = EALREADY ,   BAD_FD = EBADF , BAD_MSG = EBADMSG , BUSY = EBUSY , CANCELED = ECANCELED ,   NO_CHILD = ECHILD , CONN_ABORTED = ECONNABORTED , CONN_REFUSED = ECONNREFUSED , CONN_RESET = ECONNRESET ,   DEADLOCK = EDEADLK , DEST_ADDR_REQ = EDESTADDRREQ , OUT_OF_DOMAIN = EDOM , EXISTS = EEXIST ,   FAULT = EFAULT , FILE_TOO_BIG = EFBIG , HOST_UNREACHABLE = EHOSTUNREACH , ID_REMOVED = EIDRM ,   ILLEGAL_SEQ = EILSEQ , IN_PROGRESS = EINPROGRESS , INTERRUPTED = EINTR , INVALID_ARG = EINVAL ,   IO_ERROR = EIO , IS_CONNECTED = EISCONN , IS_DIRECTORY = EISDIR , LINK_LOOP = ELOOP ,   TOO_MANY_FILES = EMFILE , TOO_MANY_LINKS = EMLINK , MSG_TOO_LARGE = EMSGSIZE , NAME_TOO_LONG = ENAMETOOLONG ,   NETWORK_DOWN = ENETDOWN , NETWORK_RESET = ENETRESET , NETWORK_UNREACHABLE = ENETUNREACH , TOO_MANY_FILES_IN_SYS = ENFILE ,   NO_BUFFER_SPACE = ENOBUFS , NO_DATA = ENODATA , NO_DEVICE = ENODEV , NO_ENTRY = ENOENT ,   NOT_EXECUTABLE = ENOEXEC , NO_LOCKS = ENOLCK , NO_MEMORY = ENOMEM , NO_MESSAGE = ENOMSG ,   NO_PROTO_OPT = ENOPROTOOPT , NO_SPACE = ENOSPC , NO_STREAM_RESOURCES = ENOSR , NO_STREAM = ENOSTR ,   NO_SYS = ENOSYS , NOT_CONNECTED = ENOTCONN , NOT_A_DIR = ENOTDIR , NOT_EMPTY = ENOTEMPTY ,   NOT_RECOVERABLE = ENOTRECOVERABLE , NOT_A_SOCKET = ENOTSOCK , NOT_SUPPORTED = ENOTSUP , OP_NOT_SUPPORTED = EOPNOTSUPP ,   NOT_A_TTY = ENOTTY , NXIO = ENXIO , OVERFLOW = EOVERFLOW , OWNER_DEAD = EOWNERDEAD ,   PERMISSION = EPERM , BROKEN_PIPE = EPIPE , PROTO_ERR = EPROTO , PROTO_NOT_SUPPORTED = EPROTONOSUPPORT ,   PROTO_MISMATCH = EPROTOTYPE , RANGE = ERANGE , READ_ONLY_FS = EROFS , IS_PIPE = ESPIPE ,   SEARCH = ESRCH , TIMER = ETIME , TIMEDOUT = ETIMEDOUT , WOULD_BLOCK = EWOULDBLOCK ,   TEXT_FILE_BUSY = ETXTBSY , CROSS_DEVICE = EXDEV }
	Strong enum type representing errno error constants. More...

Functions
Errno	cosmos::get_errno ()
	Wrapper that returns the Errno strongly typed representation of the current errno
void	cosmos::reset_errno ()
	Resets the currently set errno to indicate no error.
void	cosmos::set_errno (const Errno err)
	Explicitly set a new errno value.
bool	cosmos::is_errno_set ()
	Checks whether currently an errno is set.
COSMOS_API std::ostream &	operator<< (std::ostream &o, const cosmos::Errno err)

Detailed Description

This header contains strongly typed wrappers and helper functions around the global errno.

Definition in file errno.hxx.

Enumeration Type Documentation

Errno

enum class cosmos::Errno : int

strong

Strong enum type representing errno error constants.

Enumerator
TOOBIG	argument list too long
ACCESS	permission denied
ADDRESS_IN_USE	network address already in use
AF_NOT_SUPPORTED	address family not supported (networking)
AGAIN	resource unavailable, try again (e.g. non-blocking I/O)
ALREADY	connection already in progress
BAD_FD	bad file descriptor encountered
BUSY	device or resource busy
CANCELED	operation has been canceled
NO_CHILD	no child process
CONN_ABORTED	connection was aborted
CONN_REFUSED	connection was refused (e.g. no one listening on port)
CONN_RESET	connection was reset
DEADLOCK	resource deadlock would occur
DEST_ADDR_REQ	destination address required
OUT_OF_DOMAIN	mathematics argument out of domain of function
EXISTS	file (already) exists
FAULT	bad address (provided)
FILE_TOO_BIG	file too large
HOST_UNREACHABLE	host is unreachable
ID_REMOVED	identifier was removed
ILLEGAL_SEQ	illegal byte sequence
IN_PROGRESS	operation is in progress (but not yet completed)
INTERRUPTED	interrupted function (system call)
INVALID_ARG	invalid argument encountered
IS_CONNECTED	socket is (already?) connected
IS_DIRECTORY	file is a directory (unexpectedly)
LINK_LOOP	too many levels of symlinks
TOO_MANY_FILES	per-process limit of file descriptors encountered
TOO_MANY_LINKS	too many links encountered (e.g. file system limit)
NAME_TOO_LONG	filename too long
NETWORK_DOWN	network is down (e.g. route lost)
NETWORK_RESET	connection aborted by network
NETWORK_UNREACHABLE	network is unreachable (no route to host)
TOO_MANY_FILES_IN_SYS	too many files open system wide
NO_BUFFER_SPACE	no buffer space available
NO_DATA	no message available
NO_DEVICE	no such device (e.g. device node for non-existing device)
NO_ENTRY	no such file or directory (or otherwise an object was not found)
NOT_EXECUTABLE	executable file format error
NO_LOCKS	no locks available
NO_MEMORY	not enough (kernel) memory available for operation
NO_MESSAGE	no message of the desired type
NO_PROTO_OPT	protocol (option) not available
NO_SPACE	no space left on device
NO_STREAM_RESOURCES	no stream resources
NO_STREAM	not a STREAM
NO_SYS	function not available (e.g. unimplemented system call)
NOT_CONNECTED	socket is not connected
NOT_A_DIR	not a directory, or a symlink link to a directory
NOT_EMPTY	directory not empty
NOT_RECOVERABLE	state not recoverable
NOT_SUPPORTED	not supported
OP_NOT_SUPPORTED	operation not supported on socket
NOT_A_TTY	not a terminal, or unsupported ioctl
NXIO	no such device or address
OVERFLOW	value too large to be stored in data type
OWNER_DEAD	previous owner died
PERMISSION	operation not permitted
PROTO_MISMATCH	wrong protocol type for socket
RANGE	result too large
IS_PIPE	device does not support seek (e.g. a pipe)
SEARCH	no such process
TIMER	time expired
TIMEDOUT	connection timed out
WOULD_BLOCK	operation would block
CROSS_DEVICE	cross-device link

Definition at line 29 of file errno.hxx.

                 : int { // errnos are distinct positive `int` values says `man errno.h`
        NO_ERROR              = 0,
        TOOBIG                = E2BIG,           
        ACCESS                = EACCES,          
        ADDRESS_IN_USE        = EADDRINUSE,      
        ADDRESS_NOT_AVAILABLE = EADDRNOTAVAIL,
        AF_NOT_SUPPORTED      = EAFNOSUPPORT,    
        AGAIN                 = EAGAIN,          
        ALREADY               = EALREADY,        
        BAD_FD                = EBADF,           
        BAD_MSG               = EBADMSG,
        BUSY                  = EBUSY,           
        CANCELED              = ECANCELED,       
        NO_CHILD              = ECHILD,          
        CONN_ABORTED          = ECONNABORTED,    
        CONN_REFUSED          = ECONNREFUSED,    
        CONN_RESET            = ECONNRESET,      
        DEADLOCK              = EDEADLK,         
        DEST_ADDR_REQ         = EDESTADDRREQ,    
        OUT_OF_DOMAIN         = EDOM,            
        EXISTS                = EEXIST,          
        FAULT                 = EFAULT,          
        FILE_TOO_BIG          = EFBIG,           
        HOST_UNREACHABLE      = EHOSTUNREACH,    
        ID_REMOVED            = EIDRM,           
        ILLEGAL_SEQ           = EILSEQ,          
        IN_PROGRESS           = EINPROGRESS,     
        INTERRUPTED           = EINTR,           
        INVALID_ARG           = EINVAL,          
        IO_ERROR              = EIO,
        IS_CONNECTED          = EISCONN,         
        IS_DIRECTORY          = EISDIR,          
        LINK_LOOP             = ELOOP,           
        TOO_MANY_FILES        = EMFILE,          
        TOO_MANY_LINKS        = EMLINK,          
        MSG_TOO_LARGE         = EMSGSIZE,
        NAME_TOO_LONG         = ENAMETOOLONG,    
        NETWORK_DOWN          = ENETDOWN,        
        NETWORK_RESET         = ENETRESET,       
        NETWORK_UNREACHABLE   = ENETUNREACH,     
        TOO_MANY_FILES_IN_SYS = ENFILE,          
        NO_BUFFER_SPACE       = ENOBUFS,         
        NO_DATA               = ENODATA,         
        NO_DEVICE             = ENODEV,          
        NO_ENTRY              = ENOENT,          
        NOT_EXECUTABLE        = ENOEXEC,         
        NO_LOCKS              = ENOLCK,          
        NO_MEMORY             = ENOMEM,          
        NO_MESSAGE            = ENOMSG,          
        NO_PROTO_OPT          = ENOPROTOOPT,     
        NO_SPACE              = ENOSPC,          
        NO_STREAM_RESOURCES   = ENOSR,           
        NO_STREAM             = ENOSTR,          
        NO_SYS                = ENOSYS,          
        NOT_CONNECTED         = ENOTCONN,        
        NOT_A_DIR             = ENOTDIR,         
        NOT_EMPTY             = ENOTEMPTY,       
        NOT_RECOVERABLE       = ENOTRECOVERABLE, 
        NOT_A_SOCKET          = ENOTSOCK,
        NOT_SUPPORTED         = ENOTSUP,         
        OP_NOT_SUPPORTED      = EOPNOTSUPP,      
        NOT_A_TTY             = ENOTTY,          
        NXIO                  = ENXIO,           
        OVERFLOW              = EOVERFLOW,       
        OWNER_DEAD            = EOWNERDEAD,      
        PERMISSION            = EPERM,           
        BROKEN_PIPE           = EPIPE,
        PROTO_ERR             = EPROTO,
        PROTO_NOT_SUPPORTED   = EPROTONOSUPPORT,
        PROTO_MISMATCH        = EPROTOTYPE,      
        RANGE                 = ERANGE,          
        READ_ONLY_FS          = EROFS,
        IS_PIPE               = ESPIPE,          
        SEARCH                = ESRCH,           
        TIMER                 = ETIME,           
        TIMEDOUT              = ETIMEDOUT,       
        WOULD_BLOCK           = EWOULDBLOCK,     
        TEXT_FILE_BUSY        = ETXTBSY,
        CROSS_DEVICE          = EXDEV            
};

Function Documentation

get_errno()

Errno cosmos::get_errno ( )

inline

Wrapper that returns the Errno strongly typed representation of the current errno

Definition at line 111 of file errno.hxx.

{ return Errno{errno}; }

is_errno_set()

bool cosmos::is_errno_set ( )

inline

Checks whether currently an errno is set.

Definition at line 117 of file errno.hxx.

{ return get_errno() != Errno::NO_ERROR; }

operator<<()

COSMOS_API std::ostream & operator<<	(	std::ostream &	o,
		const cosmos::Errno	err )

Definition at line 9 of file errno.cxx.

                                                             {
        o << cosmos::ApiError::msg(err) << " (" << cosmos::to_integral(err) << ")";
        return o;
}

reset_errno()

void cosmos::reset_errno ( )

inline

Resets the currently set errno to indicate no error.

Definition at line 113 of file errno.hxx.

{ errno = static_cast<int>(Errno::NO_ERROR); }

set_errno()

void cosmos::set_errno ( const Errno err )

inline

Explicitly set a new errno value.

Definition at line 115 of file errno.hxx.

{ errno = static_cast<int>(err); }