MySQL 8.3.0
Source Code Documentation
Until_option Class Referenceabstract

This is the abstract base class for slave start until options. More...

#include <rpl_replica_until_options.h>

Inheritance diagram for Until_option:
[legend]

Public Member Functions

virtual ~Until_option ()=default
 
bool is_satisfied_at_start_slave ()
 Check if the until option is already satisfied at coordinator starting. More...
 
bool is_satisfied_before_dispatching_event (const Log_event *ev)
 check if the until option is satisfied before applying or dispatching a event. More...
 
bool is_satisfied_after_dispatching_event ()
 check if the until option is satisfied after applied or dispatched a event. More...
 
bool is_satisfied_all_transactions_read_from_relay_log ()
 check if the until option is waiting for more transactions to be read from the relay log. More...
 

Protected Member Functions

 Until_option (Relay_log_info *rli)
 

Protected Attributes

Relay_log_infom_rli
 

Private Member Functions

virtual bool check_at_start_slave ()=0
 
virtual bool check_before_dispatching_event (const Log_event *ev)=0
 
virtual bool check_after_dispatching_event ()=0
 
virtual bool check_all_transactions_read_from_relay_log ()=0
 

Detailed Description

This is the abstract base class for slave start until options.

It defines the public interfaces called by slave coordinator.

This class publics three interfaces:

  • is_satisfied_at_start_slave It is called just when starting slave coordinator to check if the until condition is already satisfied.
  • is_satisfied_before_dispatching_event It is called just after coordinator reads a events from relay log but before it is applied or dispatched.
  • is_satisfied_after_dispatching_event It is called just after a event is applied or dispatched by the coordinator.

These three interfaces cover all until options's check requirements.

Constructor & Destructor Documentation

◆ ~Until_option()

virtual Until_option::~Until_option ( )
virtualdefault

◆ Until_option()

Until_option::Until_option ( Relay_log_info rli)
inlineprotected

Member Function Documentation

◆ check_after_dispatching_event()

virtual bool Until_option::check_after_dispatching_event ( )
privatepure virtual

◆ check_all_transactions_read_from_relay_log()

virtual bool Until_option::check_all_transactions_read_from_relay_log ( )
privatepure virtual

◆ check_at_start_slave()

virtual bool Until_option::check_at_start_slave ( )
privatepure virtual

◆ check_before_dispatching_event()

virtual bool Until_option::check_before_dispatching_event ( const Log_event ev)
privatepure virtual

◆ is_satisfied_after_dispatching_event()

bool Until_option::is_satisfied_after_dispatching_event ( )
inline

check if the until option is satisfied after applied or dispatched a event.

Returns
bool
Return values
trueif it is satisfied.
falseif it is not satisfied.

◆ is_satisfied_all_transactions_read_from_relay_log()

bool Until_option::is_satisfied_all_transactions_read_from_relay_log ( )
inline

check if the until option is waiting for more transactions to be read from the relay log.

Returns
bool
Return values
trueall log events where read.
falsewaiting for more log events to be read.

◆ is_satisfied_at_start_slave()

bool Until_option::is_satisfied_at_start_slave ( )
inline

Check if the until option is already satisfied at coordinator starting.

Returns
bool
Return values
trueif it is satisfied.
falseif it is not satisfied.

◆ is_satisfied_before_dispatching_event()

bool Until_option::is_satisfied_before_dispatching_event ( const Log_event ev)
inline

check if the until option is satisfied before applying or dispatching a event.

Parameters
[in]evpoint to the event which will be applied or dispatched.
Returns
bool
Return values
trueif it is satisfied.
falseif it is not satisfied.

Member Data Documentation

◆ m_rli

Relay_log_info* Until_option::m_rli
protected

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