log_handler.h

/* Copyright (c) 2021-2022 OceanBase and/or its affiliates. All rights reserved.
miniob is licensed under Mulan PSL v2.
You can use this software according to the terms and conditions of the Mulan PSL v2.
You may obtain a copy of Mulan PSL v2 at:
         http://license.coscl.org.cn/MulanPSL2
THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
See the Mulan PSL v2 for more details. */
 
//
// Created by wangyunlai on 2024/01/30
//
 
#pragma once
 
#include "common/sys/rc.h"
#include "common/types.h"
#include "common/lang/functional.h"
#include "common/lang/memory.h"
#include "common/lang/span.h"
#include "common/lang/vector.h"
#include "storage/clog/log_module.h"
 
class LogReplayer;
class LogEntry;
 
class LogHandler
{
public:
  LogHandler()          = default;
  virtual ~LogHandler() = default;
 
  virtual RC init(const char *path) = 0;
 
  virtual RC start() = 0;
 
  virtual RC stop() = 0;
 
  virtual RC await_termination() = 0;
 
  virtual RC replay(LogReplayer &replayer, LSN start_lsn) = 0;
 
  virtual RC iterate(function<RC(LogEntry &)> consumer, LSN start_lsn) = 0;
 
  virtual RC append(LSN &lsn, LogModule::Id module, span<const char> data);
  virtual RC append(LSN &lsn, LogModule::Id module, vector<char> &&data);
 
  virtual RC wait_lsn(LSN lsn) = 0;
 
  virtual LSN current_lsn() const = 0;
 
  static RC create(const char *name, LogHandler *&handler);
 
private:
  virtual RC _append(LSN &lsn, LogModule module, vector<char> &&data) = 0;
};