c-icap-doc  0.1
Data Fields
ci_conf_entry Struct Reference


This struct holds a configuration parameter of c-icap server. More...

#include <cfg_param.h>

Data Fields

const char * name
 The configuration directive.
 
void * data
 A pointer to the configuration data.
 
int(* action )(const char *name, const char **argv, void *setdata)
 
Pointer to the function which will be used to set configuration data. More...
 
const char * msg
 A description message.
 

Detailed Description


This struct holds a configuration parameter of c-icap server.

An array of ci_conf_entry structs can be used to define the configuration directives of a service or module which can be set in c-icap configuration file.

int AParam;
struct ci_conf_entry conf_table[] = {
{"Aparameter", &AParam, ci_cfg_set_int, "This is a simple configuration parameter"},
{NULL,NULL,NULL,NULL}
}

In the above example the ci_cfg_set_int function is predefined. If the table "conf_table" attached to the service "AService" then the AParam integer variable can be set from the c-icap configuration file using the directive "AService.Aparameter"

Field Documentation

◆ action

int(* ci_conf_entry::action) (const char *name, const char **argv, void *setdata)


Pointer to the function which will be used to set configuration data.

Parameters
nameis the configuration directive.It passed as argument by the c-icap server
argvis a NULL termined string array which holds the list of arguments of configuration parameter
setdatais o pointer to set data which passed as argument by c-icap server
Returns
Non zero on success, zero otherwise

The documentation for this struct was generated from the following file: