Horizon::Zone::ZoneServer Class Reference

#include <Zone.hpp>

Inheritance diagram for Horizon::Zone::ZoneServer:

Collaboration diagram for Horizon::Zone::ZoneServer:

Public Member Functions
	ZoneServer ()
	Zone Main server constructor. More...
	~ZoneServer ()
	Zone Main server destructor. More...
bool	read_config ()
	Read /config/zone-server.yaml. More...
void	initialize ()
void	finalize ()
void	update (int64_t diff)
s_zone_server_configuration &	config ()
s_game_process_configuration &	game_config ()
uint64_t	to_uuid (uint8_t type, uint32_t uid, uint16_t uid2, uint8_t uid3)
void	from_uuid (uint64_t unit_uuid, uint8_t &type, uint32_t &uid, uint16_t &uid2, uint8_t &uid3)
ClientSocketMgr &	get_client_socket_mgr ()
Public Member Functions inherited from Horizon::Zone::ZoneKernel
	ZoneKernel (s_zone_server_configuration &config)
	~ZoneKernel ()
void	initialize ()
void	finalize ()
s_zone_server_configuration &	config ()
void	set_config (s_zone_server_configuration &config)
TaskScheduler &	getScheduler ()
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 ZoneServer *	getInstance ()

Private Attributes
s_zone_server_configuration	_zone_server_config
s_game_process_configuration	_game_process_config
ClientSocketMgr	_client_socket_mgr
boost::asio::deadline_timer	_update_timer

Additional Inherited Members
Protected Attributes inherited from Horizon::Zone::ZoneKernel
TaskScheduler	_task_scheduler
s_zone_server_configuration	_config
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

Constructor & Destructor Documentation

ZoneServer()

ZoneServer::ZoneServer

(

)

Zone Main server constructor.

: ZoneKernel(_zone_server_config), _update_timer(get_io_context())
{
}

~ZoneServer()

ZoneServer::~ZoneServer

(

)

Zone Main server destructor.

{
}

Member Function Documentation

config()

s_zone_server_configuration & Horizon::Zone::ZoneServer::config ( )

inline

{ return _zone_server_config; }

References _zone_server_config.

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

Here is the caller graph for this function:

finalize()

void ZoneServer::finalize ( )

virtual

Reimplemented from Horizon::Zone::ZoneKernel.

{
    HLog(info) << "Server shutdown initiated ...";
    
    if (!get_io_context().stopped())
        get_io_context().stop();
 
    get_component_of_type<Horizon::Zone::ZoneRuntime>(Horizon::System::RUNTIME_RUNTIME)->finalize();
    deregister_component(Horizon::System::RUNTIME_RUNTIME);
 
    for (int i = 0; i < config().max_game_logic_threads(); i++) {
        get_component_of_type<GameLogicProcess>(Horizon::System::RUNTIME_GAMELOGIC, i + 1)->finalize();
        deregister_component(Horizon::System::RUNTIME_GAMELOGIC, i + 1);
    }
    for (int i = 0; i < config().max_persistence_threads(); i++) {
        get_component_of_type<PersistenceManager>(Horizon::System::RUNTIME_PERSISTENCE, i + 1)->finalize();
        deregister_component(Horizon::System::RUNTIME_PERSISTENCE, i + 1);
    }
    for (int i = 0; i < config().max_script_vm_threads(); i++) {
        get_component_of_type<ScriptManager>(Horizon::System::RUNTIME_SCRIPTVM, i + 1)->finalize();
        deregister_component(Horizon::System::RUNTIME_SCRIPTVM, i + 1);
    }
 
    ZoneKernel::finalize();
    
    Server::post_finalize();
}

References config(), Kernel::deregister_component(), Horizon::Zone::ZoneKernel::finalize(), Kernel::get_io_context(), HLog, Horizon::Zone::s_zone_server_configuration::max_game_logic_threads(), Horizon::Zone::s_zone_server_configuration::max_persistence_threads(), Horizon::Zone::s_zone_server_configuration::max_script_vm_threads(), Server::post_finalize(), Horizon::System::RUNTIME_GAMELOGIC, Horizon::System::RUNTIME_PERSISTENCE, Horizon::System::RUNTIME_RUNTIME, and Horizon::System::RUNTIME_SCRIPTVM.

Referenced by update().

Here is the call graph for this function:

Here is the caller graph for this function:

from_uuid()

void ZoneServer::from_uuid	(	uint64_t	unit_uuid,
		uint8_t &	type,
		uint32_t &	uid,
		uint16_t &	uid2,
		uint8_t &	uid3
	)

{
    type = (uint8_t) unit_uuid;
    uid = (uint32_t) (unit_uuid >> 40);
    uid2 = (uint16_t) (unit_uuid >> 8);
    uid3 = (uint8_t) (unit_uuid >> 56);
}

game_config()

s_game_process_configuration & Horizon::Zone::ZoneServer::game_config ( )

inline

{ return _game_process_config; }

References _game_process_config.

Referenced by initialize(), and read_config().

Here is the caller graph for this function:

get_client_socket_mgr()

ClientSocketMgr & Horizon::Zone::ZoneServer::get_client_socket_mgr ( )

inline

{ return _client_socket_mgr; }

References _client_socket_mgr.

Referenced by update().

Here is the caller graph for this function:

getInstance()

static ZoneServer * Horizon::Zone::ZoneServer::getInstance ( )

inlinestatic

    {
        static ZoneServer instance;
        return &instance;
    }

initialize()

void ZoneServer::initialize ( )

virtual

Reimplemented from Horizon::Zone::ZoneKernel.

{
    // Install a signal handler
    signal(SIGINT, SignalHandler);
#ifndef WIN32
    signal(SIGQUIT, SignalHandler);
#endif
    signal(SIGTERM, SignalHandler);
    
    // We declare this here since the responsibility of starting the network is of 
    // the Runtime level. It must remain lower than the kernel, because
    // we're using the kernel's io_context and it will be destroyed after the destruction of
    // the ClientSocketMgr class. This fixes the issue of dangling pointers and memory access violations.
    sZone->get_client_socket_mgr().start(get_io_context(),
                          sZone->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);
    
    // Initialize Runtime
    register_component<Horizon::Zone::ZoneRuntime>(Horizon::System::RUNTIME_RUNTIME, std::make_shared<Horizon::Zone::ZoneRuntime>());
    get_component_of_type<Horizon::Zone::ZoneRuntime>(Horizon::System::RUNTIME_RUNTIME)->initialize();
    
    for (int i = 0; i < config().max_game_logic_threads(); i++) {
        register_component(Horizon::System::RUNTIME_GAMELOGIC, std::make_shared<GameLogicProcess>(game_config()));
        get_component_of_type<GameLogicProcess>(Horizon::System::RUNTIME_GAMELOGIC, i + 1)->initialize(i + 1);
    }
 
    for (int i = 0; i < config().max_script_vm_threads(); i++) {
        register_component(Horizon::System::RUNTIME_SCRIPTVM, std::make_shared<ScriptManager>());
        get_component_of_type<ScriptManager>(Horizon::System::RUNTIME_SCRIPTVM, i + 1)->initialize(i + 1);
    }
 
    for (int i = 0; i < config().max_persistence_threads(); i++) {
        register_component(Horizon::System::RUNTIME_PERSISTENCE, std::make_shared<PersistenceManager>());
        get_component_of_type<PersistenceManager>(Horizon::System::RUNTIME_PERSISTENCE, i + 1)->initialize(i + 1);
    }
 
    _update_timer.expires_from_now(boost::posix_time::microseconds(MAX_CORE_UPDATE_INTERVAL));
    _update_timer.async_wait(boost::bind(&ZoneServer::update, this, std::time(nullptr)));
                          
    ZoneKernel::initialize();
 
    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;
}

References _update_timer, config(), game_config(), Server::general_conf(), Kernel::get_io_context(), HLog, HLogShutdown, Horizon::Zone::ZoneKernel::initialize(), MAX_CORE_UPDATE_INTERVAL, Horizon::Zone::s_zone_server_configuration::max_game_logic_threads(), Horizon::Zone::s_zone_server_configuration::max_persistence_threads(), Horizon::Zone::s_zone_server_configuration::max_script_vm_threads(), Server::post_initialize(), Kernel::register_component(), Horizon::System::RUNTIME_GAMELOGIC, Horizon::System::RUNTIME_PERSISTENCE, Horizon::System::RUNTIME_RUNTIME, Horizon::System::RUNTIME_SCRIPTVM, SignalHandler(), sZone, and update().

Here is the call graph for this function:

read_config()

bool ZoneServer::read_config

(

)

Read /config/zone-server.yaml.

Returns

false on failure, true on success.

Process Configuration that is common between servers.

{
    using namespace std::chrono;
 
    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) << "ZoneMain::ReadConfig: " << e.what() << ".";
        return false;
    }
 
    sol::table tbl = lua["horizon_config"];
 
    config().set_static_db_path(tbl.get_or("static_db_path", std::string("db/")));
    HLog(info) << "Static database path set to " << config().get_static_db_path() << "";
 
    config().set_mapcache_path(tbl.get_or("map_cache_file_path", std::string("db/maps.dat")));
    HLog(info) << "Mapcache file name is set to " << config().get_mapcache_path() << ", it will be read while initializing maps.";
 
    config().set_script_root_path(tbl.get_or("script_root_path", std::string("scripts/")));
    HLog(info) << "Script root path is set to " << config().get_script_root_path() << ", it will be used for all scripting references.";
 
    config().set_session_max_timeout(tbl.get_or("session_max_timeout", 60));
    HLog(info) << "Session maximum timeout set to '" << config().session_max_timeout() << "'.";
 
    config().set_max_network_threads(tbl.get_or("max_network_threads", 1));
    HLog(info) << "Maximum network threads set to '" << config().max_network_threads() << "'.";
 
    config().set_max_game_logic_threads(tbl.get_or("max_game_logic_threads", 1));
    HLog(info) << "Maximum game logic threads set to '" << config().max_game_logic_threads() << "'.";
 
    config().set_max_persistence_threads(tbl.get_or("max_persistence_threads", 1));
    HLog(info) << "Maximum persistence threads set to '" << config().max_persistence_threads() << "'.";
 
    config().set_max_script_vm_threads(tbl.get_or("max_script_vm_threads", 1));
    HLog(info) << "Maximum script VM threads set to '" << config().max_script_vm_threads() << "'.";
 
    game_config().set_natural_heal_hp_interval(tbl.get_or("natural_heal_hp_interval", 6000));
    HLog(info) << "Natural heal HP interval set to '" << game_config().get_natural_heal_hp_interval() << "' milliseconds.";
 
    game_config().set_natural_heal_sp_interval(tbl.get_or("natural_heal_sp_interval", 8000));
    HLog(info) << "Natural heal SP interval set to '" << game_config().get_natural_heal_sp_interval() << "' milliseconds.";
 
    if (!parse_common_configs(tbl))
        return false;
 
    HLog(info) << "Done reading server configurations from '" << file_path << "'.";
 
    return true;
}

References config(), game_config(), Server::general_conf(), general_server_configuration::get_config_file_path(), Horizon::Zone::s_zone_server_configuration::get_mapcache_path(), Horizon::Zone::s_game_process_configuration::get_natural_heal_hp_interval(), Horizon::Zone::s_game_process_configuration::get_natural_heal_sp_interval(), Horizon::Zone::s_zone_server_configuration::get_script_root_path(), Horizon::Zone::s_zone_server_configuration::get_static_db_path(), HLog, Horizon::Zone::s_zone_server_configuration::max_game_logic_threads(), Horizon::Zone::s_zone_server_configuration::max_network_threads(), Horizon::Zone::s_zone_server_configuration::max_persistence_threads(), Horizon::Zone::s_zone_server_configuration::max_script_vm_threads(), Server::parse_common_configs(), Horizon::Zone::s_zone_server_configuration::session_max_timeout(), Horizon::Zone::s_zone_server_configuration::set_mapcache_path(), Horizon::Zone::s_zone_server_configuration::set_max_game_logic_threads(), Horizon::Zone::s_zone_server_configuration::set_max_network_threads(), Horizon::Zone::s_zone_server_configuration::set_max_persistence_threads(), Horizon::Zone::s_zone_server_configuration::set_max_script_vm_threads(), Horizon::Zone::s_game_process_configuration::set_natural_heal_hp_interval(), Horizon::Zone::s_game_process_configuration::set_natural_heal_sp_interval(), Horizon::Zone::s_zone_server_configuration::set_script_root_path(), Horizon::Zone::s_zone_server_configuration::set_session_max_timeout(), and Horizon::Zone::s_zone_server_configuration::set_static_db_path().

Here is the call graph for this function:

to_uuid()

uint64_t ZoneServer::to_uuid	(	uint8_t	type,
		uint32_t	uid,
		uint16_t	uid2,
		uint8_t	uid3
	)

{
    return ((uint64_t)uid3 << 56 | ((uint64_t)uid2 << 8) | ((uint64_t)uid << 40) | (uint64_t) type);
}

update()

void ZoneServer::update

(

int64_t

diff

)

Process Packets.

{
    sZone->get_client_socket_mgr().manage_sockets(diff);
    sZone->get_client_socket_mgr().update_sessions(diff);
 
    // Process Horizon System Routine Queue.
    sZone->system_routine_process_queue();
 
    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(boost::bind(&ZoneServer::update, this, std::time(nullptr)));
        _task_scheduler.Update();
    } 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 << " }";
        }
        // Stop the client socket manager here because the io_context will be stopped later.
        // If this is stopped before the io_context, it will cause a dangling pointer.
        get_client_socket_mgr().stop();
 
        finalize();
    }
}

References Kernel::_components, Horizon::Zone::ZoneKernel::_task_scheduler, _update_timer, finalize(), Server::general_conf(), get_client_socket_mgr(), get_shutdown_stage(), HLog, MAX_CORE_UPDATE_INTERVAL, SHUTDOWN_NOT_STARTED, Horizon::Zone::ClientSocketMgr::stop(), sZone, update(), and TaskScheduler::Update().

Referenced by initialize(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_client_socket_mgr

ClientSocketMgr Horizon::Zone::ZoneServer::_client_socket_mgr

private

Referenced by get_client_socket_mgr().

_game_process_config

s_game_process_configuration Horizon::Zone::ZoneServer::_game_process_config

private

Referenced by game_config().

_update_timer

boost::asio::deadline_timer Horizon::Zone::ZoneServer::_update_timer

private

Referenced by initialize(), and update().

_zone_server_config

s_zone_server_configuration Horizon::Zone::ZoneServer::_zone_server_config

private

Referenced by config().

---

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

• src/Server/Zone/Zone.hpp
• src/Server/Zone/Zone.cpp