Types found in this namespace comprise module ALib System. This module collects types and functions that are interfacing with the operating system, hardware drivers etc.

Note: As of today, the term "collects" unfortunately expresses very well that this module and namespace is not developed with a plan and road map. Instead, types are added when other modules / software need them. While this hopefully changes in the future, it has to be stated that the functionality found in this module is rather limited.

Classes
class	CalendarDate

class	CalendarDateTime

class	CalendarDuration

class	Console

class	Directory

struct	EnvironmentVariables

class	ProcessInfo

class	System

Enumerations
enum	Exceptions { OK }

enum	SystemErrors { UNKNOWN = -1, OK = 0, None = 0, eperm = EPERM, enoent = ENOENT, esrch = ESRCH, eintr = EINTR, eio = EIO, enxio = ENXIO, e2Big = E2BIG, enoexec = ENOEXEC, ebadf = EBADF, echild = ECHILD, eagain = EAGAIN, enomem = ENOMEM, eacces = EACCES, efault = EFAULT, ebusy = EBUSY, eexist = EEXIST, exdev = EXDEV, enodev = ENODEV, enotdir = ENOTDIR, eisdir = EISDIR, enfile = ENFILE, emfile = EMFILE, enotty = ENOTTY, efbig = EFBIG, enospc = ENOSPC, espipe = ESPIPE, erofs = EROFS, emlink = EMLINK, epipe = EPIPE, edom = EDOM, edeadlk = EDEADLK, enametoolong = ENAMETOOLONG, enolck = ENOLCK, enosys = ENOSYS, enotempty = ENOTEMPTY, einval = EINVAL, erange = ERANGE, eilseq = EILSEQ, struncate = STRUNCATE, eaddrinuse = EADDRINUSE, eaddrnotavail = EADDRNOTAVAIL, eafnosupport = EAFNOSUPPORT, ealready = EALREADY, ebadmsg = EBADMSG, ecanceled = ECANCELED, econnaborted = ECONNABORTED, econnrefused = ECONNREFUSED, econnreset = ECONNRESET, edestaddrreq = EDESTADDRREQ, ehostunreach = EHOSTUNREACH, eidrm = EIDRM, einprogress = EINPROGRESS, eisconn = EISCONN, eloop = ELOOP, emsgsize = EMSGSIZE, enetdown = ENETDOWN, enetreset = ENETRESET, enetunreach = ENETUNREACH, enobufs = ENOBUFS, enodata = ENODATA, enolink = ENOLINK, enomsg = ENOMSG, enoprotoopt = ENOPROTOOPT, enosr = ENOSR, enostr = ENOSTR, enotconn = ENOTCONN, enotrecoverable = ENOTRECOVERABLE, enotsock = ENOTSOCK, enotsup = ENOTSUP, eopnotsupp = EOPNOTSUPP, eother = 131, eoverflow = EOVERFLOW, eownerdead = EOWNERDEAD, eproto = EPROTO, eprotonosupport = EPROTONOSUPPORT, eprototype = EPROTOTYPE, etime = ETIME, etimedout = ETIMEDOUT, etxtbsy = ETXTBSY, ewouldblock = EWOULDBLOCK }

Functions
Exception	CreateSystemException (const NCString &file, int line, const NCString &func, int errNo)

ALIB_API void	FFormat_DateTime (const Box &self, const String &formatSpec, AString &target)

Enumeration Type Documentation

◆ Exceptions

enum Exceptions

strong

Denotes exceptions thrown by classes of namespace aworx::lib::system.

Enumerator
OK	Everything is fine.

Definition at line 281 of file systemerrors.hpp.

◆ SystemErrors

enum SystemErrors

strong

Denotes result values returned by system functions (glibc, etc).

Enumerator
UNKNOWN	Unknown Error.
OK	No Error.
None	No Error (alias for OK)
eperm	1
enoent	2
esrch	3
eintr	4
eio	5
enxio	6
e2Big	7
enoexec	8
ebadf	9
echild	10
eagain	11
enomem	12
eacces	13
efault	14
ebusy	16
eexist	17
exdev	18
enodev	19
enotdir	20
eisdir	21
enfile	23
emfile	24
enotty	25
efbig	27
enospc	28
espipe	29
erofs	30
emlink	31
epipe	32
edom	33
edeadlk	36
enametoolong	38
enolck	39
enosys	40
enotempty	41
einval	22
erange	34
eilseq	42
struncate	80
eaddrinuse	100
eaddrnotavail	101
eafnosupport	102
ealready	103
ebadmsg	104
ecanceled	105
econnaborted	106
econnrefused	107
econnreset	108
edestaddrreq	109
ehostunreach	110
eidrm	111
einprogress	112
eisconn	113
eloop	114
emsgsize	115
enetdown	116
enetreset	117
enetunreach	118
enobufs	119
enodata	120
enolink	121
enomsg	122
enoprotoopt	123
enosr	124
enostr	125
enotconn	126
enotrecoverable	127
enotsock	128
enotsup	129
eopnotsupp	130
eother	131
eoverflow	132
eownerdead	133
eproto	134
eprotonosupport	135
eprototype	136
etime	137
etimedout	138
etxtbsy	139
ewouldblock	140

Definition at line 28 of file systemerrors.hpp.

Function Documentation

◆ CreateSystemException()

ALIB_API Exception CreateSystemException	(	const NCString &	file,
		int	line,
		const NCString &	func,
		int	errNo
	)

Namespace function that creates an according Exception to a corresponding system error number.

The small challenge here is that arbitrary error numbers (of unknown) type might occur, that do not have a corresponding enum record. SystemErrors::UNKNOWN is thrown and only the number is displayed in the description text.

Parameters

file	File name of the place of exception creation.
line	Line number of the place of exception creation.
func	Function/method name of the place of exception creation.
errNo	The system's error number.

Returns: An exception object.

Definition at line 447 of file system.cpp.

Here is the call graph for this function:

◆ FFormat_DateTime()

ALIB_API void aworx::lib::system::FFormat_DateTime	(	const Box &	self,
		const String &	formatSpec,
		AString &	target
	)

Implementation of FFormat for boxable type DateTime.
Writes the content of box (which is of type DateTime) to the given AString object target using a local instance of class CalendarDateTime and its method CalendarDateTime::Format.

If parameter formatSpec is empty, a default format string defined by string resource of key "DFMT" is used.

Note: This interface implementation is only available if modules ALib System and ALib Time are included in the library distribution.