IBasic_binlog_file_reader Class Reference

Interface class that all specializations of template <...> Basic_binlog_file_reader inherit from. More...

#include <binlog_reader.h>

Inheritance diagram for IBasic_binlog_file_reader:

Public Member Functions
	IBasic_binlog_file_reader ()=default
	IBasic_binlog_file_reader (IBasic_binlog_file_reader &)=delete
	IBasic_binlog_file_reader (IBasic_binlog_file_reader &&)=delete
IBasic_binlog_file_reader &	operator= (IBasic_binlog_file_reader &)=delete
IBasic_binlog_file_reader &	operator= (IBasic_binlog_file_reader &&)=delete
virtual	~IBasic_binlog_file_reader ()=default
virtual bool	has_fatal_error () const =0
	Return true if there was a previous error. More...
virtual Binlog_read_error::Error_type	get_error_type () const =0
	Return the type of error. More...
virtual const char *	get_error_str () const =0
	Return a string representing the error. More...
virtual my_off_t	position () const =0
	Return the current position in bytes, relative to the beginning of the file. More...
virtual Log_event *	read_event_object ()=0
	Read the next event from the stream. More...
virtual const mysql::binlog::event::Format_description_event &	format_description_event () const =0
	Return a pointer the currently used Format_description_log_event. More...

Detailed Description

Interface class that all specializations of template <...> Basic_binlog_file_reader inherit from.

Constructor & Destructor Documentation

IBasic_binlog_file_reader() [1/3]

IBasic_binlog_file_reader::IBasic_binlog_file_reader ( )

default

IBasic_binlog_file_reader() [2/3]

IBasic_binlog_file_reader::IBasic_binlog_file_reader ( IBasic_binlog_file_reader &  )

delete

IBasic_binlog_file_reader() [3/3]

IBasic_binlog_file_reader::IBasic_binlog_file_reader ( IBasic_binlog_file_reader &&  )

delete

~IBasic_binlog_file_reader()

virtual IBasic_binlog_file_reader::~IBasic_binlog_file_reader ( )

virtualdefault

Member Function Documentation

format_description_event()

virtual const mysql::binlog::event::Format_description_event & IBasic_binlog_file_reader::format_description_event ( ) const

pure virtual

Return a pointer the currently used Format_description_log_event.

The event is a member by this reader, so the caller must not use the returned reference after this reader has been deleted.

Implemented in Basic_binlog_file_reader< IFILE, EVENT_DATA_ISTREAM, EVENT_OBJECT_ISTREAM, ALLOCATOR >, and Basic_binlog_file_reader< Relaylog_ifile, Binlog_event_data_istream, Binlog_event_object_istream, Default_binlog_event_allocator >.

get_error_str()

virtual const char * IBasic_binlog_file_reader::get_error_str ( ) const

pure virtual

Return a string representing the error.

The return value is static memory that is never deallocated.

Implemented in Basic_binlog_file_reader< IFILE, EVENT_DATA_ISTREAM, EVENT_OBJECT_ISTREAM, ALLOCATOR >, and Basic_binlog_file_reader< Relaylog_ifile, Binlog_event_data_istream, Binlog_event_object_istream, Default_binlog_event_allocator >.

get_error_type()

virtual Binlog_read_error::Error_type IBasic_binlog_file_reader::get_error_type ( ) const

pure virtual

Return the type of error.

Implemented in Basic_binlog_file_reader< IFILE, EVENT_DATA_ISTREAM, EVENT_OBJECT_ISTREAM, ALLOCATOR >, and Basic_binlog_file_reader< Relaylog_ifile, Binlog_event_data_istream, Binlog_event_object_istream, Default_binlog_event_allocator >.

has_fatal_error()

virtual bool IBasic_binlog_file_reader::has_fatal_error ( ) const

pure virtual

Return true if there was a previous error.

Implemented in Basic_binlog_file_reader< IFILE, EVENT_DATA_ISTREAM, EVENT_OBJECT_ISTREAM, ALLOCATOR >, and Basic_binlog_file_reader< Relaylog_ifile, Binlog_event_data_istream, Binlog_event_object_istream, Default_binlog_event_allocator >.

operator=() [1/2]

IBasic_binlog_file_reader & IBasic_binlog_file_reader::operator= ( IBasic_binlog_file_reader &&  )

delete

operator=() [2/2]

IBasic_binlog_file_reader & IBasic_binlog_file_reader::operator= ( IBasic_binlog_file_reader &  )

delete

position()

virtual my_off_t IBasic_binlog_file_reader::position ( ) const

pure virtual

Return the current position in bytes, relative to the beginning of the file.

Implemented in Basic_binlog_file_reader< IFILE, EVENT_DATA_ISTREAM, EVENT_OBJECT_ISTREAM, ALLOCATOR >, and Basic_binlog_file_reader< Relaylog_ifile, Binlog_event_data_istream, Binlog_event_object_istream, Default_binlog_event_allocator >.

read_event_object()

virtual Log_event * IBasic_binlog_file_reader::read_event_object ( )

pure virtual

Read the next event from the stream.

This function creates the object with "new". It is the caller's responsibility to delete it.

Returns

Log_event on success, nullptr on error. More information about the error can be found using get_error_type and get_error_str.

Implemented in Basic_binlog_file_reader< IFILE, EVENT_DATA_ISTREAM, EVENT_OBJECT_ISTREAM, ALLOCATOR >, and Basic_binlog_file_reader< Relaylog_ifile, Binlog_event_data_istream, Binlog_event_object_istream, Default_binlog_event_allocator >.

---

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

• sql/binlog_reader.h