Server Class Reference

#include <Server.hpp>

Inheritance diagram for Server:

Collaboration diagram for Server:

Public Member Functions
	Server ()
	~Server ()
void	parse_exec_args (const char *argv[], int argc)
virtual void	initialize ()
virtual void	finalize ()
virtual void	post_initialize ()
virtual void	post_finalize ()
void	print_help ()
struct general_server_configuration &	general_conf ()
bool	parse_common_configs (sol::table &cfg)
std::shared_ptr< boost::mysql::tcp_ssl_connection >	get_database_connection ()
bool	test_database_connection ()
Public Member Functions inherited from Kernel
	Kernel (general_server_configuration &config)
	~Kernel ()
virtual void	initialize ()=0
virtual void	finalize ()=0
virtual void	post_initialize ()=0
virtual void	post_finalize ()=0
struct general_server_configuration &	general_conf ()
template<typename T >
std::shared_ptr< T >	get_component (std::string uuid)
template<typename T >
std::shared_ptr< T >	get_component_of_type (Horizon::System::runtime_module_type type, int segment_number=1)
template<typename T >
void	register_component (Horizon::System::runtime_module_type type, T &&component)
template<typename T >
void	register_component (Horizon::System::runtime_module_type type, std::shared_ptr< T > component)
void	deregister_component (Horizon::System::runtime_module_type type, int segment_number=1)
int	get_registered_component_count_of_type (Horizon::System::runtime_module_type type)
template<typename ComponentType , std::size_t Priority, typename Key , typename Value >
int	get_segment_number_for_resource (Horizon::System::runtime_module_type module_t, Key resource_key, Value resource_not_found_value)
int	get_component_count ()
KernelComponents &	get_components ()
void	system_routine_queue_push (std::shared_ptr< Horizon::System::RuntimeContext > context)
void	system_routine_queue_push (std::shared_ptr< Horizon::System::RuntimeContextChain > context)
void	system_routine_process_queue ()
void	system_routine_register (Horizon::System::runtime_module_type module_t, Horizon::System::runtime_synchronization_method sync_t, std::shared_ptr< Horizon::System::RuntimeContext > context)
Horizon::System::SystemRoutineManager &	get_system_routine_manager ()
boost::asio::io_context &	get_io_context ()
void	set_signal_interrupt_command_line_loop (bool signal)
bool	get_signal_interrupt_command_line_loop ()

Protected Attributes
struct general_server_configuration	general_config
Protected Attributes inherited from Kernel
boost::asio::io_context	_io_context_global
KernelComponents	_components
general_server_configuration	_config

Constructor & Destructor Documentation

Server()

Server::Server

(

)

               : Kernel(general_conf())
{   
    auto now = std::chrono::system_clock::now();
    auto in_time_t = std::chrono::system_clock::to_time_t(now);
 
    HLog(info) << "Copyright (c) https://github.com/horizonxyz/horizon";
    HLog(info) << "Date: " << std::put_time(std::localtime(&in_time_t), "%Y-%m-%d");
    HLog(info) << "Compile CXX Flags: " << _CMAKE_CXX_FLAGS;
    HLog(info) << "Version: " << VER_PRODUCTVERSION_STR;
    HLog(info) << "Last Update: " << _DATE;
    HLog(info) << "Branch: " << _BRANCH;
    HLog(info) << "Copyright: " << VER_LEGALCOPYRIGHT_STR;
    HLog(info) << "Boost Version: v" << (BOOST_VERSION / 100000) << "." << (BOOST_VERSION / 100 % 1000) << "." << (BOOST_VERSION % 100);
    HLog(info) << "Client Information: " << CLIENT_TYPE << " " << PACKET_VERSION;
}

References CLIENT_TYPE, HLog, and PACKET_VERSION.

~Server()

Server::~Server

(

)

{
}

Member Function Documentation

finalize()

void Server::finalize ( )

virtual

Implements Kernel.

Reimplemented in Horizon::Zone::ZoneKernel, Horizon::Zone::ZoneServer, Horizon::Auth::AuthServer, and Horizon::Char::CharServer.

{
    if (!general_conf().is_test_run() && !general_conf().is_test_run_minimal()) {
        get_component_of_type<CommandLineProcess>(Horizon::System::RUNTIME_COMMANDLINE)->finalize();
        deregister_component(Horizon::System::RUNTIME_COMMANDLINE);
    }
    
    get_component_of_type<DatabaseProcess>(Horizon::System::RUNTIME_DATABASE)->finalize();
    deregister_component(Horizon::System::RUNTIME_DATABASE);
}

References Kernel::deregister_component(), general_conf(), Horizon::System::RUNTIME_COMMANDLINE, and Horizon::System::RUNTIME_DATABASE.

Referenced by Horizon::Zone::ZoneKernel::finalize(), Horizon::Auth::AuthServer::finalize(), and Horizon::Char::CharServer::finalize().

Here is the call graph for this function:

Here is the caller graph for this function:

general_conf()

struct general_server_configuration & Server::general_conf ( )

inline

{ return this->general_config; }

References general_config.

Referenced by Horizon::Auth::AuthServer::clicmd_reload_config(), finalize(), initialize(), Horizon::Zone::ZoneServer::initialize(), Horizon::Auth::AuthServer::initialize(), Horizon::Char::CharServer::initialize(), Horizon::Auth::AuthServer::initialize_cli_commands(), parse_common_configs(), parse_exec_args(), Horizon::Auth::AuthServer::read_config(), Horizon::Char::CharServer::read_config(), Horizon::Zone::ZoneServer::read_config(), Horizon::Zone::ZoneServer::update(), Horizon::Auth::AuthServer::update(), and Horizon::Char::CharServer::update().

Here is the caller graph for this function:

get_database_connection()

std::shared_ptr< boost::mysql::tcp_ssl_connection > Server::get_database_connection ( )

inline

    { 
        return get_component_of_type<DatabaseProcess>(Horizon::System::RUNTIME_DATABASE)->get_connection();
    }

References Horizon::System::RUNTIME_DATABASE.

Referenced by Horizon::Auth::AuthServer::clicmd_create_new_account(), Horizon::Auth::AuthServer::clicmd_reset_password(), and test_database_connection().

Here is the caller graph for this function:

initialize()

void Server::initialize ( )

virtual

Initialize Commandline Interface

Implements Kernel.

Reimplemented in Horizon::Zone::ZoneKernel, Horizon::Zone::ZoneServer, Horizon::Auth::AuthServer, and Horizon::Char::CharServer.

{
    if (general_conf().is_test_run() && general_conf().is_test_run_minimal()) {
        HLog(info) << "Command line not supported during test-runs... skipping.";
    } else {
        HLog(info) << "Horizon Command-Line initializing...";
        register_component(Horizon::System::RUNTIME_COMMANDLINE, std::make_shared<CommandLineProcess>(this));
        get_component_of_type<CommandLineProcess>(Horizon::System::RUNTIME_COMMANDLINE)->initialize();
    }
}

References general_conf(), HLog, Kernel::register_component(), and Horizon::System::RUNTIME_COMMANDLINE.

Referenced by Horizon::Zone::ZoneKernel::initialize(), Horizon::Auth::AuthServer::initialize(), and Horizon::Char::CharServer::initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

parse_common_configs()

bool Server::parse_common_configs

(

sol::table &

cfg

)

{
    std::string tmp_string{""};
 
    general_conf().set_listen_ip(tbl.get_or("bind_ip", std::string("127.0.0.1")));
    general_conf().set_listen_port(tbl.get_or("bind_port", 0));
    
    if (general_conf().get_listen_port() == 0) {
        HLog(error) << "Invalid or non-existent configuration for 'bind_port', Halting...";
        return false;
    }
    
    sol::table db_tbl = tbl.get<sol::table>("database_config");
    
    try {
        general_conf().set_db_host(db_tbl.get_or<std::string>("host", "127.0.0.1"));
        general_conf().set_db_user(db_tbl.get_or<std::string>("user", "horizon"));
        general_conf().set_db_database(db_tbl.get_or<std::string>("db", "horizon"));
        general_conf().set_db_pass(db_tbl.get_or<std::string>("pass", "horizon"));
        general_conf().set_db_port(db_tbl.get_or<uint16_t>("port", 33060));
        
        register_component(Horizon::System::RUNTIME_DATABASE, std::make_shared<DatabaseProcess>(this));
        
        get_component_of_type<DatabaseProcess>(Horizon::System::RUNTIME_DATABASE)->initialize(
            get_io_context(),
            1,
            general_conf().get_db_host(), 
            general_conf().get_db_port(), 
            general_conf().get_db_user(), 
            general_conf().get_db_pass(), 
            general_conf().get_db_database());
        
        HLog(info) << "Database tcp://" << general_conf().get_db_user()
            << ":" << general_conf().get_db_pass()
            << "@" << general_conf().get_db_host()
            << ":" << general_conf().get_db_port()
            << "/" << general_conf().get_db_database()
            << (test_database_connection() ? " (connected)" : "(not connected)");
    }
    catch (const boost::mysql::error_with_diagnostics &error) {
        HLog(error) << error.what() << ".";
        return false;
    }
    catch (const std::exception &error) {
        HLog(error) << error.what() << ".";
        return false;
    }
 
    return true;
}

References general_conf(), general_server_configuration::get_db_database(), general_server_configuration::get_db_host(), general_server_configuration::get_db_pass(), general_server_configuration::get_db_port(), general_server_configuration::get_db_user(), Kernel::get_io_context(), HLog, Kernel::register_component(), Horizon::System::RUNTIME_DATABASE, general_server_configuration::set_db_database(), general_server_configuration::set_db_host(), general_server_configuration::set_db_pass(), general_server_configuration::set_db_port(), general_server_configuration::set_db_user(), general_server_configuration::set_listen_ip(), general_server_configuration::set_listen_port(), and test_database_connection().

Referenced by Horizon::Auth::AuthServer::read_config(), Horizon::Char::CharServer::read_config(), and Horizon::Zone::ZoneServer::read_config().

Here is the call graph for this function:

Here is the caller graph for this function:

parse_exec_args()

void Server::parse_exec_args	(	const char *	argv[],
		int	argc
	)

{
    std::string started_with_args;
    for (int i = 1; i < argc; ++i) {
        started_with_args.append(argv[i]).append(" ");
 
        std::string arg(argv[i]);
        std::vector<std::string> separated_args;
        boost::algorithm::split(separated_args, arg, boost::algorithm::is_any_of("="));
        
        if (separated_args.size() == 1) {
            std::string arg = separated_args.at(0);
            if (arg.compare("--test-run") == 0) {
                HLog(info) << "Horizon test mode (without command-line, network) intiated.";
                general_conf().set_test_run(TEST_RUN_MINIMAL);
            } else if (arg.compare("--test-run-with-network") == 0) {
                HLog(info) << "Horizon test mode (with network) intiated.";
                general_conf().set_test_run(TEST_RUN_WITH_NETWORK);
            } else if (arg.compare("--help") == 0) {
                print_help();
            } else if (arg.compare("--version") == 0) {
                HLog(info) << "Version: " << VER_PRODUCTVERSION_STR;
            }
        } else if (separated_args.size() == 0) { 
            HLog(error) << "Horizon started with no command line arguments.";
            print_help();
        } else {
            std::string arg = separated_args.at(0);
            std::string val = separated_args.at(1);
            
            if (arg.compare("--with-config") == 0) {
                HLog(info) << "Loading configurations from '" << val << "'.";
                general_conf().set_config_file_path(val);
                if (!exists(general_conf().get_config_file_path())) {
                    HLog(error) << "Configuration file path '" << val << "' does not exist!";
                    continue;
                }
            }
        }
    }
 
    HLog(info) << "Started with args:" << started_with_args;
}

References general_conf(), HLog, print_help(), general_server_configuration::set_config_file_path(), general_server_configuration::set_test_run(), TEST_RUN_MINIMAL, and TEST_RUN_WITH_NETWORK.

Here is the call graph for this function:

post_finalize()

void Server::post_finalize ( )

virtual

Implements Kernel.

{
    Kernel::post_finalize();
}

References Kernel::post_finalize().

Referenced by Horizon::Zone::ZoneServer::finalize(), Horizon::Auth::AuthServer::finalize(), and Horizon::Char::CharServer::finalize().

Here is the call graph for this function:

Here is the caller graph for this function:

post_initialize()

void Server::post_initialize ( )

virtual

Implements Kernel.

{
    Kernel::post_initialize();
    
    for (auto i = _components.begin(); i != _components.end(); i++) {
        HLog(info) << "Kernel component '" << i->second.ptr->get_type_string()  << " (" << i->second.segment_number << ")': " << (i->second.ptr->is_initialized() == true ? "Online" : "Offline (Starting)") << " { CPU: " << i->second.ptr->get_thread_cpu_id() << ", uuid: " << i->first << " }";
    }
}

References Kernel::_components, HLog, and Kernel::post_initialize().

Referenced by Horizon::Zone::ZoneServer::initialize(), Horizon::Auth::AuthServer::initialize(), and Horizon::Char::CharServer::initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

print_help()

void Server::print_help

(

)

{
    HLog(error) << "usage: <server> [--version] [--help] [--with-config=<file_with_path>]";
}

References HLog.

Referenced by parse_exec_args().

Here is the caller graph for this function:

test_database_connection()

bool Server::test_database_connection

(

)

{
    try {
        const char *sql = "SELECT 'Hello World!'";
        boost::mysql::results result;
        get_database_connection()->execute(sql, result);
        if (result.rows().at(0).at(0).as_string().compare("Hello World!") == 0)
            return true;
    } catch (boost::mysql::error_with_diagnostics &error) {
        HLog(error) << error.what();
    }
    return false;
}

References get_database_connection(), and HLog.

Referenced by parse_common_configs().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

general_config

struct general_server_configuration Server::general_config

protected

Referenced by general_conf().

---

The documentation for this class was generated from the following files:

• src/Server/Common/Server.hpp
• src/Server/Common/Server.cpp