SVCS - Русская документация
Загрузка...
Поиск...
Не найдено
Класс svcs::server::cli::HubCommand

Команда для создания центральных репозиториев-хабов для командного сотрудничества. Подробнее...

#include <HubCommand.hxx>

Граф наследования:svcs::server::cli::HubCommand:
svcs::server::cli::ServerBaseCommand svcs::cli::ICommand

Открытые члены

 HubCommand (std::shared_ptr< ISubject > event_bus, std::shared_ptr< RepositoryManager > repository_manager)
 Конструирует HubCommand с необходимыми зависимостями.
 ~HubCommand () override=default
 Деструктор по умолчанию.
std::string getName () const override
 Получает имя команды.
std::string getDescription () const override
 Получает краткое описание назначения команды.
std::string getUsage () const override
 Получает синтаксис использования для команды.
bool execute (const std::vector< std::string > &args) override
 Выполняет команду hub с предоставленными аргументами.
void showHelp () const override
 Отображает справочную информацию для команды hub.
Открытые члены унаследованные от svcs::server::cli::ServerBaseCommand
 ServerBaseCommand (std::shared_ptr< ISubject > event_bus, std::shared_ptr< RepositoryManager > repo_manager)
 Конструирует ServerBaseCommand с необходимыми зависимостями.
virtual ~ServerBaseCommand ()=default
 Виртуальный деструктор для корректной очистки производных классов.
Открытые члены унаследованные от svcs::cli::ICommand
virtual ~ICommand ()=default
 Виртуальный деструктор.

Дополнительные унаследованные члены

Защищенные члены унаследованные от svcs::server::cli::ServerBaseCommand
void notifyInfo (const std::string &message) const
 Отправляет информационное уведомление через шину событий.
void notifyError (const std::string &message) const
 Отправляет уведомление об ошибке через шину событий.
Защищенные данные унаследованные от svcs::server::cli::ServerBaseCommand
std::shared_ptr< ISubjectevent_bus_
 Общий указатель на шину событий для системных уведомлений.
std::shared_ptr< RepositoryManagerrepo_manager_
 Общий указатель на менеджер репозиториев для операций с репозиториями.

Подробное описание

Команда для создания центральных репозиториев-хабов для командного сотрудничества.

Реализует функциональность 'svcs hub' для инициализации голых репозиториев, которые действуют как центральные точки для отправки, получения и совместной работы над кодом. Эта команда необходима для настройки инфраструктуры удаленного сотрудничества. Наследуется от ServerBaseCommand для общей функциональности серверных команд.

Конструктор(ы)

◆ HubCommand()

svcs::server::cli::HubCommand::HubCommand ( std::shared_ptr< ISubject > event_bus,
std::shared_ptr< RepositoryManager > repository_manager )

Конструирует HubCommand с необходимыми зависимостями.

Аргументы
event_busШина событий для системы уведомлений, используется для обратной связи с пользователем.
repository_managerМенеджер репозитория для основных операций с репозиторием.

Методы

◆ execute()

bool svcs::server::cli::HubCommand::execute ( const std::vector< std::string > & args)
overridevirtual

Выполняет команду hub с предоставленными аргументами.

Аргументы
argsАргументы командной строки, переданные команде hub.
Возвращает
bool True если команда выполнена успешно, false в противном случае.
Исключения
std::filesystem_errorЕсли операции файловой системы не удаются.
std::runtime_errorЕсли инициализация репозитория не удается.

Замещает svcs::server::cli::ServerBaseCommand.

◆ getDescription()

std::string svcs::server::cli::HubCommand::getDescription ( ) const
nodiscardoverridevirtual

Получает краткое описание назначения команды.

Возвращает
std::string Описание функциональности команды hub.

Замещает svcs::server::cli::ServerBaseCommand.

◆ getName()

std::string svcs::server::cli::HubCommand::getName ( ) const
nodiscardoverridevirtual

Получает имя команды.

Возвращает
std::string Имя команды "hub".

Замещает svcs::server::cli::ServerBaseCommand.

◆ getUsage()

std::string svcs::server::cli::HubCommand::getUsage ( ) const
nodiscardoverridevirtual

Получает синтаксис использования для команды.

Возвращает
std::string Шаблон использования для команды hub.

Замещает svcs::server::cli::ServerBaseCommand.

◆ showHelp()

void svcs::server::cli::HubCommand::showHelp ( ) const
overridevirtual

Отображает справочную информацию для команды hub.

Показывает примеры использования, описания аргументов и назначение команды для помощи пользователям в правильном использовании команды.

Замещает svcs::server::cli::ServerBaseCommand.


Объявления и описания членов классов находятся в файлах: