rpl_channel_service_interface.h File Reference

#include <string>
#include <vector>

Go to the source code of this file.

Classes
struct	Channel_ssl_info
	SSL information to be used when creating a channel. More...
struct	Channel_creation_info
	Creation information for a channel. More...
struct	Channel_connection_info
	Channel information to connect to a receiver. More...

Macros
#define	RPL_CHANNEL_SERVICE_RECEIVER_CONNECTION_ERROR   -1
#define	RPL_CHANNEL_SERVICE_DEFAULT_CHANNEL_CREATION_ERROR   -2
#define	RPL_CHANNEL_SERVICE_SLAVE_SKIP_COUNTER_ACTIVE   -3
#define	RPL_CHANNEL_SERVICE_CHANNEL_DOES_NOT_EXISTS_ERROR   -4
#define	REPLICATION_THREAD_WAIT_TIMEOUT_ERROR   -1
#define	REPLICATION_THREAD_WAIT_NO_INFO_ERROR   -2
#define	RPL_SERVICE_SERVER_DEFAULT   -1

Enumerations
enum	enum_channel_type { SLAVE_REPLICATION_CHANNEL , GROUP_REPLICATION_CHANNEL }
	Types of channels. More...
enum	enum_multi_threaded_workers_type { CHANNEL_MTS_PARALLEL_TYPE_DB_NAME , CHANNEL_MTS_PARALLEL_TYPE_LOGICAL_CLOCK }
	Know parallelization options that can be applied to channel appliers. More...
enum	enum_channel_thread_types { CHANNEL_NO_THD = 0 , CHANNEL_RECEIVER_THREAD = 1 , CHANNEL_APPLIER_THREAD = 2 }
	The known types of channel threads. More...
enum	enum_channel_until_condition {   CHANNEL_NO_UNTIL_CONDITION , CHANNEL_UNTIL_APPLIER_BEFORE_GTIDS , CHANNEL_UNTIL_APPLIER_AFTER_GTIDS , CHANNEL_UNTIL_APPLIER_AFTER_GAPS ,   CHANNEL_UNTIL_VIEW_ID }
	The known until conditions that can be applied to channels. More...
enum	enum_slave_channel_status { SLAVE_CHANNEL_NO_APPLIER_RUNNING_AND_NO_OPEN_TEMPORARY_TABLE = 0 , SLAVE_CHANNEL_APPLIER_IS_RUNNING , SLAVE_CHANNEL_HAS_OPEN_TEMPORARY_TABLE }
	Return type for function has_any_slave_channel_open_temp_table_or_is_its_applier_running() More...

Functions
void	initialize_channel_ssl_info (Channel_ssl_info *channel_ssl_info)
void	initialize_channel_creation_info (Channel_creation_info *channel_info)
void	initialize_channel_connection_info (Channel_connection_info *channel_info)
int	channel_create (const char *channel, Channel_creation_info *channel_information)
	Initializes a channel connection in a similar way to a change replication source command. More...
int	channel_start (const char *channel, Channel_connection_info *connection_info, int threads_to_start, int wait_for_connection, bool use_server_mta_configuration=false, bool channel_map_already_locked=false)
	Start the Applier/Receiver threads according to the given options. More...
int	channel_stop (const char *channel, int threads_to_stop, long timeout)
	Stops the channel threads according to the given options. More...
int	binlog_dump_thread_kill ()
	Kills the Binlog Dump threads. More...
int	channel_stop_all (int threads_to_stop, long timeout, std::string *error_message)
	Stops all the running channel threads according to the given options. More...
int	channel_purge_queue (const char *channel, bool reset_all)
	Purges the channel logs. More...
bool	channel_is_active (const char *channel, enum_channel_thread_types type)
	Tells if the selected component of the channel is active or not. More...
int	channel_get_thread_id (const char *channel, enum_channel_thread_types thread_type, unsigned long **thread_id, bool need_lock=true)
	Returns the id(s) of the channel threads: receiver or applier. More...
long long	channel_get_last_delivered_gno (const char *channel, int sidno)
	Returns last GNO from applier from a given UUID. More...
int	channel_add_executed_gtids_to_received_gtids (const char *channel)
	Adds server executed GTID set to channel received GTID set. More...
int	channel_queue_packet (const char *channel, const char *buf, unsigned long len)
	Queues a event packet into the current active channel. More...
int	channel_wait_until_apply_queue_applied (const char *channel, double timeout)
	Checks if all the queued transactions were executed. More...
int	channel_wait_until_transactions_applied (const char *channel, const char *gtid_set, double timeout, bool update_THD_status=true)
	Checks if all the transactions in the given set were executed. More...
int	channel_is_applier_waiting (const char *channel)
	Checks if the applier, and its workers when parallel applier is enabled, has already consumed all relay log, that is, applier is waiting for transactions to be queued. More...
int	channel_is_applier_thread_waiting (unsigned long thread_id, bool worker=false)
	Checks if the applier thread, and its workers when parallel applier is enabled, has already consumed all relay log, that is, applier thread is waiting for transactions to be queued. More...
int	channel_flush (const char *channel)
	Flush the channel. More...
int	initialize_channel_service_interface ()
	Initializes channel structures if needed. More...
int	channel_get_retrieved_gtid_set (const char *channel, char **retrieved_set)
	Returns the receiver thread retrieved GTID set in string format. More...
bool	channel_is_stopping (const char *channel, enum_channel_thread_types type)
	Tells if the selected component of the channel is stopping or not. More...
bool	is_partial_transaction_on_channel_relay_log (const char *channel)
	Checks if the given channel's relaylog contains a partial transaction. More...
bool	is_any_slave_channel_running (int thread_mask)
	Checks if any slave threads of any channel is running. More...
bool	is_any_slave_channel_running_with_failover_enabled (int thread_mask)
	Checks if any slave threads of any channel configured with SOURCE_CONNECTION_AUTO_FAILOVER is running. More...
bool	channel_has_same_uuid_as_group_name (const char *group_name)
	Checks if any running channel uses the same UUID for assign_gtids_to_anonymous_transactions as the group_name. More...
int	channel_get_credentials (const char *channel, std::string &user, std::string &password)
	Method to get the credentials configured for a channel. More...
int	channel_get_network_namespace (const char *channel, std::string &net_ns)
	Method to get the network namespace configured for a channel. More...
enum_slave_channel_status	has_any_slave_channel_open_temp_table_or_is_its_applier_running ()
	Checks if any slave channel applier is running or any slave channel has open temporary table(s). More...
int	channel_delete_credentials (const char *channel_name)
	Delete stored credentials from Slave_credentials. More...
bool	start_failover_channels ()
	Start channels which have SOURCE_CONNECTION_AUTO_FAILOVER=1. More...
bool	channel_change_source_connection_auto_failover (const char *channel, bool status)
	Set SOURCE_CONNECTION_AUTO_FAILOVER on the given channel to the given status value. More...
bool	unset_source_connection_auto_failover_on_all_channels ()
	Unset SOURCE_CONNECTION_AUTO_FAILOVER=0 on all channels. More...
void	reload_failover_channels_status ()
	Reload the status values on Rpl_acf_status_configuration singleton. More...
bool	get_replication_failover_channels_configuration (std::string &serialized_configuration)
	Get replication failover channels configuration in a serialized protobuf_replication_asynchronous_connection_failover::SourceAndManagedAndStatusList message. More...
bool	set_replication_failover_channels_configuration (const std::vector< std::string > &exchanged_replication_failover_channels_serialized_configuration)
	Set replication failover channels configuration that was received from the group. More...
bool	force_my_replication_failover_channels_configuration_on_all_members ()
	Collect and broadcast the replication failover channels configuration in a serialized protobuf_replication_asynchronous_connection_failover::SourceAndManagedAndStatusList message, that will override the configuration on all group members. More...
int	channel_get_gtid_set_to_apply (const char *channel, std::string &gtid_set_to_apply)
	Calculate transactions that are waiting to be applied on channel. More...

Macro Definition Documentation

REPLICATION_THREAD_WAIT_NO_INFO_ERROR

#define REPLICATION_THREAD_WAIT_NO_INFO_ERROR   -2

REPLICATION_THREAD_WAIT_TIMEOUT_ERROR

#define REPLICATION_THREAD_WAIT_TIMEOUT_ERROR   -1

RPL_CHANNEL_SERVICE_CHANNEL_DOES_NOT_EXISTS_ERROR

#define RPL_CHANNEL_SERVICE_CHANNEL_DOES_NOT_EXISTS_ERROR   -4

RPL_CHANNEL_SERVICE_DEFAULT_CHANNEL_CREATION_ERROR

#define RPL_CHANNEL_SERVICE_DEFAULT_CHANNEL_CREATION_ERROR   -2

RPL_CHANNEL_SERVICE_RECEIVER_CONNECTION_ERROR

#define RPL_CHANNEL_SERVICE_RECEIVER_CONNECTION_ERROR   -1

RPL_CHANNEL_SERVICE_SLAVE_SKIP_COUNTER_ACTIVE

#define RPL_CHANNEL_SERVICE_SLAVE_SKIP_COUNTER_ACTIVE   -3

RPL_SERVICE_SERVER_DEFAULT

#define RPL_SERVICE_SERVER_DEFAULT   -1

Enumeration Type Documentation

enum_channel_thread_types

enum enum_channel_thread_types

The known types of channel threads.

All new types should be power of 2

Enumerator
CHANNEL_NO_THD
CHANNEL_RECEIVER_THREAD
CHANNEL_APPLIER_THREAD

enum_channel_type

enum enum_channel_type

Types of channels.

Enumerator
SLAVE_REPLICATION_CHANNEL
GROUP_REPLICATION_CHANNEL

enum_channel_until_condition

enum enum_channel_until_condition

The known until conditions that can be applied to channels.

Enumerator
CHANNEL_NO_UNTIL_CONDITION
CHANNEL_UNTIL_APPLIER_BEFORE_GTIDS
CHANNEL_UNTIL_APPLIER_AFTER_GTIDS
CHANNEL_UNTIL_APPLIER_AFTER_GAPS
CHANNEL_UNTIL_VIEW_ID

enum_multi_threaded_workers_type

enum enum_multi_threaded_workers_type

Know parallelization options that can be applied to channel appliers.

Enumerator
CHANNEL_MTS_PARALLEL_TYPE_DB_NAME
CHANNEL_MTS_PARALLEL_TYPE_LOGICAL_CLOCK

enum_slave_channel_status

enum enum_slave_channel_status

Return type for function has_any_slave_channel_open_temp_table_or_is_its_applier_running()

Enumerator
SLAVE_CHANNEL_NO_APPLIER_RUNNING_AND_NO_OPEN_TEMPORARY_TABLE
SLAVE_CHANNEL_APPLIER_IS_RUNNING
SLAVE_CHANNEL_HAS_OPEN_TEMPORARY_TABLE

Function Documentation

binlog_dump_thread_kill()

int binlog_dump_thread_kill

(

)

Kills the Binlog Dump threads.

Returns

the operation status

Return values

0

OK

channel_add_executed_gtids_to_received_gtids()

int channel_add_executed_gtids_to_received_gtids

(

const char *

channel

)

Adds server executed GTID set to channel received GTID set.

Parameters

channel

the channel name

Returns

the operation status

Return values

0	OK
!=	0 Error

channel_change_source_connection_auto_failover()

bool channel_change_source_connection_auto_failover	(	const char *	channel,
		bool	status
	)

Set SOURCE_CONNECTION_AUTO_FAILOVER on the given channel to the given status value.

Parameters

[in]	channel	The channel name
[in]	status	true, enables SOURCE_CONNECTION_AUTO_FAILOVER false, disables SOURCE_CONNECTION_AUTO_FAILOVER

Returns

the operation status

Return values

false	OK
true	Error

channel_create()

int channel_create	(	const char *	channel,
		Channel_creation_info *	channel_information
	)

Initializes a channel connection in a similar way to a change replication source command.

Note

If the channel exists, it is reconfigured with the new options. About the logs, the preserve_relay_logs option allows the user to maintain them untouched.

Parameters

channel	The channel name
channel_information	Channel creation information.

Returns

the operation status

Return values

0	OK
!=0	Error on channel creation

channel_delete_credentials()

int channel_delete_credentials

(

const char *

channel_name

)

Delete stored credentials from Slave_credentials.

Parameters

[in]

channel_name

The channel name

Returns

the operation status

Return values

0	OK
1	Error, channel not found

channel_flush()

int channel_flush

(

const char *

channel

)

Flush the channel.

Returns

the operation status

Return values

0	OK
!=	0 Error on flush

channel_get_credentials()

int channel_get_credentials	(	const char *	channel,
		std::string &	user,
		std::string &	password
	)

Method to get the credentials configured for a channel.

Parameters

[in]	channel	The channel name
[out]	user	The user to extract
[out]	password	The password to extract

Returns

the operation status

Return values

false	OK
true	Error, channel not found

channel_get_gtid_set_to_apply()

int channel_get_gtid_set_to_apply	(	const char *	channel,
		std::string &	gtid_set_to_apply
	)

Calculate transactions that are waiting to be applied on channel.

gtid_set_to_apply will contain a list of UUIDs with intervals that represent transactions that will be applied.

Parameters

[in]	channel	name of the channel
[out]	gtid_set_to_apply	transactions on backlog to be applied.

Returns

the operation status

Return values

0	OK
!=0	Error

channel_get_last_delivered_gno()

long long channel_get_last_delivered_gno	(	const char *	channel,
		int	sidno
	)

Returns last GNO from applier from a given UUID.

Parameters

channel	the channel name
sidno	the uuid associated to the desired gno

Returns

the last applier gno

Return values

<0	the channel does no exists, or the applier is not present
>0	the gno

channel_get_network_namespace()

int channel_get_network_namespace	(	const char *	channel,
		std::string &	net_ns
	)

Method to get the network namespace configured for a channel.

Parameters

[in]	channel	The channel name
[out]	net_ns	The network namespace to extract

Returns

the operation status

Return values

false	OK
true	Error, channel not found

channel_get_retrieved_gtid_set()

int channel_get_retrieved_gtid_set	(	const char *	channel,
		char **	retrieved_set
	)

Returns the receiver thread retrieved GTID set in string format.

Parameters

	channel	The channel name.
[out]	retrieved_set	Pointer to pointer to string. The function will set it to point to a newly allocated buffer, or NULL on out of memory.

Returns

the operation status

Return values

0	OK
!=0	Error on retrieval

channel_get_thread_id()

int channel_get_thread_id	(	const char *	channel,
		enum_channel_thread_types	thread_type,
		unsigned long **	thread_id,
		bool	need_lock = true
	)

Returns the id(s) of the channel threads: receiver or applier.

If more than one applier exists, an array is returned, on which first index is coordinator thread id.

Parameters

[in]	channel	The channel name
[in]	thread_type	The thread type (receiver or applier)
[out]	thread_id	The array of id(s)
[in]	need_lock	Is channel_map read lock needed?

Returns

the number of returned ids

Return values

-1	the channel does no exists, or the thread is not present
>0	the number of thread ids returned.

channel_has_same_uuid_as_group_name()

bool channel_has_same_uuid_as_group_name

(

const char *

group_name

)

Checks if any running channel uses the same UUID for assign_gtids_to_anonymous_transactions as the group_name.

Parameters

[in]

group_name

the group name

Return values

true	at least one channel has the same uuid
false	none of the the channels have the same uuid

channel_is_active()

bool channel_is_active	(	const char *	channel,
		enum_channel_thread_types	type
	)

Tells if the selected component of the channel is active or not.

If no component is passed, this method returns if the channel exists or not

Parameters

channel	The channel name
type	The thread that should be checked. If 0, this method applies to the channel existence.

Returns

is the channel (component) active

Return values

true	Yes
false	No

channel_is_applier_thread_waiting()

int channel_is_applier_thread_waiting	(	unsigned long	thread_id,
		bool	worker = false
	)

Checks if the applier thread, and its workers when parallel applier is enabled, has already consumed all relay log, that is, applier thread is waiting for transactions to be queued.

Parameters

thread_id	the applier thread id to check
worker	flag to indicate if thread is a parallel worker

Returns

the operation status

Return values

-1	Unable to find applier thread
0	Applier thread is not waiting
1	Applier thread is waiting

channel_is_applier_waiting()

int channel_is_applier_waiting

(

const char *

channel

)

Checks if the applier, and its workers when parallel applier is enabled, has already consumed all relay log, that is, applier is waiting for transactions to be queued.

Parameters

channel

The channel name

Returns

the operation status

Return values

<0	Error
0	Applier is not waiting
1	Applier is waiting

channel_is_stopping()

bool channel_is_stopping	(	const char *	channel,
		enum_channel_thread_types	type
	)

Tells if the selected component of the channel is stopping or not.

Parameters

channel	The channel name
type	The thread that should be checked.

Returns

is the channel (component) stopping

Return values

true	Yes
false	No, no type was specified or the channel does not exist.

channel_purge_queue()

int channel_purge_queue	(	const char *	channel,
		bool	reset_all
	)

Purges the channel logs.

Parameters

channel	The channel name
reset_all	If true, the method will purge logs and remove the channel If false, only the channel information will be reset.

Returns

the operation status

Return values

0	OK
!=0	Error

channel_queue_packet()

int channel_queue_packet	(	const char *	channel,
		const char *	buf,
		unsigned long	len
	)

Queues a event packet into the current active channel.

Parameters

channel	the channel name
buf	the event buffer
len	the event buffer length

Returns

the operation status

Return values

0	OK
!=	0 Error on queue

channel_start()

int channel_start	(	const char *	channel,
		Channel_connection_info *	connection_info,
		int	threads_to_start,
		int	wait_for_connection,
		bool	use_server_mta_configuration = false,
		bool	channel_map_already_locked = false
	)

Start the Applier/Receiver threads according to the given options.

If the receiver thread is to be started, connection credential must be supported.

Parameters

channel	The channel name
connection_info	Channel connection information
threads_to_start	The types of threads to be started
wait_for_connection	If when starting the receiver, the method should wait for the connection to succeed
use_server_mta_configuration	If true, the channel uses the server parallel applier configuration when starting the applier thread, instead of the configuration given on channel_create()
channel_map_already_locked	If set to true, will not acquire a write lock of channel_map

Returns

the operation status

Return values

0	OK
!=0	Error

channel_stop()

int channel_stop	(	const char *	channel,
		int	threads_to_stop,
		long	timeout
	)

Stops the channel threads according to the given options.

Parameters

channel	The channel name
threads_to_stop	The types of threads to be stopped
timeout	The expected time in which the thread should stop

Returns

the operation status

Return values

0	OK
!=0	Error

channel_stop_all()

int channel_stop_all	(	int	threads_to_stop,
		long	timeout,
		std::string *	error_message
	)

Stops all the running channel threads according to the given options.

Parameters

threads_to_stop	The types of threads to be stopped
timeout	The expected time in which the thread should stop
error_message	The returned error_message

Returns

the operation status

Return values

0	OK
!=0	Error

channel_wait_until_apply_queue_applied()

int channel_wait_until_apply_queue_applied	(	const char *	channel,
		double	timeout
	)

Checks if all the queued transactions were executed.

Note

This method assumes that the channel is not receiving any more events. If it is still receiving, then the method should wait for execution of transactions that were present when this method was invoked.

Parameters

channel	the channel name
timeout	the time (seconds) after which the method returns if the above condition was not satisfied

Returns

the operation status

Return values

0	All transactions were executed
REPLICATION_THREAD_WAIT_TIMEOUT_ERROR	A timeout occurred
REPLICATION_THREAD_WAIT_NO_INFO_ERROR	An error occurred

channel_wait_until_transactions_applied()

int channel_wait_until_transactions_applied	(	const char *	channel,
		const char *	gtid_set,
		double	timeout,
		bool	update_THD_status = true
	)

Checks if all the transactions in the given set were executed.

Parameters

channel	the channel name
gtid_set	the set in string format of transaction to wait for
timeout	the time (seconds) after which the method returns if the above condition was not satisfied
update_THD_status	Shall the method update the THD stage

Returns

the operation status

Return values

0	All transactions were executed
REPLICATION_THREAD_WAIT_TIMEOUT_ERROR	A timeout occurred
REPLICATION_THREAD_WAIT_NO_INFO_ERROR	An error occurred

force_my_replication_failover_channels_configuration_on_all_members()

bool force_my_replication_failover_channels_configuration_on_all_members

(

)

Collect and broadcast the replication failover channels configuration in a serialized protobuf_replication_asynchronous_connection_failover::SourceAndManagedAndStatusList message, that will override the configuration on all group members.

Returns

the operation status

Return values

false	OK
true	Error

get_replication_failover_channels_configuration()

bool get_replication_failover_channels_configuration

(

std::string &

serialized_configuration

)

Get replication failover channels configuration in a serialized protobuf_replication_asynchronous_connection_failover::SourceAndManagedAndStatusList message.

Parameters

[out]

serialized_configuration

the serialized configuration

Returns

the operation status

Return values

false	OK
true	Error

has_any_slave_channel_open_temp_table_or_is_its_applier_running()

enum_slave_channel_status has_any_slave_channel_open_temp_table_or_is_its_applier_running

(

)

Checks if any slave channel applier is running or any slave channel has open temporary table(s).

This holds handled appliers' run_locks until finding a running slave channel applier or a slave channel which has open temporary table(s), or handling all slave channels.

Returns

SLAVE_CHANNEL_NO_APPLIER_RUNNING_AND_NO_OPEN_TEMPORARY_TABLE, SLAVE_CHANNEL_APPLIER_IS_RUNNING or SLAVE_CHANNEL_HAS_OPEN_TEMPORARY_TABLE.

initialize_channel_connection_info()

void initialize_channel_connection_info

(

Channel_connection_info *

channel_info

)

initialize_channel_creation_info()

void initialize_channel_creation_info

(

Channel_creation_info *

channel_info

)

initialize_channel_service_interface()

int initialize_channel_service_interface

(

)

Initializes channel structures if needed.

Returns

the operation status

Return values

0	OK
!=	0 Error on queue

initialize_channel_ssl_info()

void initialize_channel_ssl_info

(

Channel_ssl_info *

channel_ssl_info

)

is_any_slave_channel_running()

bool is_any_slave_channel_running

(

int

thread_mask

)

Checks if any slave threads of any channel is running.

Parameters

[in]

thread_mask

type of slave thread- IO/SQL or any

Return values

true	at least one channel thread is running.
false	none of the the channels are running.

is_any_slave_channel_running_with_failover_enabled()

bool is_any_slave_channel_running_with_failover_enabled

(

int

thread_mask

)

Checks if any slave threads of any channel configured with SOURCE_CONNECTION_AUTO_FAILOVER is running.

Parameters

[in]

thread_mask

type of slave thread- IO/SQL or any

Return values

true	at least one channel threads are running.
false	none of the the channels are running.

is_partial_transaction_on_channel_relay_log()

bool is_partial_transaction_on_channel_relay_log

(

const char *

channel

)

Checks if the given channel's relaylog contains a partial transaction.

Parameters

channel

The channel name

Return values

true	If relaylog contains partial transcation.
false	If relaylog does not contain partial transaction.

reload_failover_channels_status()

void reload_failover_channels_status

(

)

Reload the status values on Rpl_acf_status_configuration singleton.

set_replication_failover_channels_configuration()

bool set_replication_failover_channels_configuration

(

const std::vector< std::string > &

exchanged_replication_failover_channels_serialized_configuration

)

Set replication failover channels configuration that was received from the group.

Each member of the group will send its own configuration in a serialized protobuf_replication_asynchronous_connection_failover::SourceAndManagedAndStatusList message.

Parameters

[in]

exchanged_replication_failover_channels_serialized_configuration

vector with the serialized configuration from each member

Returns

the operation status

Return values

false	OK
true	Error

start_failover_channels()

bool start_failover_channels

(

)

Start channels which have SOURCE_CONNECTION_AUTO_FAILOVER=1.

Returns

the operation status

Return values

false	OK
true	Error

unset_source_connection_auto_failover_on_all_channels()

bool unset_source_connection_auto_failover_on_all_channels

(

)

Unset SOURCE_CONNECTION_AUTO_FAILOVER=0 on all channels.

Returns

the operation status

Return values

false	OK
true	Error