optfeat.h File Reference

(/usr/bin/git 2023-11-27, commit: f65bd36)

Header related to optional behavior dependent on available system features. More...

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

Go to the source code of this file.

Typedefs
typedef enum crinitHookType_t	crinitHookType_t

Enumerations
enum	crinitHookType_t {   CRINIT_HOOK_INIT , CRINIT_HOOK_EXIT , CRINIT_HOOK_START , CRINIT_HOOK_STOP ,   CRINIT_HOOK_TASK_ADDED }

Functions
int	crinitFeatureHook (const char *sysFeatName, crinitHookType_t type, void *data)

Detailed Description

Header related to optional behavior dependent on available system features.

Typedef Documentation

crinitHookType_t

typedef enum crinitHookType_t crinitHookType_t

Hook types.

Enumeration Type Documentation

crinitHookType_t

enum crinitHookType_t

Hook types.

Enumerator
CRINIT_HOOK_INIT	Initialization of the optional feature (eg. setup database).
CRINIT_HOOK_EXIT	Cleanup of the optional feature (remove temporary files).
CRINIT_HOOK_START	The optional feature is triggered by a specific event.
CRINIT_HOOK_STOP	The optional feature is removed due to another event happening.
CRINIT_HOOK_TASK_ADDED	Hook handles the addition of a new task.

Function Documentation

crinitFeatureHook()

int crinitFeatureHook	(	const char *	sysFeatName,
		crinitHookType_t	type,
		void *	data
	)

Hook to be called whenever a new feature is provided by a task.

Meant to be used to let Crinit change its own behavior whenever a relevant (optional or delayed) feature needed for some special functionality gets provided.

Currently only handles activation of syslog functionality if series config option USE_SYSLOG is true and a task provides syslog.

Parameters

sysFeatName	Name of the newly-provided feature.
type	Type of the invoked hook.
data	Hook payload.

Returns

0 on success, -1 otherwise