MySQL 8.3.0
Source Code Documentation
binlog_storage_iterator.h File Reference
#include <cstdint>
#include <string>
#include <mysql/components/service.h>
#include <mysql/components/services/dynamic_privilege.h>
#include <mysql/plugin_audit_message_types.h>

Go to the source code of this file.

Classes

struct  s_mysql_binlog_storage_iterator
 

Typedefs

typedef struct my_h_binlog_storage_iterator_impmy_h_binlog_storage_iterator
 
typedef struct s_mysql_binlog_storage_iterator mysql_service_binlog_storage_iterator_t
 

Enumerations

enum  Binlog_iterator_service_init_status : uint16_t { kBinlogIteratorInitOk = 0 , kBinlogIteratorIniErrorPurgedGtids , kBinlogIteratorInitErrorLogClosed , kBinlogIteratorInitErrorUnspecified }
 
enum  Binlog_iterator_service_get_status : uint16_t {
  kBinlogIteratorGetOk = 0 , kBinlogIteratorGetEndOfChanges , kBinlogIteratorGetInsufficientBuffer , kBinlogIteratorGetErrorClosed ,
  kBinlogIteratorGetErrorInvalid , kBinlogIteratorGetErrorUnspecified
}
 This enumeration lists the possible return values for the get function. More...
 

Typedef Documentation

◆ my_h_binlog_storage_iterator

◆ mysql_service_binlog_storage_iterator_t

Enumeration Type Documentation

◆ Binlog_iterator_service_get_status

This enumeration lists the possible return values for the get function.

Enumerator
kBinlogIteratorGetOk 

returned when the get operation succeeded.

If the get operation succeeds, this also means that the iterator advances.

kBinlogIteratorGetEndOfChanges 

returned when there are no more entries to get.

The iterator remains open and you can call get on it again. If more content has been created in the meantime, get will get it for you.

kBinlogIteratorGetInsufficientBuffer 

returned whenever the get was called with an insufficient buffer.

The iterator does not advance and the caller can call get again with a larger buffer.

kBinlogIteratorGetErrorClosed 

Returned when there is an unrecoverable error and this iterator has been closed.

The caller still needs to deinitialize the iterator.

kBinlogIteratorGetErrorInvalid 

returned whenever the iterator context is invalid.

The iterator became invalid and therefore it cannot be used successfully from now onwards. I must still be de-initialized to release resources.

kBinlogIteratorGetErrorUnspecified 

returned whenever there was an unspecified error attempting to get the next entry.

In case of an unspecified error, the caller can retry but there is no guarantee whether the retry is successful or not.

◆ Binlog_iterator_service_init_status

Enumerator
kBinlogIteratorInitOk 

Iterator was successfully initialized.

kBinlogIteratorIniErrorPurgedGtids 

Returned when the required GTIDs have already been purged and therefore the iterator cannot fetch the needed entries.

Caller should still call the deinit function on the iterator.

kBinlogIteratorInitErrorLogClosed 

Returned when the log is closed and therefore the iterator cannot get the change entries.

Caller should still call the deinit function on the iterator.

kBinlogIteratorInitErrorUnspecified 

Failure to initialize iterator due to undefined error.

Caller should still call the deinit function on the iterator.