MySQL  8.0.27
Source Code Documentation
Rpl_info_dummy Class Reference

Defines a dummy handler that should only be internally accessed. More...

#include <rpl_info_dummy.h>

Inheritance diagram for Rpl_info_dummy:
Rpl_info_handler

Public Member Functions

 Rpl_info_dummy (const int nparam)
 
 ~Rpl_info_dummy () override=default
 
- Public Member Functions inherited from Rpl_info_handler
 Rpl_info_handler (const Rpl_info_handler &handler)=delete
 
Rpl_info_handleroperator= (const Rpl_info_handler &handler)=delete
 
int init_info ()
 After creating an object and assembling components, this method is used to initialize internal structures. More...
 
enum_return_check check_info ()
 Checks the repository's status. More...
 
int flush_info (const bool force)
 Flushes and syncs in-memory information into a stable storage (i.e. More...
 
int remove_info ()
 Deletes any information in it and in some cases the repository. More...
 
int clean_info ()
 Deletes any information in the repository. More...
 
void end_info ()
 Closes access to the repository. More...
 
int prepare_info_for_read ()
 Enables the storage system to receive reads, i.e. More...
 
int prepare_info_for_write ()
 Enables the storage system to receive writes, i.e. More...
 
uint get_rpl_info_type ()
 Gets the type of the repository that is used. More...
 
const char * get_rpl_info_type_str ()
 Returns a string corresponding to the type. More...
 
template<class TypeHandler >
bool set_info (TypeHandler const value)
 Sets the value of a field to value. More...
 
template<class TypeHandler >
bool set_info (TypeHandler const value, const size_t size)
 
template<class TypeHandler >
bool set_info (int pk_cursor, TypeHandler const value)
 set the value of a field pointed at pk_cursor to @ value. More...
 
template<class TypeHandlerPointer , class TypeHandler >
enum_field_get_status get_info (TypeHandlerPointer value, TypeHandler const default_value)
 Returns the value of a field. More...
 
template<class TypeHandler >
enum_field_get_status get_info (TypeHandler value, const size_t size, std::add_const_t< std::remove_pointer_t< TypeHandler >> *default_value)
 Returns the value of a string field. More...
 
enum_field_get_status get_info (Server_ids *value, const Server_ids *default_value)
 Returns the value of a Server_id field. More...
 
int get_number_info ()
 Returns the number of fields handled by this handler. More...
 
void set_sync_period (uint period)
 Configures the number of events after which the info (e.g. More...
 
char * get_description_info ()
 Returns a string describing the repository. More...
 
bool is_transactional ()
 Any transactional repository may have its updates rolled back in case of a failure. More...
 
bool update_is_transactional ()
 Updates the value returned by the member function is_transactional() because it may be expensive to compute it whenever is_transactional() is called. More...
 
virtual ~Rpl_info_handler ()
 

Private Member Functions

int do_init_info () override
 
int do_init_info (uint instance) override
 
enum_return_check do_check_info () override
 
enum_return_check do_check_info (uint instance) override
 
void do_end_info () override
 
int do_flush_info (const bool force) override
 
int do_remove_info () override
 
int do_clean_info () override
 
int do_prepare_info_for_read () override
 
int do_prepare_info_for_write () override
 
bool do_set_info (const int pos, const char *value) override
 
bool do_set_info (const int pos, const uchar *value, const size_t size) override
 
bool do_set_info (const int pos, const int value) override
 
bool do_set_info (const int pos, const ulong value) override
 
bool do_set_info (const int pos, const float value) override
 
bool do_set_info (const int pos, const Server_ids *value) override
 
bool do_set_info (const int pos, const std::nullptr_t value) override
 
bool do_set_info (const int pos, const std::nullptr_t value, const size_t size) override
 
Rpl_info_handler::enum_field_get_status do_get_info (const int pos, char *value, const size_t size, const char *default_value) override
 
Rpl_info_handler::enum_field_get_status do_get_info (const int pos, uchar *value, const size_t size, const uchar *default_value) override
 
Rpl_info_handler::enum_field_get_status do_get_info (const int pos, int *value, const int default_value) override
 
Rpl_info_handler::enum_field_get_status do_get_info (const int pos, ulong *value, const ulong default_value) override
 
Rpl_info_handler::enum_field_get_status do_get_info (const int pos, float *value, const float default_value) override
 
Rpl_info_handler::enum_field_get_status do_get_info (const int pos, Server_ids *value, const Server_ids *default_value) override
 
char * do_get_description_info () override
 
bool do_is_transactional () override
 
bool do_update_is_transactional () override
 
uint do_get_rpl_info_type () override
 
Rpl_info_dummyoperator= (const Rpl_info_dummy &info)
 
 Rpl_info_dummy (const Rpl_info_dummy &info)
 

Static Private Attributes

static const bool abort = false
 

Additional Inherited Members

- Public Types inherited from Rpl_info_handler
enum class  enum_field_get_status : int { FIELD_VALUE_NOT_NULL = 0 , FIELD_VALUE_IS_NULL = 1 , FAILURE = 2 }
 
- Public Attributes inherited from Rpl_info_handler
Rpl_info_valuesfield_values
 
- Protected Member Functions inherited from Rpl_info_handler
 Rpl_info_handler (const int nparam, MY_BITMAP const *nullable_bitmap)
 
bool is_field_nullable (int pos)
 Checks whether or not the field at position pos is allowed to be NULL. More...
 
- Protected Attributes inherited from Rpl_info_handler
int ninfo
 
int cursor
 
bool prv_error
 
enum_field_get_status prv_get_error
 
uint sync_counter
 
uint sync_period
 
MY_BITMAP nullable_fields
 Bitset holding which of the fields are allowed to be NULL. More...
 

Detailed Description

Defines a dummy handler that should only be internally accessed.

This class is useful for debugging and performance tests.

The flag abort indicates if the execution should abort if some methods are called. See the code for further details.

Constructor & Destructor Documentation

◆ Rpl_info_dummy() [1/2]

Rpl_info_dummy::Rpl_info_dummy ( const int  nparam)

◆ ~Rpl_info_dummy()

Rpl_info_dummy::~Rpl_info_dummy ( )
overridedefault

◆ Rpl_info_dummy() [2/2]

Rpl_info_dummy::Rpl_info_dummy ( const Rpl_info_dummy info)
private

Member Function Documentation

◆ do_check_info() [1/2]

enum_return_check Rpl_info_dummy::do_check_info ( )
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_check_info() [2/2]

enum_return_check Rpl_info_dummy::do_check_info ( uint  instance)
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_clean_info()

int Rpl_info_dummy::do_clean_info ( )
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_end_info()

void Rpl_info_dummy::do_end_info ( )
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_flush_info()

int Rpl_info_dummy::do_flush_info ( const bool  force)
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_get_description_info()

char * Rpl_info_dummy::do_get_description_info ( )
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_get_info() [1/6]

Rpl_info_handler::enum_field_get_status Rpl_info_dummy::do_get_info ( const int  pos,
char *  value,
const size_t  size,
const char *  default_value 
)
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_get_info() [2/6]

Rpl_info_handler::enum_field_get_status Rpl_info_dummy::do_get_info ( const int  pos,
float *  value,
const float  default_value 
)
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_get_info() [3/6]

Rpl_info_handler::enum_field_get_status Rpl_info_dummy::do_get_info ( const int  pos,
int *  value,
const int  default_value 
)
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_get_info() [4/6]

Rpl_info_handler::enum_field_get_status Rpl_info_dummy::do_get_info ( const int  pos,
Server_ids value,
const Server_ids default_value 
)
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_get_info() [5/6]

Rpl_info_handler::enum_field_get_status Rpl_info_dummy::do_get_info ( const int  pos,
uchar value,
const size_t  size,
const uchar default_value 
)
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_get_info() [6/6]

Rpl_info_handler::enum_field_get_status Rpl_info_dummy::do_get_info ( const int  pos,
ulong *  value,
const ulong  default_value 
)
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_get_rpl_info_type()

uint Rpl_info_dummy::do_get_rpl_info_type ( )
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_init_info() [1/2]

int Rpl_info_dummy::do_init_info ( )
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_init_info() [2/2]

int Rpl_info_dummy::do_init_info ( uint  instance)
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_is_transactional()

bool Rpl_info_dummy::do_is_transactional ( )
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_prepare_info_for_read()

int Rpl_info_dummy::do_prepare_info_for_read ( )
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_prepare_info_for_write()

int Rpl_info_dummy::do_prepare_info_for_write ( )
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_remove_info()

int Rpl_info_dummy::do_remove_info ( )
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_set_info() [1/8]

bool Rpl_info_dummy::do_set_info ( const int  pos,
const char *  value 
)
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_set_info() [2/8]

bool Rpl_info_dummy::do_set_info ( const int  pos,
const float  value 
)
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_set_info() [3/8]

bool Rpl_info_dummy::do_set_info ( const int  pos,
const int  value 
)
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_set_info() [4/8]

bool Rpl_info_dummy::do_set_info ( const int  pos,
const Server_ids value 
)
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_set_info() [5/8]

bool Rpl_info_dummy::do_set_info ( const int  pos,
const std::nullptr_t  value 
)
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_set_info() [6/8]

bool Rpl_info_dummy::do_set_info ( const int  pos,
const std::nullptr_t  value,
const size_t  size 
)
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_set_info() [7/8]

bool Rpl_info_dummy::do_set_info ( const int  pos,
const uchar value,
const size_t  size 
)
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_set_info() [8/8]

bool Rpl_info_dummy::do_set_info ( const int  pos,
const ulong  value 
)
overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_update_is_transactional()

bool Rpl_info_dummy::do_update_is_transactional ( )
overrideprivatevirtual

Implements Rpl_info_handler.

◆ operator=()

Rpl_info_dummy& Rpl_info_dummy::operator= ( const Rpl_info_dummy info)
private

Member Data Documentation

◆ abort

const bool Rpl_info_dummy::abort = false
staticprivate

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