Split config.h into external and internal parts

The external config.h header defined functions and structures that are
intended to be used by modules. The internal header contains functions
that are used only by the MaxScale core.
This commit is contained in:
Markus Mäkelä
2017-01-16 11:02:34 +02:00
parent 74c55e5c82
commit d054bc9b04
10 changed files with 157 additions and 93 deletions

View File

@ -113,21 +113,12 @@ typedef struct
char* qc_args; /**< Arguments for the query classifier */
} GATEWAY_CONF;
/**
* @brief Creates an empty configuration context
* @brief Get global MaxScale configuration
*
* @param section Context name
* @return New context or NULL on memory allocation failure
* @return The global configuration
*/
CONFIG_CONTEXT* config_context_create(const char *section);
/**
* @brief Free a configuration context
*
* @param context The context to free
*/
void config_context_free(CONFIG_CONTEXT *context);
GATEWAY_CONF* config_get_global_options();
/**
* @brief Get a configuration parameter
@ -138,39 +129,6 @@ void config_context_free(CONFIG_CONTEXT *context);
*/
CONFIG_PARAMETER* config_get_param(CONFIG_PARAMETER* params, const char* name);
/**
* @brief Add a parameter to a configuration context
*
* @param obj Context where the parameter should be added
* @param key Key to add
* @param value Value for the key
* @return True on success, false on memory allocation error
*/
bool config_add_param(CONFIG_CONTEXT* obj, const char* key, const char* value);
/**
* @brief Append to an existing parameter
*
* @param obj Configuration context
* @param key Parameter name
* @param value Value to append to the parameter
* @return True on success, false on memory allocation error
*/
bool config_append_param(CONFIG_CONTEXT* obj, const char* key, const char* value);
/**
* @brief Check if all SSL parameters are defined
*
* Helper function to check whether all of the required SSL parameters are defined
* in the configuration context. The checked parameters are 'ssl', 'ssl_key',
* 'ssl_cert' and 'ssl_ca_cert'. The 'ssl' parameter must also have a value of
* 'required'.
*
* @param obj Configuration context
* @return True if all required parameters are present
*/
bool config_have_required_ssl_params(CONFIG_CONTEXT *obj);
/**
* @brief Helper function for checking SSL parameters
*
@ -179,20 +137,6 @@ bool config_have_required_ssl_params(CONFIG_CONTEXT *obj);
*/
bool config_is_ssl_parameter(const char *key);
/**
* @brief Construct an SSL structure
*
* The SSL structure is used by both listeners and servers.
*
* TODO: Rename to something like @c config_construct_ssl
*
* @param obj Configuration context
* @param require_cert Whether certificates are required
* @param error_count Pointer to an int which is incremented for each error
* @return New SSL_LISTENER structure or NULL on error
*/
SSL_LISTENER *make_ssl_structure(CONFIG_CONTEXT *obj, bool require_cert, int *error_count);
/**
* @brief Check if a configuration parameter is valid
*
@ -326,33 +270,46 @@ char* config_copy_string(const CONFIG_PARAMETER *params, const char *key);
*/
int config_truth_value(const char *value);
/** TODO: Add new capability that allows skipping of permission checks */
bool is_internal_service(const char *router);
/***************************************************************************************
* TODO: Move the following functions to a header that's internal to the MaxScale core *
***************************************************************************************/
/**
* @brief Get worker thread count
*
* @return Number of worker theads
*/
int config_threadcount(void);
/**
* @brief Generate default module parameters
* @brief Get number of non-blocking polls
*
* Adds any default parameters to @c ctx that aren't already in it.
*
* @param ctx Configuration context where the parameters are added
* @param params Module parameters
* @return Number of non-blocking polls
*/
void config_add_defaults(CONFIG_CONTEXT *ctx, const MXS_MODULE_PARAM *params);
unsigned int config_nbpolls(void);
char* config_clean_string_list(const char* str);
CONFIG_PARAMETER* config_clone_param(const CONFIG_PARAMETER* param);
void config_enable_feedback_task(void);
void config_disable_feedback_task(void);
GATEWAY_CONF* config_get_global_options();
bool config_load(const char *);
unsigned int config_nbpolls();
unsigned int config_pollsleep();
bool config_reload();
int config_threadcount();
void config_parameter_free(CONFIG_PARAMETER* p1);
/**
* @brief Get poll sleep interval
*
* @return The time each thread waits for a blocking poll
*/
unsigned int config_pollsleep(void);
/**
* @brief Enable feedback task
*/
void config_enable_feedback_task(void);
/**
* @brief Disable feedback task
*/
void config_disable_feedback_task(void);
/** TODO: Add new capability that allows skipping of permission checks */
bool is_internal_service(const char *router);
/**
* @brief Reload the configuration
*
* @return True if reloading was successful
*/
bool config_reload(void);
MXS_END_DECLS