migration::MigrationInspectorInterface Struct Reference

The interface for the migration inspector.The Clio server application will use this interface to inspect the migration status. More...

#include <MigrationInspectorInterface.hpp>

Inheritance diagram for migration::MigrationInspectorInterface:

Public Member Functions
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.
virtual MigratorStatus	getMigratorStatusByName (std::string const &name) const =0
	Get the status of a migrator by its name.
virtual std::string	getMigratorDescriptionByName (std::string const &name) const =0
	Get the description of a migrator by its name.
virtual bool	isBlockingClio () const =0
	Return if Clio server is blocked.

Detailed Description

The interface for the migration inspector.The Clio server application will use this interface to inspect the migration status.

Member Function Documentation

allMigratorsNames()

virtual std::vector< std::string > migration::MigrationInspectorInterface::allMigratorsNames ( ) const

pure virtual

Get all registered migrators' names.

Returns

A vector of migrators' names

Implemented in migration::impl::MigrationInspectorBase< SupportedMigrators >.

allMigratorsStatusPairs()

virtual std::vector< std::tuple< std::string, MigratorStatus > > migration::MigrationInspectorInterface::allMigratorsStatusPairs ( ) const

pure virtual

Get the status of all the migrators.

Returns

A vector of tuple, the first element is the migrator's name, the second element is the status of the

Implemented in migration::impl::MigrationInspectorBase< SupportedMigrators >.

getMigratorDescriptionByName()

virtual std::string migration::MigrationInspectorInterface::getMigratorDescriptionByName ( std::string const & name ) const

pure virtual

Get the description of a migrator by its name.

Parameters

name	The migrator's name

Returns

The description of the migrator

Implemented in migration::impl::MigrationInspectorBase< SupportedMigrators >.

getMigratorStatusByName()

virtual MigratorStatus migration::MigrationInspectorInterface::getMigratorStatusByName ( std::string const & name ) const

pure virtual

Get the status of a migrator by its name.

Parameters

name	The migrator's name

Returns

The status of the migrator

Implemented in migration::impl::MigrationInspectorBase< SupportedMigrators >.

isBlockingClio()

virtual bool migration::MigrationInspectorInterface::isBlockingClio ( ) const

pure virtual

Return if Clio server is blocked.

Returns

True if Clio server is blocked by migration, false otherwise

Implemented in migration::impl::MigrationInspectorBase< SupportedMigrators >.

---

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

• /__w/clio/clio/src/migration/MigrationInspectorInterface.hpp