s_mysql_mysql_option_tracker_option Struct Reference

Option tracker registration and deregistration services. More...

#include <mysql_option_tracker.h>

Public Attributes
mysql_service_status_t(*	define )(const char *option, const char *container, int is_enabled)
	Define an option. More...
mysql_service_status_t(*	undefine )(const char *option)
	Undefine an option. More...
mysql_service_status_t(*	set_enabled )(const char *option, int is_enabled)
	Set enabled for an existing element. More...

Detailed Description

Option tracker registration and deregistration services.

This is a service that will allow registering an option. Each option has a name. The name is UTF8mb4 and is unique in the list. Manipulating the option list is an "expesive" operation since there is a global lock involved.

Each code container (a component or a plugin) should register its options during its initialization and should unregister them during its deinitialization.

Member Data Documentation

define

mysql_service_status_t(* s_mysql_mysql_option_tracker_option::define) (const char *option, const char *container, int is_enabled)

Define an option.

Adds an option definition.

If another option of the same name exists, the definition fails

Parameters

option	The name of the option, UTF8mb4. Must be unique.
container	The container name. UTF8mb4 Please prefix with "plugin_" for plugins.
is_enabled	non-0 if the option is marked as enabled, 0 otherwise

Return values

false	success
true	failure

set_enabled

mysql_service_status_t(* s_mysql_mysql_option_tracker_option::set_enabled) (const char *option, int is_enabled)

Set enabled for an existing element.

if the option is not defined it fails

Parameters

option	The name of the option, US ASCII
is_enabled	non-0 if the option is marked as enabled, 0 otherwise

Return values

false	success
true	failure

undefine

mysql_service_status_t(* s_mysql_mysql_option_tracker_option::undefine) (const char *option)

Undefine an option.

Fails if no option is defined with the same name

Parameters

option

The name of the option, US ASCII

Return values

false	success
true	failure

---

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

• include/mysql/components/services/mysql_option_tracker.h