Horizon::Char::CharServer Class Reference

#include <Char.hpp>

Inheritance diagram for Horizon::Char::CharServer:

Collaboration diagram for Horizon::Char::CharServer:

Classes
struct	character_server_configuration

Public Member Functions
	CharServer ()
	Char Constructor. More...
	~CharServer ()
	Char Destructor. More...
bool	read_config ()
	Read /config/char-server.yaml. More...
void	initialize_cli_commands ()
void	initialize () override
void	finalize () override
character_server_configuration &	config ()
TaskScheduler &	getScheduler ()
void	update (uint64_t time)
void	verify_connected_sessions ()
Public Member Functions inherited from Server
	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 ()

Static Public Member Functions
static CharServer *	getInstance ()

Private Types
enum	character_server_type : uint16_t {   CHAR_SERVER_TYPE_NORMAL , CHAR_SERVER_TYPE_MAINTENANCE , CHAR_SERVER_TYPE_OVER18 , CHAR_SERVER_TYPE_PAYING ,   CHAR_SERVER_TYPE_FREE2PLAY , CHAR_SERVER_TYPE_MAX }

Private Attributes
character_server_configuration	_char_server_config
TaskScheduler	_task_scheduler
boost::asio::deadline_timer	_update_timer

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

Member Enumeration Documentation

character_server_type

enum Horizon::Char::CharServer::character_server_type : uint16_t

private

Enumerator
CHAR_SERVER_TYPE_NORMAL
CHAR_SERVER_TYPE_MAINTENANCE
CHAR_SERVER_TYPE_OVER18
CHAR_SERVER_TYPE_PAYING
CHAR_SERVER_TYPE_FREE2PLAY
CHAR_SERVER_TYPE_MAX

{
    CHAR_SERVER_TYPE_NORMAL,
    CHAR_SERVER_TYPE_MAINTENANCE,
    CHAR_SERVER_TYPE_OVER18,
    CHAR_SERVER_TYPE_PAYING,
    CHAR_SERVER_TYPE_FREE2PLAY,
    CHAR_SERVER_TYPE_MAX,
};

Constructor & Destructor Documentation

CharServer()

CharServer::CharServer

(

)

Char Constructor.

: Server(), _update_timer(get_io_context())
{
    //
}

~CharServer()

CharServer::~CharServer

(

)

Char Destructor.

{
    //
}

Member Function Documentation

config()

character_server_configuration & Horizon::Char::CharServer::config ( )

inline

{ return _char_server_config; }

References _char_server_config.

Referenced by initialize(), read_config(), and verify_connected_sessions().

Here is the caller graph for this function:

finalize()

void CharServer::finalize ( )

overridevirtual

Server shutdown routine begins here...

Reimplemented from Server.

{
    HLog(info) << "Shutdown process initiated...";
 
    if (!get_io_context().stopped())
        get_io_context().stop();
 
    Server::finalize();
 
    Server::post_finalize();
}

References Server::finalize(), Kernel::get_io_context(), HLog, and Server::post_finalize().

Referenced by update().

Here is the call graph for this function:

Here is the caller graph for this function:

getInstance()

static CharServer * Horizon::Char::CharServer::getInstance ( )

inlinestatic

    {
        static CharServer instance;
        return &instance;
    }

getScheduler()

TaskScheduler & Horizon::Char::CharServer::getScheduler ( )

inline

{ return _task_scheduler; }

References _task_scheduler.

Referenced by initialize(), and update().

Here is the caller graph for this function:

initialize()

void CharServer::initialize ( )

overridevirtual

Reimplemented from Server.

{
    /* Core Signal Handler  */
    signal(SIGINT, SignalHandler);
    signal(SIGTERM, SignalHandler);
#ifndef WIN32
    signal(SIGQUIT, SignalHandler);
#endif
 
    /* Start Character Network */
    sClientSocketMgr->start(get_io_context(),
                          general_conf().get_listen_ip(),
                          general_conf().get_listen_port(),
                          config().max_network_threads(),
                          general_conf().is_test_run() && general_conf().is_test_run_with_network() == false);
 
    Server::initialize();
 
    getScheduler().Schedule(Seconds(60), [this] (TaskContext context) {
        verify_connected_sessions();
        context.Repeat();
    });
 
    _update_timer.expires_from_now(boost::posix_time::seconds(0));
    _update_timer.async_wait(std::bind(&CharServer::update, this, std::time(nullptr)));
    
    Server::post_initialize();
    
    // Run the io_context until stop is called from the internal, finalizing thread.
    // After stopping, execution will continue through the next line onwards.
    // We actually finalize on this thread and not in any of io_context's internal threads.
    get_io_context().run();
 
    /* Core Cleanup */
    HLog(info) << "Server shutting down...";
    
    HLogShutdown;
 
    set_shutdown_stage(SHUTDOWN_CLEANUP_COMPLETE);
}

References _update_timer, config(), Server::general_conf(), Kernel::get_io_context(), getScheduler(), HLog, HLogShutdown, Server::initialize(), Server::post_initialize(), TaskContext::Repeat(), TaskScheduler::Schedule(), sClientSocketMgr, set_shutdown_stage(), SHUTDOWN_CLEANUP_COMPLETE, SignalHandler(), update(), and verify_connected_sessions().

Here is the call graph for this function:

initialize_cli_commands()

void CharServer::initialize_cli_commands

(

)

{
}

read_config()

bool CharServer::read_config

(

)

Read /config/char-server.yaml.

Returns

true on success false on failure.

Process Configuration that is common between servers.

{
    sol::state lua;
    std::string file_path = general_conf().get_config_file_path().string();
 
    // Read the file. If there is an error, report it and exit.
    try {
        lua.script_file(file_path);
    } catch(const std::exception &e) {
        HLog(error) << "Char::ReadConfig: " << e.what();
        return false;
    }
 
    sol::table tbl = lua["horizon_config"];
 
    try {
        sol::table chtbl = tbl.get<sol::table>("new_character");
        config().set_start_map(chtbl.get_or("start_map", std::string("new_1-1")));
        config().set_start_x(chtbl.get_or("start_x", 53));
        config().set_start_y(chtbl.get_or("start_y", 111));
        config().set_start_zeny(chtbl.get_or("start_zeny", 0));
 
        sol::optional<sol::table> maybe_chitbl = chtbl.get<sol::optional<sol::table>>("start_items");
 
        if (maybe_chitbl) {
            sol::table chitbl = maybe_chitbl.value();
            chitbl.for_each([this](sol::object const &key, sol::object const &value) {
                config().add_start_item(std::make_pair(key.as<int>(), value.as<int>()));
            });
            if (chitbl.size() < 1) {
                config().add_start_item(std::make_pair(1201, 1));
                config().add_start_item(std::make_pair(2301, 1));
            }
        }
    } catch (sol::error &err) {
        HLog(error) << "Error for setting in new_character:" << err.what();
    }
 
    try {
        int char_deletion_time = tbl.get_or("character_deletion_time", 86400);
        config().set_character_deletion_time(char_deletion_time);
        HLog(info) << "Character deletion wait period : '" << char_deletion_time << "'.";
    } catch (sol::error &err) {
        HLog(error) << "Error for setting character_deletion_time:" << err.what();
    }
 
    try {
        bool char_hard_delete = tbl.get_or("character_hard_delete", false);
        config().set_char_hard_delete(char_hard_delete);
        HLog(info) << "Character hard delete (permanently deleted) : '" << (char_hard_delete ? "True" : "False") << "'.";
    } catch (sol::error &err) {
        HLog(error) << "Error for setting character_hard_delete:" << err.what();
    }
 
    try {
        sol::table zone_tbl = tbl.get<sol::table>("zone_server");
        
        std::string ip_addr = zone_tbl.get_or("ip_address", std::string("127.0.0.1"));
        int32_t port = zone_tbl.get_or("port", 5121);
 
        config().set_zone_server_ip(ip_addr);
        config().set_zone_server_port(port);
        HLog(info) << "Zone Server set to '" << config().zone_server_ip() << "' port: " << config().zone_server_port() << ".";
    } catch (sol::error &err) {
        HLog(error) << "Error for setting zone_server:" << err.what();
    }
 
    try {
        int32_t pincode_expiry = tbl.get<int32_t>("pincode_expiry");
        config().set_pincode_expiry(pincode_expiry);
        HLog(info) << "Pincode expiry to '" << config().pincode_expiry() << "'.";
    } catch (sol::error &err) {
        HLog(error) << "Error for setting pincode_expiry:" << err.what();
    }
 
    try {
        int32_t pincode_max_retry = tbl.get<uint32_t>("pincode_max_retry");
        config().set_pincode_max_retry(pincode_max_retry);
        HLog(info) << "Pincode max retry to '" << config().pincode_max_retry() << "'.";
    } catch (sol::error &err) {
        HLog(error) << "Error for setting pincode_max_retry:" << err.what();
    }
 
    try {
        int32_t session_max_timeout = tbl.get_or("session_max_timeout", 60);
        config().set_session_max_timeout(session_max_timeout);
        HLog(info) << "Session maximum timeout set to '" << config().session_max_timeout() << "',"
            << " sessions surpassing this time limit will be disconnected.";
    } catch (sol::error &err) {
        HLog(error) << "Error for setting session_max_timeout:" << err.what();
    }
 
    // Max Network Threads
    try {
        int32_t max_network_threads = tbl.get_or("max_network_threads", 1);
        config().set_max_network_threads(max_network_threads);
        HLog(info) << "Max Network Threads set to '" << config().max_network_threads() << "'.";
    } catch (sol::error &err) {
        HLog(error) << "Error for setting max_network_threads:" << err.what();
    }
 
    if (!parse_common_configs(tbl))
        return false;
 
    HLog(info) << "Done reading server configurations from '" << file_path << "'.";
 
    return true;
}

References Horizon::Char::CharServer::character_server_configuration::add_start_item(), config(), Server::general_conf(), general_server_configuration::get_config_file_path(), HLog, Horizon::Char::CharServer::character_server_configuration::max_network_threads(), Server::parse_common_configs(), Horizon::Char::CharServer::character_server_configuration::pincode_expiry(), Horizon::Char::CharServer::character_server_configuration::pincode_max_retry(), Horizon::Char::CharServer::character_server_configuration::session_max_timeout(), Horizon::Char::CharServer::character_server_configuration::set_char_hard_delete(), Horizon::Char::CharServer::character_server_configuration::set_character_deletion_time(), Horizon::Char::CharServer::character_server_configuration::set_max_network_threads(), Horizon::Char::CharServer::character_server_configuration::set_pincode_expiry(), Horizon::Char::CharServer::character_server_configuration::set_pincode_max_retry(), Horizon::Char::CharServer::character_server_configuration::set_session_max_timeout(), Horizon::Char::CharServer::character_server_configuration::set_start_map(), Horizon::Char::CharServer::character_server_configuration::set_start_x(), Horizon::Char::CharServer::character_server_configuration::set_start_y(), Horizon::Char::CharServer::character_server_configuration::set_start_zeny(), Horizon::Char::CharServer::character_server_configuration::set_zone_server_ip(), Horizon::Char::CharServer::character_server_configuration::set_zone_server_port(), Horizon::Char::CharServer::character_server_configuration::zone_server_ip(), and Horizon::Char::CharServer::character_server_configuration::zone_server_port().

Here is the call graph for this function:

update()

void CharServer::update

(

uint64_t

time

)

Cancel all pending tasks.

Stop all networks

{
    getScheduler().Update();
 
    sClientSocketMgr->manage_sockets(time);
    sClientSocketMgr->update_sessions(time);
    
    if (get_shutdown_stage() == SHUTDOWN_NOT_STARTED && !general_conf().is_test_run_minimal()) {
        _update_timer.expires_from_now(boost::posix_time::microseconds(MAX_CORE_UPDATE_INTERVAL));
        _update_timer.async_wait(std::bind(&CharServer::update, this, std::time(nullptr)));
    } else {
        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_finalized() == true ? "Offline" : "Online (Shutting Down)") << " { CPU: " << i->second.ptr->get_thread_cpu_id() << ", uuid: " << i->first << " }";
        }
        getScheduler().CancelAll();
 
        sClientSocketMgr->stop();
 
        finalize();
    }
}

References Kernel::_components, _update_timer, TaskScheduler::CancelAll(), finalize(), Server::general_conf(), get_shutdown_stage(), getScheduler(), HLog, MAX_CORE_UPDATE_INTERVAL, sClientSocketMgr, SHUTDOWN_NOT_STARTED, TaskScheduler::Update(), and update().

Referenced by initialize(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

verify_connected_sessions()

void CharServer::verify_connected_sessions

(

)

{   
    try {
        std::shared_ptr<boost::mysql::tcp_ssl_connection> conn = sChar->get_database_connection();
        boost::mysql::statement stmt = conn->prepare_statement("DELETE FROM `session_data` WHERE `current_server` = ? AND `last_update` < ?");
        auto b = stmt.bind("C", std::time(nullptr) - config().session_max_timeout());
        boost::mysql::results results;
        conn->execute(b, results);
 
        stmt = conn->prepare_statement("SELECT COUNT(`game_account_id`) FROM `session_data` WHERE `current_server` = ?");
        auto b2 = stmt.bind("C");
        conn->execute(b2, results);
 
        if (results.rows().empty()) {
            HLog(info) << "There are no connected session(s).";
            return;
        }
 
        int32_t count = results.rows()[0][0].as_int64();
 
        HLog(info) << count << " connected session(s).";
 
    }
    catch (boost::mysql::error_with_diagnostics &error) {
        HLog(error) << error.what();
    }
    catch (std::exception& error) {
        HLog(error) << error.what();
    }
}

References config(), GridTypeListIterator::count(), HLog, and sChar.

Referenced by initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_char_server_config

character_server_configuration Horizon::Char::CharServer::_char_server_config

private

Referenced by config().

_task_scheduler

TaskScheduler Horizon::Char::CharServer::_task_scheduler

private

Referenced by getScheduler().

_update_timer

boost::asio::deadline_timer Horizon::Char::CharServer::_update_timer

private

Referenced by initialize(), and update().

---

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

• src/Server/Char/Char.hpp
• src/Server/Char/Char.cpp