(2023-11-21, commit: e767693)

Header related to global option storage. More...

#include <stdbool.h>
#include <string.h>
#include "envset.h"

Include dependency graph for globopt.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	crinitGlobOptStore_t

Macros
#define	CRINIT_GLOBOPT_DEBUG debug
	DEBUG global option. More...

#define	CRINIT_GLOBOPT_USE_SYSLOG useSyslog
	USE_SYSLOG global option. More...

#define	CRINIT_GLOBOPT_USE_ELOS useElos
	USE_ELOS global option. More...

#define	CRINIT_GLOBOPT_ELOS_PORT elosPort
	ELOS_PORT global option. More...

#define	CRINIT_GLOBOPT_ELOS_SERVER elosServer
	ELOS_SERVER global option. More...

#define	CRINIT_GLOBOPT_INCLDIR inclDir
	INCLUDEDIR global option. More...

#define	CRINIT_GLOBOPT_INCL_SUFFIX inclSuffix
	INCLUDE_SUFFIX global option. More...

#define	CRINIT_GLOBOPT_SHDGRACEP shdGraceP
	SHUTDOWN_GRACE_PERIOD_US global option. More...

#define	CRINIT_GLOBOPT_ENV globEnv
	Reference to the global task environment. More...

#define	CRINIT_GLOBOPT_FILTERS globFilters
	Reference to the global task filters. More...

#define	crinitGlobOptGet(globOptMember, retPtr)

#define	crinitGlobOptSet(globOptMember, val)

Typedefs
typedef struct crinitGlobOptStore_t	crinitGlobOptStore_t

Functions
static crinitGlobOptStore_t crinitGenericGlobOptHelper	__attribute__ ((unused))

int	crinitGlobOptInitDefault (void)

void	crinitGlobOptDestroy (void)

crinitGlobOptStore_t *	crinitGlobOptBorrow (void)

int	crinitGlobOptRemit (void)

int	crinitGlobOptSetString (size_t memberOffset, const char *val)

int	crinitGlobOptSetBoolean (size_t memberOffset, bool val)

int	crinitGlobOptSetInteger (size_t memberOffset, int val)

int	crinitGlobOptSetUnsignedLL (size_t memberOffset, unsigned long long val)

int	crinitGlobOptSetEnvSet (size_t memberOffset, const crinitEnvSet_t *val)

int	crinitGlobOptGetString (size_t memberOffset, char **val)

int	crinitGlobOptGetBoolean (size_t memberOffset, bool *val)

int	crinitGlobOptGetInteger (size_t memberOffset, int *val)

int	crinitGlobOptGetUnsignedLL (size_t memberOffset, unsigned long long *val)

int	crinitGlobOptGetEnvSet (size_t memberOffset, crinitEnvSet_t *val)

Detailed Description

Header related to global option storage.

Macro Definition Documentation

◆ CRINIT_GLOBOPT_DEBUG

#define CRINIT_GLOBOPT_DEBUG debug

DEBUG global option.

◆ CRINIT_GLOBOPT_ELOS_PORT

#define CRINIT_GLOBOPT_ELOS_PORT elosPort

ELOS_PORT global option.

◆ CRINIT_GLOBOPT_ELOS_SERVER

#define CRINIT_GLOBOPT_ELOS_SERVER elosServer

ELOS_SERVER global option.

◆ CRINIT_GLOBOPT_ENV

#define CRINIT_GLOBOPT_ENV globEnv

Reference to the global task environment.

◆ CRINIT_GLOBOPT_FILTERS

#define CRINIT_GLOBOPT_FILTERS globFilters

Reference to the global task filters.

◆ CRINIT_GLOBOPT_INCL_SUFFIX

#define CRINIT_GLOBOPT_INCL_SUFFIX inclSuffix

INCLUDE_SUFFIX global option.

◆ CRINIT_GLOBOPT_INCLDIR

#define CRINIT_GLOBOPT_INCLDIR inclDir

INCLUDEDIR global option.

◆ CRINIT_GLOBOPT_SHDGRACEP

#define CRINIT_GLOBOPT_SHDGRACEP shdGraceP

SHUTDOWN_GRACE_PERIOD_US global option.

◆ CRINIT_GLOBOPT_USE_ELOS

#define CRINIT_GLOBOPT_USE_ELOS useElos

USE_ELOS global option.

◆ CRINIT_GLOBOPT_USE_SYSLOG

#define CRINIT_GLOBOPT_USE_SYSLOG useSyslog

USE_SYSLOG global option.

◆ crinitGlobOptGet

#define crinitGlobOptGet	(	globOptMember,
		retPtr
	)

Value:

    _Generic((crinitGenericGlobOptHelper.globOptMember), \
        char * : crinitGlobOptGetString, \
        bool : crinitGlobOptGetBoolean, \
        int : crinitGlobOptGetInteger, \
        unsigned long long : crinitGlobOptGetUnsignedLL, \
        crinitEnvSet_t : crinitGlobOptGetEnvSet) \
        ((offsetof(crinitGlobOptStore_t, globOptMember)), (retPtr))

Type-generic macro to get the value of a given global option.

Thread-safe as all mapped function are thread-safe.

Parameters

globOptMember	One of the member names of crinitGlobOptStore_t (or one of the CRINIT_GLOBOPT_* constants).
retPtr	Return pointer for value. Type depends on the chosen member of crinitGlobOptStore_t and is always `&(member_type)`. In case of `char *` (for a string) and `crinitEnvSet_t ` memory will be allocated.

Returns: 0 on success, -1 otherwise

◆ crinitGlobOptSet

#define crinitGlobOptSet	(	globOptMember,
		val
	)

Value:

    _Generic((crinitGenericGlobOptHelper.globOptMember), \
        char * : crinitGlobOptSetString, \
        const char * : crinitGlobOptSetString, \
        bool : crinitGlobOptSetBoolean, \
        int : crinitGlobOptSetInteger, \
        unsigned long long : crinitGlobOptSetUnsignedLL, \
        crinitEnvSet_t : crinitGlobOptSetEnvSet) \
        ((offsetof(crinitGlobOptStore_t, globOptMember)), (val))

Type-generic macro to get the value of a given global option.

Thread-safe as all mapped function are thread-safe.

Parameters

globOptMember	One of the member names of crinitGlobOptStore_t (or one of the CRINIT_GLOBOPT_* constants).
val	Value to store. Type depends on the chosen member of crinitGlobOptStore_t. See function signatures of crinitGlobOptGet*().

Returns: 0 on success, -1 otherwise

Typedef Documentation

◆ crinitGlobOptStore_t

typedef struct crinitGlobOptStore_t crinitGlobOptStore_t

Structure definition for the global option storage.

Function Documentation

◆ attribute()

static crinitGlobOptStore_t crinitGenericGlobOptHelper __attribute__ ( (unused) )

static

Dummy instance for Generic Selection of members to work (see type-generic macros below).

◆ crinitGlobOptBorrow()

crinitGlobOptStore_t* crinitGlobOptBorrow ( void )

Provide direct thread-safe access to the central global option storage.

Calling thread will hold an exclusive lock on the central instance of crinitGlobOptStore_t. After the calling thread has finished its operations on the global option storage, it must release the lock using crinitGlobOptRemit().

Returns: A pointer to the central instance of crinitGlobOptStore_t on success, a NULL pointer if the lock could not be acquired.

◆ crinitGlobOptDestroy()

void crinitGlobOptDestroy ( void )

Deletes all set global options from storage.

Any allocated memory is freed. The function uses mutexes internally and is thread-safe.

◆ crinitGlobOptGetBoolean()

int crinitGlobOptGetBoolean	(	size_t	memberOffset,
		bool *	val
	)

Retrieves a boolean value from a global option.

Consider using the type-generic macro crinitGlobOptGet() which can be used with member names instead of offsets. Will lock the global option storage as long as needed and is thread-safe.

Parameters

memberOffset	The global option to set.
val	Return pointer for the retrieved boolean value.

Returns: 0 on success, -1 on error

◆ crinitGlobOptGetEnvSet()

int crinitGlobOptGetEnvSet	(	size_t	memberOffset,
		crinitEnvSet_t *	val
	)

Retrieves a crinitEnvSet_t value from a global option.

Consider using the type-generic macro crinitGlobOptGet() which can be used with member names instead of offsets. Will lock the global option storage as long as needed and is thread-safe.

Parameters

memberOffset	The global option to set.
val	Pointer to the crinitEnvSet_t instance to which the global one will be duplicated.

Returns: 0 on success, -1 on error

◆ crinitGlobOptGetInteger()

int crinitGlobOptGetInteger	(	size_t	memberOffset,
		int *	val
	)

Retrieves an integer value from a global option.

Consider using the type-generic macro crinitGlobOptGet() which can be used with member names instead of offsets. Will lock the global option storage as long as needed and is thread-safe.

Parameters

memberOffset	The global option to set.
val	Return pointer for the retrieved integer value.

Returns: 0 on success, -1 on error

◆ crinitGlobOptGetString()

int crinitGlobOptGetString	(	size_t	memberOffset,
		char **	val
	)

Retrieves a string value from a global option.

Consider using the type-generic macro crinitGlobOptGet() which can be used with member names instead of offsets. Will lock the global option storage as long as needed and is thread-safe.

Will allocate memory for the returned string. When no longer in use, free() should be called on the returned pointer to free the memory.

Parameters

memberOffset	The offset of the member of the global option struct to set.
val	Return pointer for the retrieved string. Memory will be allocated.

Returns: 0 on success, -1 on error

◆ crinitGlobOptGetUnsignedLL()

int crinitGlobOptGetUnsignedLL	(	size_t	memberOffset,
		unsigned long long *	val
	)

Retrieves an unsigned long long value from a global option.

Consider using the type-generic macro crinitGlobOptGet() which can be used with member names instead of offsets. Will lock the global option storage as long as needed and is thread-safe.

Parameters

memberOffset	The global option to set.
val	Return pointer for the unsigned long long integer value.

Returns: 0 on success, -1 on error

◆ crinitGlobOptInitDefault()

int crinitGlobOptInitDefault ( void )

Sets global options to their default values.

Uses crinitGlobOptSet() and is therefore thread-safe.

Returns: 0 on success, -1 otherwise

◆ crinitGlobOptRemit()

int crinitGlobOptRemit ( void )

Release the lock on the global option storage acquired via crinitGlobOptBorrow().

Returns: 0 on success, -1 if the lock could not be released.

◆ crinitGlobOptSetBoolean()

int crinitGlobOptSetBoolean	(	size_t	memberOffset,
		bool	val
	)

Stores a boolean value for a global option.

Consider using the type-generic macro crinitGlobOptSet() which can be used with member names instead of offsets. Will lock the global option storage as long as needed and is thread-safe.

Parameters

memberOffset	The global option to set.
val	The boolean value to store.

Returns: 0 on success, -1 on error

◆ crinitGlobOptSetEnvSet()

int crinitGlobOptSetEnvSet	(	size_t	memberOffset,
		const crinitEnvSet_t *	val
	)

Stores a crinitEnvSet_t value for a global option.

Consider using the type-generic macro crinitGlobOptSet() which can be used with member names instead of offsets. Will lock the global option storage as long as needed and is thread-safe.

Parameters

memberOffset	The global option to set.
val	Pointer to the crinitEnvSet_t which shall be stored.

Returns: 0 on success, -1 on error

◆ crinitGlobOptSetInteger()

int crinitGlobOptSetInteger	(	size_t	memberOffset,
		int	val
	)

Stores an integer value for a global option.

Consider using the type-generic macro crinitGlobOptSet() which can be used with member names instead of offsets. Will lock the global option storage as long as needed and is thread-safe.

Parameters

memberOffset	The global option to set.
val	The boolean value to store.

Returns: 0 on success, -1 on error

◆ crinitGlobOptSetString()

int crinitGlobOptSetString	(	size_t	memberOffset,
		const char *	val
	)

Stores a string value for a global option.

Consider using the type-generic macro crinitGlobOptSet() which can be used with member names instead of offsets. Will lock the global option storage as long as needed and is thread-safe.

Parameters

memberOffset	The offset of the member of the global option struct to set.
val	The string value to store, must be null-terminated.

Returns: 0 on success, -1 on error

◆ crinitGlobOptSetUnsignedLL()

int crinitGlobOptSetUnsignedLL	(	size_t	memberOffset,
		unsigned long long	val
	)

Stores an unsigned long long value for a global option.

Consider using the type-generic macro crinitGlobOptSet() which can be used with member names instead of offsets. Will lock the global option storage as long as needed and is thread-safe.

Parameters

memberOffset	The global option to set.
val	The unsigned long long integer value to store.

Returns: 0 on success, -1 on error

(2023-11-21, commit: e767693)

Classes

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ CRINIT_GLOBOPT_DEBUG

◆ CRINIT_GLOBOPT_ELOS_PORT

◆ CRINIT_GLOBOPT_ELOS_SERVER

◆ CRINIT_GLOBOPT_ENV

◆ CRINIT_GLOBOPT_FILTERS

◆ CRINIT_GLOBOPT_INCL_SUFFIX

◆ CRINIT_GLOBOPT_INCLDIR

◆ CRINIT_GLOBOPT_SHDGRACEP

◆ CRINIT_GLOBOPT_USE_ELOS

◆ CRINIT_GLOBOPT_USE_SYSLOG

◆ crinitGlobOptGet

◆ crinitGlobOptSet

Typedef Documentation

◆ crinitGlobOptStore_t

Function Documentation

◆ __attribute__()

◆ crinitGlobOptBorrow()

◆ crinitGlobOptDestroy()

◆ crinitGlobOptGetBoolean()

◆ crinitGlobOptGetEnvSet()

◆ crinitGlobOptGetInteger()

◆ crinitGlobOptGetString()

◆ crinitGlobOptGetUnsignedLL()

◆ crinitGlobOptInitDefault()

◆ crinitGlobOptRemit()

◆ crinitGlobOptSetBoolean()

◆ crinitGlobOptSetEnvSet()

◆ crinitGlobOptSetInteger()

◆ crinitGlobOptSetString()

◆ crinitGlobOptSetUnsignedLL()

◆ attribute()