MySQL 8.0.39
Source Code Documentation
Binlog_event_object_istream< EVENT_DATA_ISTREAM > Class Template Reference

It reads event_data from an event_data stream and deserialize them to event object. More...

#include <binlog_reader.h>

Public Member Functions

 Binlog_event_object_istream (Binlog_read_error *error, EVENT_DATA_ISTREAM *istream)
 
 Binlog_event_object_istream ()=delete
 
 Binlog_event_object_istream (const Binlog_event_object_istream &)=delete
 
Binlog_event_object_istreamoperator= (const Binlog_event_object_istream &)=delete
 
template<class ALLOCATOR >
Log_eventread_event_object (const Format_description_event &fde, bool verify_checksum, ALLOCATOR *allocator)
 Read an event object from the stream. More...
 

Private Attributes

Binlog_read_errorm_error
 It is convenient for caller to share a Binlog_read_error object between streams. More...
 
EVENT_DATA_ISTREAM * m_data_istream = nullptr
 

Detailed Description

template<class EVENT_DATA_ISTREAM>
class Binlog_event_object_istream< EVENT_DATA_ISTREAM >

It reads event_data from an event_data stream and deserialize them to event object.

Constructor & Destructor Documentation

◆ Binlog_event_object_istream() [1/3]

template<class EVENT_DATA_ISTREAM >
Binlog_event_object_istream< EVENT_DATA_ISTREAM >::Binlog_event_object_istream ( Binlog_read_error error,
EVENT_DATA_ISTREAM *  istream 
)
inline

◆ Binlog_event_object_istream() [2/3]

template<class EVENT_DATA_ISTREAM >
Binlog_event_object_istream< EVENT_DATA_ISTREAM >::Binlog_event_object_istream ( )
delete

◆ Binlog_event_object_istream() [3/3]

template<class EVENT_DATA_ISTREAM >
Binlog_event_object_istream< EVENT_DATA_ISTREAM >::Binlog_event_object_istream ( const Binlog_event_object_istream< EVENT_DATA_ISTREAM > &  )
delete

Member Function Documentation

◆ operator=()

template<class EVENT_DATA_ISTREAM >
Binlog_event_object_istream & Binlog_event_object_istream< EVENT_DATA_ISTREAM >::operator= ( const Binlog_event_object_istream< EVENT_DATA_ISTREAM > &  )
delete

◆ read_event_object()

template<class EVENT_DATA_ISTREAM >
template<class ALLOCATOR >
Log_event * Binlog_event_object_istream< EVENT_DATA_ISTREAM >::read_event_object ( const Format_description_event fde,
bool  verify_checksum,
ALLOCATOR *  allocator 
)
inline

Read an event object from the stream.

Parameters
[in]fdeThe Format_description_event for deserialization.
[in]verify_checksumVerify the checksum of the event_data before
[in]allocatorIt is used to allocate memory for the event data.
Returns
An valid event object if success.
Return values
nullptrError

Member Data Documentation

◆ m_data_istream

template<class EVENT_DATA_ISTREAM >
EVENT_DATA_ISTREAM* Binlog_event_object_istream< EVENT_DATA_ISTREAM >::m_data_istream = nullptr
private

◆ m_error

template<class EVENT_DATA_ISTREAM >
Binlog_read_error* Binlog_event_object_istream< EVENT_DATA_ISTREAM >::m_error
private

It is convenient for caller to share a Binlog_read_error object between streams.

So Binlog_read_error pointer is defined here. It should be initialized in constructor by caller.


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