MySQL 9.1.0
Source Code Documentation
Log_Arch_Client_Ctx Class Reference

Redo Log archiver client context. More...

#include <arch0log.h>

Public Member Functions

 Log_Arch_Client_Ctx ()
 Constructor: Initialize elementsf. More...
 
os_offset_t get_archived_file_size () const
 Get redo file size for archived log file. More...
 
void get_header_size (uint &header_sz, uint &trailer_sz) const
 Get redo header and trailer size. More...
 
int start (byte *header, uint len)
 Start redo log archiving. More...
 
int stop (byte *trailer, uint32_t &len, uint64_t &offset)
 Stop redo log archiving. More...
 
int get_files (Log_Arch_Cbk *cbk_func, void *ctx)
 Get archived data file details. More...
 
void release ()
 Release archived data so that system can purge it. More...
 

Private Attributes

Arch_Client_State m_state
 Archiver client state. More...
 
Arch_Groupm_group
 Archive group the client is attached to. More...
 
lsn_t m_begin_lsn
 Start LSN for archived data. More...
 
lsn_t m_end_lsn
 Stop LSN for archived data. More...
 

Detailed Description

Redo Log archiver client context.

Constructor & Destructor Documentation

◆ Log_Arch_Client_Ctx()

Log_Arch_Client_Ctx::Log_Arch_Client_Ctx ( )
inline

Constructor: Initialize elementsf.

Member Function Documentation

◆ get_archived_file_size()

os_offset_t Log_Arch_Client_Ctx::get_archived_file_size ( ) const

Get redo file size for archived log file.

Returns
size of file in bytes

◆ get_files()

int Log_Arch_Client_Ctx::get_files ( Log_Arch_Cbk cbk_func,
void *  ctx 
)

Get archived data file details.

Parameters
[in]cbk_funccallback called for each file
[in]ctxcallback function context
Returns
error code

◆ get_header_size()

void Log_Arch_Client_Ctx::get_header_size ( uint &  header_sz,
uint &  trailer_sz 
) const

Get redo header and trailer size.

Parameters
[out]header_szredo header size
[out]trailer_szredo trailer size

◆ release()

void Log_Arch_Client_Ctx::release ( )

Release archived data so that system can purge it.

◆ start()

int Log_Arch_Client_Ctx::start ( byte header,
uint  len 
)

Start redo log archiving.

Parameters
[out]headerbuffer for redo header (caller must allocate)
[in]lenbuffer length
Returns
error code

◆ stop()

int Log_Arch_Client_Ctx::stop ( byte trailer,
uint32_t &  len,
uint64_t &  offset 
)

Stop redo log archiving.

Exact trailer length is returned as out parameter which could be less than the redo block size.

Parameters
[out]trailerredo trailer. Caller must allocate buffer.
[in,out]lentrailer length
[out]offsettrailer block offset
Returns
error code

Member Data Documentation

◆ m_begin_lsn

lsn_t Log_Arch_Client_Ctx::m_begin_lsn
private

Start LSN for archived data.

◆ m_end_lsn

lsn_t Log_Arch_Client_Ctx::m_end_lsn
private

Stop LSN for archived data.

◆ m_group

Arch_Group* Log_Arch_Client_Ctx::m_group
private

Archive group the client is attached to.

◆ m_state

Arch_Client_State Log_Arch_Client_Ctx::m_state
private

Archiver client state.


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