Clio  develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
MigrationInspectorInterface.hpp
1#pragma once
2
3#include "migration/MigratiorStatus.hpp"
4
5#include <string>
6#include <tuple>
7#include <vector>
8
9namespace migration {
10
16 virtual ~MigrationInspectorInterface() = default;
17
23 [[nodiscard]] virtual std::vector<std::tuple<std::string, MigratorStatus>>
25
31 [[nodiscard]] virtual std::vector<std::string>
32 allMigratorsNames() const = 0;
33
40 [[nodiscard]] virtual MigratorStatus
41 getMigratorStatusByName(std::string const& name) const = 0;
42
49 [[nodiscard]] virtual std::string
50 getMigratorDescriptionByName(std::string const& name) const = 0;
51
57 [[nodiscard]] virtual bool
58 isBlockingClio() const = 0;
59};
60
61} // namespace migration
The status of a migrator, it provides the helper functions to convert the status to string and vice v...
Definition MigratiorStatus.hpp:13
The interface for the migration inspector.The Clio server application will use this interface to insp...
Definition MigrationInspectorInterface.hpp:15
virtual MigratorStatus getMigratorStatusByName(std::string const &name) const =0
Get the status of a migrator by its name.
virtual bool isBlockingClio() const =0
Return if Clio server is blocked.
virtual std::string getMigratorDescriptionByName(std::string const &name) const =0
Get the description of a migrator by its name.
virtual std::vector< std::tuple< std::string, MigratorStatus > > allMigratorsStatusPairs() const =0
Get the status of all the migrators.
virtual std::vector< std::string > allMigratorsNames() const =0
Get all registered migrators' names.