Defines a file handler. More...

#include <rpl_info_file.h>

Inheritance diagram for Rpl_info_file:

Public Member Functions
	~Rpl_info_file () override

Public Member Functions inherited from Rpl_info_handler
	Rpl_info_handler (const Rpl_info_handler &handler)=delete

Rpl_info_handler &	operator= (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
	Setter needed to set nullable fields to `NULL`. More...

bool	do_set_info (const int pos, const std::nullptr_t value, const size_t size) override
	Setter needed to set nullable fields to `NULL`. More...

Rpl_info_handler::enum_field_get_status	check_for_error (int pos, long n_read_bytes)
	Checks if the value returned from the read function is an actual error or just the side-effect of a nullable field. More...

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

uint	do_get_rpl_info_type () override

bool	do_is_transactional () override

bool	do_update_is_transactional () override

	Rpl_info_file (int const nparam, const char param_pattern_fname, const char param_info_fname, bool name_indexed, MY_BITMAP const *nullable_bitmap)

	Rpl_info_file (const Rpl_info_file &info)

Rpl_info_file &	operator= (const Rpl_info_file &info)

Static Private Member Functions
static bool	do_count_info (const int nparam, const char param_pattern_fname, bool indexed, MY_BITMAP const nullable_bitmap, uint *counter)
	Returns the number of files that corresponds to param_info_fname. More...

static int	do_reset_info (int const nparam, const char param_pattern_fname, bool name_indexed, MY_BITMAP const nullable_bitmap)

Private Attributes
char	info_fname [FN_REFLEN+128]
	This uniquely identifies a file. More...

char	pattern_fname [FN_REFLEN+128]
	This is used to identified a name's pattern. More...

File	info_fd

IO_CACHE	info_file

bool	name_indexed

Friends
class	Rpl_info_factory

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_values *	field_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 file handler.

Constructor & Destructor Documentation

◆ ~Rpl_info_file()

Rpl_info_file::~Rpl_info_file ( )

override

◆ Rpl_info_file() [1/2]

Rpl_info_file::Rpl_info_file	(	int const	nparam,
		const char *	param_pattern_fname,
		const char *	param_info_fname,
		bool	name_indexed,
		MY_BITMAP const *	nullable_bitmap
	)

private

◆ Rpl_info_file() [2/2]

Rpl_info_file::Rpl_info_file ( const Rpl_info_file & info )

private

Member Function Documentation

◆ check_for_error()

Rpl_info_handler::enum_field_get_status Rpl_info_file::check_for_error	(	int	pos,
		long	n_read_bytes
	)

private

Checks if the value returned from the read function is an actual error or just the side-effect of a nullable field.

Parameters

pos	the position of the field to check.
n_read_bytes	number of read bytes, returned from the read function.

Returns: FIELD_VALUE_NOT_NULL if the number of read bytes is bigger or equal than 0 or the column is not nullable. FIELD_VALUE_IS_NULL if the number of read bytes is 0 and the columns is nullable. FAILURE if the number of read bytes is lower than 0.

◆ do_check_info() [1/2]

enum_return_check Rpl_info_file::do_check_info ( )

overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_check_info() [2/2]

enum_return_check Rpl_info_file::do_check_info ( uint instance )

overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_clean_info()

int Rpl_info_file::do_clean_info ( )

overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_count_info()

bool Rpl_info_file::do_count_info	(	const int	nparam,
		const char *	param_pattern_fname,
		bool	indexed,
		MY_BITMAP const *	nullable_bitmap,
		uint *	counter
	)

staticprivate

Returns the number of files that corresponds to param_info_fname.

If param_info_fname is a regular expression, expression is set.

Parameters

[in]	nparam	Number of fields in the file.
[in]	param_pattern_fname	File's name.
[in]	indexed	indicates whether the file is indexed and if so there is a range to count in.
[in]	nullable_bitmap	bitmap that holds the fields that are allowed to be `NULL`.
[out]	counter	Number of files found.

Return values

false	Success
true	Error

◆ do_end_info()

void Rpl_info_file::do_end_info ( )

overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_flush_info()

int Rpl_info_file::do_flush_info ( const bool force )

overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_get_description_info()

char * Rpl_info_file::do_get_description_info ( )

overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_get_info() [1/6]

Rpl_info_handler::enum_field_get_status Rpl_info_file::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_file::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_file::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_file::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_file::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_file::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_file::do_get_rpl_info_type ( )

overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_init_info() [1/2]

int Rpl_info_file::do_init_info ( )

overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_init_info() [2/2]

int Rpl_info_file::do_init_info ( uint instance )

overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_is_transactional()

bool Rpl_info_file::do_is_transactional ( )

overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_prepare_info_for_read()

int Rpl_info_file::do_prepare_info_for_read ( )

overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_prepare_info_for_write()

int Rpl_info_file::do_prepare_info_for_write ( )

overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_remove_info()

int Rpl_info_file::do_remove_info ( )

overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_reset_info()

int Rpl_info_file::do_reset_info	(	int const	nparam,
		const char *	param_pattern_fname,
		bool	name_indexed,
		MY_BITMAP const *	nullable_bitmap
	)

staticprivate

◆ do_set_info() [1/8]

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

overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_set_info() [2/8]

bool Rpl_info_file::do_set_info	(	const int	pos,
		const float	value
	)

overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_set_info() [3/8]

bool Rpl_info_file::do_set_info	(	const int	pos,
		const int	value
	)

overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_set_info() [4/8]

bool Rpl_info_file::do_set_info	(	const int	pos,
		const Server_ids *	value
	)

overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_set_info() [5/8]

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

overrideprivatevirtual

Setter needed to set nullable fields to NULL.

Parameters

pos	the index of the field to set to `NULL`.
value	unused value, needed to desimbiguate polimorphism.

Returns: true if there was an error and false otherwise.

Implements Rpl_info_handler.

◆ do_set_info() [6/8]

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

overrideprivatevirtual

Setter needed to set nullable fields to NULL.

Parameters

pos	the index of the field to set to `NULL`.
value	unused value, needed to desimbiguate polimorphism.
size	unused value size, needed to desimbiguate polimorphism.

Returns: true if there was an error and false otherwise.

Implements Rpl_info_handler.

◆ do_set_info() [7/8]

bool Rpl_info_file::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_file::do_set_info	(	const int	pos,
		const ulong	value
	)

overrideprivatevirtual

Implements Rpl_info_handler.

◆ do_update_is_transactional()

bool Rpl_info_file::do_update_is_transactional ( )

overrideprivatevirtual

Implements Rpl_info_handler.

◆ operator=()

Rpl_info_file & Rpl_info_file::operator= ( const Rpl_info_file & info )

private

Friends And Related Function Documentation

◆ Rpl_info_factory

friend class Rpl_info_factory

friend

Member Data Documentation

◆ info_fd

File Rpl_info_file::info_fd

private

◆ info_file

IO_CACHE Rpl_info_file::info_file

private

◆ info_fname

char Rpl_info_file::info_fname[FN_REFLEN+128]

private

This uniquely identifies a file.

When introducing multi-master replication one needs to ensure that files' names are unique. If tables are used, there is no issue at all. It is highly recommend to avoid using files as they do not provide an atomic behavior.

◆ name_indexed

bool Rpl_info_file::name_indexed

private

◆ pattern_fname

char Rpl_info_file::pattern_fname[FN_REFLEN+128]

private

This is used to identified a name's pattern.

For instance, worker-relay-log.info.*.

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

sql/rpl_info_file.h
sql/rpl_info_file.cc

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~Rpl_info_file()

◆ Rpl_info_file() [1/2]

◆ Rpl_info_file() [2/2]

Member Function Documentation

◆ check_for_error()

◆ do_check_info() [1/2]

◆ do_check_info() [2/2]

◆ do_clean_info()

◆ do_count_info()

◆ do_end_info()

◆ do_flush_info()

◆ do_get_description_info()

◆ do_get_info() [1/6]

◆ do_get_info() [2/6]

◆ do_get_info() [3/6]

◆ do_get_info() [4/6]

◆ do_get_info() [5/6]

◆ do_get_info() [6/6]

◆ do_get_rpl_info_type()

◆ do_init_info() [1/2]

◆ do_init_info() [2/2]

◆ do_is_transactional()

◆ do_prepare_info_for_read()

◆ do_prepare_info_for_write()

◆ do_remove_info()

◆ do_reset_info()

◆ do_set_info() [1/8]

◆ do_set_info() [2/8]

◆ do_set_info() [3/8]

◆ do_set_info() [4/8]

◆ do_set_info() [5/8]

◆ do_set_info() [6/8]

◆ do_set_info() [7/8]

◆ do_set_info() [8/8]

◆ do_update_is_transactional()

◆ operator=()

Friends And Related Function Documentation

◆ Rpl_info_factory

Member Data Documentation

◆ info_fd

◆ info_file

◆ info_fname

◆ name_indexed

◆ pattern_fname