MySQL 26.7.0
Source Code Documentation
Public Member Functions | List of all members
mysql::csa::Reader Class Referenceabstract

#include <reader.h>

Inheritance diagram for mysql::csa::Reader:
[legend]

Public Member Functions

virtual Job_ptr read ()=0
 Reads and returns a unique pointer to a Job object. More...
 
virtual bool is_stopped () const =0
 Checks whether the Change Stream Applier (CSA) is stopped. More...
 
virtual bool is_error () const =0
 Checks whether the Change Stream Applier (CSA) has encountered an error. More...
 
virtual ~Reader ()=default
 Destructor. More...
 
virtual void stop ()=0
 Stops the reader. More...
 

Constructor & Destructor Documentation

◆ ~Reader()

virtual mysql::csa::Reader::~Reader ( )
virtualdefault

Destructor.

Member Function Documentation

◆ is_error()

virtual bool mysql::csa::Reader::is_error ( ) const
pure virtual

Checks whether the Change Stream Applier (CSA) has encountered an error.

Returns
true if an error occurred, false otherwise.

Implemented in mysql::csa::Relay_log_adaptive_reader.

◆ is_stopped()

virtual bool mysql::csa::Reader::is_stopped ( ) const
pure virtual

Checks whether the Change Stream Applier (CSA) is stopped.

Returns
true if a stop was requested, false otherwise.

Implemented in mysql::csa::Relay_log_adaptive_reader.

◆ read()

virtual Job_ptr mysql::csa::Reader::read ( )
pure virtual

Reads and returns a unique pointer to a Job object.

This method is responsible for reading data and creating a Job.

Returns
A unique pointer to the Job read from the storage.

Implemented in mysql::csa::Relay_log_adaptive_reader.

◆ stop()

virtual void mysql::csa::Reader::stop ( )
pure virtual

Stops the reader.

Implemented in mysql::csa::Relay_log_adaptive_reader.

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