CAPS Universe documentation
1.0.4
All you need to know to be successful
|
Some shared functions used by some of the components here. More...
Functions | |
void | runtime_configuration_base_read_in (struct caps_inif_table *runtime_config) |
void | runtime_configuration_class_merge_in (struct caps_inif_table *runtime_config, enum caps_user_class clss) |
static void | runtime_configuration_package_merge_in (struct caps_inif_table *runtime_config, const char *package) |
void | runtime_configuration_apply_verbosity (const struct caps_inif_table *runtime_config) |
void | runtime_configuration_apply (struct caps_inif_table *runtime_config, enum caps_user_class clss, const char *package) |
Variables | |
static const char * | layer [] |
Collection of function shared by some of the components in this package
void runtime_configuration_base_read_in | ( | struct caps_inif_table * | runtime_config | ) |
Read-in the CAPS universe shared 'caps.ini' file for basic run-time configuration
[out] | runtime_config | The configuration table to fill |
Expects the file in CAPS Configuration Directory (e.g. '/etc/caps/caps.ini' for example)
runtime_config
must already be initialized and empty! void runtime_configuration_class_merge_in | ( | struct caps_inif_table * | runtime_config, |
enum caps_user_class | clss | ||
) |
Merge-in the shared service dependend INI file for basic run-time configuration
[out] | runtime_config | The configuration table to merge more content to |
[in] | clss | The class of the running program (used to identify the corresponding service dependend INI file) |
For clss
refer layer for the corresponding service INI file.
runtime_config
must already be initialized Currently the already collected configuration gets removed if it fails to merge the class INI content
The error message needs more details: Why/What/What now?
|
static |
Merge-in the package related INI file (if it exits)
[out] | runtime_config | |
[in] | package | name of the corresponding INI file (including the trailing '.ini') |
The INI file is expected in the main configuration directory (e.g. '/etc/caps' for example)
runtime_config
must already be initialized Currently the already collected configuration gets removed if it fails to merge the package's INI content
The error message needs more details: Why/What/What now?
void runtime_configuration_apply_verbosity | ( | const struct caps_inif_table * | runtime_config | ) |
Apply the verbosity setting if available
[out] | runtime_config | The configuration to check for the verbosity setting |
This function is intended to be used whenever a run-time config is available. It is intended to apply the requested setting as early as possible.
The verbosity setting is always expected at
The new value from the INI file is only applied if it is higher than before. Else it gets ignored to give the application a change to overwrite it locally.
void runtime_configuration_apply | ( | struct caps_inif_table * | runtime_config, |
enum caps_user_class | clss, | ||
const char * | package | ||
) |
Read in a fixed sequence of INI files as a base run-time configuration
[out] | runtime_config | |
[in] | clss | Application class (refer enum caps_user_class) |
[in] | package | Used for the program's INI file (can be NULL) |
This function is intended for the printing coordinator internal tools and printing providers via libcapsprovider (not clients).
runtime_config
must already be initialized
|
static |
Special shared service dependend INI files (service = class), used to overlay the shared 'caps.ini' (runtime_configuration_base_read_in()).
libcapsbase
component (Setup the CAPS Configuration Directory)