GENERAL

The OSAPI library base module. More...

Collaboration diagram for GENERAL:

Macros
#define	OSAPI_NULL_CHAR_POINTER   ( (char * ) 0 )
	Definition of a null char pointer.
#define	OSAPI_EMPTY_STRING   ""
	Definition of an empty string.
#define	OSAPI_SPACE_STRING   " "
	Definition of a white space string.
#define	OSAPI_OPTIONS_END   -999999
	A marker for end of array.

Typedefs
typedef uint64_t	t_size
	Definition of OSAPI size type.
typedef int64_t	t_offset
	Definition of OSAPI size type.
typedef uint8_t	Byte
	Definition of a Byte type.
typedef char	t_char
	Definition of own char type.
typedef int	t_protocol
	Definition of a protocol type.
typedef Byte	t_module
	Definition of the module type.
typedef struct general_optional_pair_S	t_option
	The definition of a generic pair type.

Functions
unsigned long	osapi_get_release (void)
	Get the release number of the Library. More...
unsigned long	osapi_get_version (void)
	Get the version number of the Library. More...
int	osapi_get_version_stability (void)
	Get the library stability type: Stable vs Unstable. More...
const char *	osapi_get_release_string (void)
	Get the release string of the Library. More...
const char *	osapi_get_version_string (void)
	Get the version string of the Library. More...
const char *	osapi_get_version_stability_string (void)
	Get the string describing the library stability type: Stable vs Unstable. More...
const char *	osapi_get_protocol_string (t_protocol id)
	Get the OSAPI Protocol name. More...
bool	osapi_verify_baseline (void)
	Compare library runtime baseline against requirements. More...
const char *	osapi_module_get (t_module module)
	Get the module string. More...
bool	osapi_endian_isLittle (void)
	Check if current endianess is little. More...
bool	osapi_endian_isBig (void)
	Check if current endianess is big. More...
void	osapi_trace (const char *func, const char *sep, uint64_t line, const char *fmt,...)
	Print a trace message to standard error. More...

Detailed Description

The OSAPI library base module.

---

Function Documentation

osapi_endian_isBig()

bool osapi_endian_isBig

(

void

)

Check if current endianess is big.

Returns

True if big endian, False otherwise

osapi_endian_isLittle()

bool osapi_endian_isLittle

(

void

)

Check if current endianess is little.

Returns

True if little endian, False otherwise

osapi_get_protocol_string()

const char* osapi_get_protocol_string

(

t_protocol

id

)

Get the OSAPI Protocol name.

Parameters

[in]

id

- The protocol ID

Returns

C String for the given Protocol ID

osapi_get_release()

unsigned long osapi_get_release

(

void

)

Get the release number of the Library.

Returns

Release number

osapi_get_release_string()

const char* osapi_get_release_string

(

void

)

Get the release string of the Library.

Returns

C String library release information

osapi_get_version()

unsigned long osapi_get_version

(

void

)

Get the version number of the Library.

Returns

Version number

osapi_get_version_stability()

int osapi_get_version_stability

(

void

)

Get the library stability type: Stable vs Unstable.

Returns

enum that describes the stability type

osapi_get_version_stability_string()

const char* osapi_get_version_stability_string

(

void

)

Get the string describing the library stability type: Stable vs Unstable.

Returns

C String library stability type

osapi_get_version_string()

const char* osapi_get_version_string

(

void

)

Get the version string of the Library.

Returns

C String library version

osapi_module_get()

const char* osapi_module_get

(

t_module

module

)

Get the module string.

Parameters

[in]

module

- The module ID

Returns

C String for the given module ID

Here is the caller graph for this function:

osapi_trace()

void osapi_trace	(	const char *	func,
		const char *	sep,
		uint64_t	line,
		const char *	fmt,
			...
	)

Print a trace message to standard error.

Parameters

[in]	func	- Function name
[in]	sep	- Separator string
[in]	line	- Code line number
[in]	fmt	- Message format specifier

osapi_verify_baseline()

bool osapi_verify_baseline

(

void

)

Compare library runtime baseline against requirements.

Returns

True if baseline meets requirements or False otherwise