Diarkis Module
Overview
The Diarkis runtime library provides low-level functionalities, but additional features need to be implemented to operate as an actual application. The Diarkis Module is a framework that implements the necessary features and convenient functions to easily integrate the Diarkis runtime library into applications. The source code is located in the following package:
diarkis-module
Basic Structure and File Organization
The Diarkis Module is broadly divided into the following four functionalities:
Diarkis Interface
This class manages connections to the Diarkis server and the state needed to use each module for each connection, creating an instance for each connection to the Diarkis server.
The implementation can be found at
diarkis-module/Client/Private/DiarkisInterfaceBase.cpp
.
Implementation for Each Module
Classes implementing the module's features corresponding to ModuleName under the name Diarkis"ModuleName"Base.
Users can inherit from this class to customize and implement application-specific behaviors.
The implementation is located under
diarkis-module/Client/Private
.
Logging Related Functions
Features supporting log outputs for the Diarkis runtime library and Diarkis Module.
Relevant source code is placed at
diarkis-module/Client/Private/logging
.
Auxiliary Functions
These are auxiliary functions such as usual HTTP access and file operations that are not directly related to Diarkis features.
Relevant source code is located at
diarkis-module/Client/Private/utils
.
How to Use Each Module
To use the features of each Diarkis module from the Diarkis Module, please refer to the pages for each module below:
Room Module
MatchMaker Module
Field Module
P2P Module
DM (Direct Message) Module
Session Module
Group Module
How to Use Diarkis Module
For the basic usage of the Diarkis Module and how to customize it for each application, please refer to the following pages:
Resources Used by Diarkis Module
The Diarkis Module internally uses the following resources:
Notes
The Diarkis Module is provided in source code form, allowing users to directly modify and customize the code. However, please be aware that significant changes may occur due to company policies, potentially making merging challenging during version upgrades. Use caution if you choose to modify the code.
The API of Diarkis Module is not thread-safe. If using the Diarkis Module in multi-threaded applications, ensure exclusive control is implemented on the application side.
Last updated