1
0
Fork 0
mirror of https://github.com/luanti-org/luanti.git synced 2025-09-30 19:22:14 +00:00

doc comment

This commit is contained in:
Desour 2025-03-24 21:32:15 +01:00
parent 05456059f1
commit 51de8318b0
2 changed files with 16 additions and 2 deletions

View file

@ -13,6 +13,14 @@
class SSCSMEnvironment; class SSCSMEnvironment;
class StupidChannel; class StupidChannel;
/**
* The purpose of this class is to:
* * Be the RAII owner of the SSCSM process.
* * Send events to SSCSM process, and process requests. (`runEvent`)
* * Hide details (e.g. that it is a separate process, or that it has to do IPC calls).
*
* See also SSCSMEnvironment for other side.
*/
class SSCSMController class SSCSMController
{ {
std::unique_ptr<SSCSMEnvironment> m_thread; std::unique_ptr<SSCSMEnvironment> m_thread;

View file

@ -14,8 +14,14 @@
#include "sscsm_irequest.h" #include "sscsm_irequest.h"
#include "../scripting_sscsm.h" #include "../scripting_sscsm.h"
// The thread that runs SSCSM code. /** The thread that runs SSCSM code.
// Meant to be replaced by a sandboxed process. *
* Meant to be replaced by a sandboxed process.
*
* RAII-owns and abstracts away resources to communicate to the main process / thread.
*
* See also SSCSMController for other side.
*/
class SSCSMEnvironment : public Thread class SSCSMEnvironment : public Thread
{ {
std::shared_ptr<StupidChannel> m_channel; std::shared_ptr<StupidChannel> m_channel;