MySQL 8.3.0
Source Code Documentation
Log_user_consumer Class Reference

#include <log0consumer.h>

Inheritance diagram for Log_user_consumer:
[legend]

Public Member Functions

 Log_user_consumer (const std::string &name)
 
const std::string & get_name () const override
 
void set_consumed_lsn (lsn_t consumed_lsn)
 Set the lsn reported by get_consumed_lsn() to the given value. More...
 
lsn_t get_consumed_lsn () const override
 
void consumption_requested () override
 Request the log consumer to consume faster. More...
 
- Public Member Functions inherited from Log_consumer
virtual ~Log_consumer ()
 

Private Attributes

const std::string m_name
 Name of this consumer (saved value from ctor). More...
 
lsn_t m_consumed_lsn {}
 Value reported by get_consumed_lsn(). More...
 

Constructor & Destructor Documentation

◆ Log_user_consumer()

Log_user_consumer::Log_user_consumer ( const std::string &  name)
explicit

Member Function Documentation

◆ consumption_requested()

void Log_user_consumer::consumption_requested ( )
overridevirtual

Request the log consumer to consume faster.

Remarks
This is called whenever the redo log consumer is the most lagging one and it is critical to consume the oldest redo log file.

Implements Log_consumer.

◆ get_consumed_lsn()

lsn_t Log_user_consumer::get_consumed_lsn ( ) const
overridevirtual
Returns
Maximum LSN up to which this consumer has consumed redo.

Implements Log_consumer.

◆ get_name()

const std::string & Log_user_consumer::get_name ( ) const
overridevirtual
Returns
Name of this consumer.

Implements Log_consumer.

◆ set_consumed_lsn()

void Log_user_consumer::set_consumed_lsn ( lsn_t  consumed_lsn)

Set the lsn reported by get_consumed_lsn() to the given value.

It is required that the given value is greater or equal to the value currently reported by the get_consumed_lsn().

Parameters
[in]consumed_lsnthe given lsn to report

Member Data Documentation

◆ m_consumed_lsn

lsn_t Log_user_consumer::m_consumed_lsn {}
private

Value reported by get_consumed_lsn().

Set by set_consumed_lsn(lsn).

◆ m_name

const std::string Log_user_consumer::m_name
private

Name of this consumer (saved value from ctor).


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