mirror of
https://github.com/ddnet/ddnet.git
synced 2024-10-19 07:18:19 +00:00
6cdfa35727
Add `IJob::Abortable(bool)` function which jobs can call to specify whether they can be aborted. Jobs are not abortable per default. Abortable jobs may have their state set to `IJob::STATE_ABORTED` at any point if the job was aborted. The job state should be checked periodically in the `IJob::Run` function and the job should terminate at the earliest, safe opportunity when aborted. Scheduled jobs which are not abortable are guaranteed to fully complete before the job pool is shut down. However, if the job pool is already shutting down, no additional jobs will be enqueue anymore and abortable jobs will immediately be aborted. In particular, the sound loading, community icon loading, master chooser and host lookup jobs are specified as being abortable. Conversely, the jobs saving replay demos, editor maps and screenshots are expected to finish before the client is shut down. When the client is quitting/restarting, it will now disconnect from the current server first, before saving the config, to ensure that any actions that happen on disconnect (demo recorders being stopped etc.) happen first. The shutdown message is rendered before disconnecting and waiting for background jobs to finish. The HTTP client is now initialized later during server launch, after the network initialization. Error handling is added and the server stops if the HTTP client could not be initialized, same as the client. The `RunBlocking` functions are removed, as they are not used anymore after curl-multi was added. The function `IJob::Status` is renamed to `State` and `IJob::STATE_PENDING` is renamed to `STATE_QUEUED` for consistency with naming of the HTTP client. The member variables of the engine interface are encapsulated and the `jobs.h` include is removed from `engine.h`, which removes transitive includes of `system.h`. Documentation for all job and job pool API is added.
31 lines
809 B
C++
31 lines
809 B
C++
/* (c) Magnus Auvinen. See licence.txt in the root of the distribution for more information. */
|
|
/* If you are missing that file, acquire a complete release at teeworlds.com. */
|
|
#ifndef ENGINE_ENGINE_H
|
|
#define ENGINE_ENGINE_H
|
|
|
|
#include "kernel.h"
|
|
|
|
#include <memory>
|
|
|
|
class CFutureLogger;
|
|
class IJob;
|
|
class ILogger;
|
|
|
|
class IEngine : public IInterface
|
|
{
|
|
MACRO_INTERFACE("engine")
|
|
|
|
public:
|
|
virtual ~IEngine() = default;
|
|
|
|
virtual void Init() = 0;
|
|
virtual void AddJob(std::shared_ptr<IJob> pJob) = 0;
|
|
virtual void ShutdownJobs() = 0;
|
|
virtual void SetAdditionalLogger(std::shared_ptr<ILogger> &&pLogger) = 0;
|
|
};
|
|
|
|
extern IEngine *CreateEngine(const char *pAppname, std::shared_ptr<CFutureLogger> pFutureLogger, int Jobs);
|
|
extern IEngine *CreateTestEngine(const char *pAppname, int Jobs);
|
|
|
|
#endif
|