MySQL 8.4.2
Source Code Documentation
Rpl_async_conn_failover_reset Class Reference

#include <rpl_async_conn_failover_reset_udf.h>

Inheritance diagram for Rpl_async_conn_failover_reset:
[legend]

Public Member Functions

 Rpl_async_conn_failover_reset ()=default
 
 ~Rpl_async_conn_failover_reset () override=default
 
bool init () override
 Initialize variables, acquires the mysql_service_mysql_udf_metadata from the registry service and register the Asynchronous Connection Failover's reset UDFs. More...
 
bool deinit ()
 Release the udf_metadata service. More...
 
- Public Member Functions inherited from Udf_service_impl
 Udf_service_impl ()=default
 
virtual ~Udf_service_impl ()=default
 
bool deinit ()
 Release the mysql_service_mysql_udf_metadata service and unregisters the Asynchronous Connection Failover's UDFs. More...
 
void set_registry (const mysql_service_registry_t *r)
 Save UDF registry service. More...
 
bool register_udf (Udf_data &e)
 Registers the Asynchronous Connection Failover's UDFs. More...
 
bool unregister_udf (const std::string udf_name)
 Unregisters the Asynchronous Connection Failover's UDFs. More...
 

Static Public Member Functions

static char * reset (UDF_INIT *init_id, UDF_ARGS *args, char *result, unsigned long *length, unsigned char *is_null, unsigned char *error)
 Resets asynchronous connection failover configuration. More...
 
static bool reset_init (UDF_INIT *init_id, UDF_ARGS *args, char *message)
 Initialize and verifies UDF's arguments. More...
 
static void reset_deinit (UDF_INIT *init_id)
 Deinitialize variables initialized during init function. More...
 

Private Attributes

Udf_charset_service m_charset_service
 
bool m_initialized {false}
 

Static Private Attributes

static constexpr const char * m_udf_name
 

Constructor & Destructor Documentation

◆ Rpl_async_conn_failover_reset()

Rpl_async_conn_failover_reset::Rpl_async_conn_failover_reset ( )
default

◆ ~Rpl_async_conn_failover_reset()

Rpl_async_conn_failover_reset::~Rpl_async_conn_failover_reset ( )
overridedefault

Member Function Documentation

◆ deinit()

bool Rpl_async_conn_failover_reset::deinit ( )

Release the udf_metadata service.

Return values
falseSuccess
trueFailure. service could not be released

◆ init()

bool Rpl_async_conn_failover_reset::init ( )
overridevirtual

Initialize variables, acquires the mysql_service_mysql_udf_metadata from the registry service and register the Asynchronous Connection Failover's reset UDFs.

If there is an error registering any UDF, all installed UDFs are unregistered.

Return values
trueif there was an error
falseif all UDFs were registered

Implements Udf_service_impl.

◆ reset()

char * Rpl_async_conn_failover_reset::reset ( UDF_INIT init_id,
UDF_ARGS args,
char *  result,
unsigned long *  length,
unsigned char *  is_null,
unsigned char *  error 
)
static

Resets asynchronous connection failover configuration.

Parameters
[in]init_idUDF_INIT structure
[in]argsUDF_ARGS structure containing argument details
[out]resulterror message
[out]lengtherror message length
[out]is_nullif result is null
[in,out]errorerror code
Returns
error message

◆ reset_deinit()

void Rpl_async_conn_failover_reset::reset_deinit ( UDF_INIT init_id)
static

Deinitialize variables initialized during init function.

Parameters
[in]init_idUDF_INIT structure

◆ reset_init()

bool Rpl_async_conn_failover_reset::reset_init ( UDF_INIT init_id,
UDF_ARGS args,
char *  message 
)
static

Initialize and verifies UDF's arguments.

Also sets argument and result charset.

Parameters
[in]init_idUDF_INIT structure
[in]argsUDF_ARGS structure containing argument details
[out]messageerror message
Returns
True if error, false otherwise.

Member Data Documentation

◆ m_charset_service

Udf_charset_service Rpl_async_conn_failover_reset::m_charset_service
private

◆ m_initialized

bool Rpl_async_conn_failover_reset::m_initialized {false}
private

◆ m_udf_name

constexpr const char* Rpl_async_conn_failover_reset::m_udf_name
staticconstexprprivate
Initial value:
=
"asynchronous_connection_failover_reset"

The documentation for this class was generated from the following files: