MySQL 26.7.0
Source Code Documentation
Event_metadata Class Reference

Represents basic event metadata: type and length. More...

#include <binlog_reader.h>

Public Types

using Type = mysql::binlog::event::Log_event_type
 

Public Member Functions

 Event_metadata ()=default
 
 Event_metadata (const Type &type, std::size_t len, bool ignorable)
 Construct. More...
 
std::size_t get_length () const
 Event length accessor. More...
 
Type get_type () const
 Event type accessor. More...
 
bool is_ignorable () const
 Returns information on whether this event is ignorable. More...
 
bool is_valid () const
 We allow to construct empty objects, this function returns true in case object was initialized with data. More...
 

Private Attributes

Type m_type
 Log event type. More...
 
std::size_t m_event_length
 Log event length. More...
 
bool m_ignorable {false}
 Flag: is ignorable event. More...
 
bool m_valid {false}
 

Detailed Description

Represents basic event metadata: type and length.

Member Typedef Documentation

◆ Type

Constructor & Destructor Documentation

◆ Event_metadata() [1/2]

Event_metadata::Event_metadata ( )
default

◆ Event_metadata() [2/2]

Event_metadata::Event_metadata ( const Type type,
std::size_t  len,
bool  ignorable 
)
inline

Construct.

Member Function Documentation

◆ get_length()

std::size_t Event_metadata::get_length ( ) const
inline

Event length accessor.

Returns
Event length

◆ get_type()

Type Event_metadata::get_type ( ) const
inline

Event type accessor.

Returns
Event type

◆ is_ignorable()

bool Event_metadata::is_ignorable ( ) const
inline

Returns information on whether this event is ignorable.

Returns
True if event may be ignored

◆ is_valid()

bool Event_metadata::is_valid ( void  ) const
inline

We allow to construct empty objects, this function returns true in case object was initialized with data.

Returns
True in case object was initialized with data, false otherwise

Member Data Documentation

◆ m_event_length

std::size_t Event_metadata::m_event_length
private

Log event length.

◆ m_ignorable

bool Event_metadata::m_ignorable {false}
private

Flag: is ignorable event.

◆ m_type

Type Event_metadata::m_type
private

Log event type.

◆ m_valid

bool Event_metadata::m_valid {false}
private

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