Diarkis Module

Overview

The Diarkis Runtime Library provides low-level functions, but additional functionality is needed to run an application. The Diarkis Module is a framework that implements the necessary features and convenient functions to easily integrate the Diarkis Runtime Library into an application. The source code is located in the following directory within the package:

diarkis-module

Basic Structure and File Organization

The Diarkis Module is broadly divided into the following four features:

• Diarkis Interface

  • This class manages connections to the Diarkis server and the state needed to use each module for each connection, and an instance is created for each connection to the Diarkis server.

  • Implementation can be found in diarkis-module/Client/Private/DiarkisInterfaceBase.cpp.

• Implementation for Each Module

  • These classes implement the functions corresponding to each module under the name Diarkis"ModuleName"Base, where ModuleName is the name of the module.

  • Users can customize the behavior specific to their application by inheriting and extending this class.

  • Implementation can be found under diarkis-module/Client/Private.

• Logging Functions

  • These functions support log output for the Diarkis Runtime Library and Diarkis Module.

  • Related source code is located in diarkis-module/Client/Private/logging.

• Auxiliary Functions

  • These are auxiliary functions not directly related to Diarkis functionalities, such as regular HTTP access and file operations.

  • Related source code is located in diarkis-module/Client/Private/utils.

Usage of Each Module

To use the functions of each module from the Diarkis Module, refer to the respective module pages below.

• Room Module

• MatchMaker Module

• Field Module

• P2P Module

• DM (Direct Message) Module

• Session Module

• Group Module

How to Use the Diarkis Module

For basic usage of the Diarkis Module and customization methods for each application, refer to the following pages.

• Initialization and Termination of the Diarkis Module

• Customizing the Diarkis Module

• Logging System of the Diarkis Module

• Migration

Resources Used by Diarkis Module

The Diarkis Module internally uses the following resources.

• Diarkis Threads

Notes

• Since Diarkis Module is provided as source code, users can directly modify and customize the code. However, due to changes in implementation from our company, there is a possibility that merging might become difficult during version upgrades. Please be aware of this when using modified versions.

• The API of Diarkis Module is not thread-safe. When using Diarkis Module in multiple threads, ensure that exclusive control is performed on the application side.