ryzom/server/src/patchman_service/service_main.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This program is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU Affero General Public License as
   6 // published by the Free Software Foundation, either version 3 of the
   7 // License, or (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU Affero General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Affero General Public License
  15 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 #ifndef SERVICE_MAIN_H
  18 #define SERVICE_MAIN_H
  19
  20
  21 //-----------------------------------------------------------------------------
  22 // includes
  23 //-----------------------------------------------------------------------------
  24
  25 #include "nel/net/service.h"
  26
  27
  28 //-----------------------------------------------------------------------------
  29 // class CServiceClass
  30 //-----------------------------------------------------------------------------
  31
  32 class CServiceClass : public NLNET::IService
  33 {
  34 public:
  35         // service basics
  36         void init();
  37         bool update();
  38         void release();
  39
  40 private:
  41         // private data
  42         bool _ExitRequested;
  43 };
  44
  45
  46 //-----------------------------------------------------------------------------
  47 // class IScheduledTask
  48 //-----------------------------------------------------------------------------
  49
  50 class IScheduledTask: public NLMISC::CRefCount
  51 {
  52 public:
  53         //-------------------------------------------------------------------------
  54         // virtual dtor...
  55
  56         virtual ~IScheduledTask() {}
  57
  58
  59         //-------------------------------------------------------------------------
  60         // routine that does whatever work this scheduled task is designed for
  61
  62         virtual void execute() =0;
  63 };
  64
  65
  66 //-----------------------------------------------------------------------------
  67 // class CTaskScheduler
  68 //-----------------------------------------------------------------------------
  69
  70 class CTaskScheduler
  71 {
  72 public:
  73         // getter for the singleton instance
  74         static CTaskScheduler& getInstance();
  75
  76         // registration method (task and delay in miliseconds before execution)
  77         void sceduleTask(IScheduledTask* task,NLMISC::TTime delay);
  78
  79         // test method - returns the number of errors found
  80         void update();
  81
  82 private:
  83         // prohibit instantiation because we're a singleton
  84         CTaskScheduler();
  85
  86         // private data
  87         typedef NLMISC::CSmartPtr<IScheduledTask> TScheduledTaskSmartPtr;
  88         struct STask
  89         {
  90                 TScheduledTaskSmartPtr  TaskPtr;
  91                 NLMISC::TTime                   ExecutionTime;
  92         };
  93         typedef std::vector<STask> TTasks;
  94         TTasks _Tasks;          // the current task vector
  95
  96         uint32 _MaxTasks;       // the largest number of tasks that we have had in the task vector at any one time
  97 };
  98
  99
 100 //-----------------------------------------------------------------------------
 101 // class ISelfTestClass
 102 //-----------------------------------------------------------------------------
 103
 104 class ISelfTestClass: public NLMISC::CRefCount
 105 {
 106 public:
 107         //-------------------------------------------------------------------------
 108         // make the dtor virtual...
 109
 110         virtual ~ISelfTestClass() {}
 111
 112
 113         //-------------------------------------------------------------------------
 114         // routine that runs the test - returns _ErrorCount
 115
 116         virtual uint32 runTest() =0;
 117
 118
 119         //-------------------------------------------------------------------------
 120         // init
 121
 122         void init(NLMISC::CLog& errorLog, NLMISC::CLog& progressLog, NLMISC::CLog& verboseLog);
 123
 124
 125         //-------------------------------------------------------------------------
 126         // logging
 127
 128         void errorLog(const char* fmt,...) const;
 129         void progressLog(const char* fmt,...) const;
 130         void verboseLog(const char* fmt,...) const;
 131
 132
 133         //-------------------------------------------------------------------------
 134         // error counter
 135
 136         void addError() const;
 137         uint32 getErrorCount() const;
 138
 139
 140 protected:
 141         //-------------------------------------------------------------------------
 142         // protected data
 143
 144         mutable NLMISC::CLog*   _ErrorLog;
 145         mutable NLMISC::CLog*   _ProgressLog;
 146         mutable NLMISC::CLog*   _VerboseLog;
 147         mutable uint32                  _ErrorCount;
 148 };
 149
 150
 151 //-----------------------------------------------------------------------------
 152 // class CSelfTestRegistry
 153 //-----------------------------------------------------------------------------
 154
 155 class CSelfTestRegistry
 156 {
 157 public:
 158         // getter for the singleton instance
 159         static CSelfTestRegistry& getInstance();
 160
 161         // registration method
 162         void registerTestObject(ISelfTestClass* testObject,const NLMISC::CSString& description);
 163
 164         // test method - returns the number of errors found
 165         uint32 runTests(NLMISC::CLog& errorLog, NLMISC::CLog& progressLog, NLMISC::CLog& verboseLog);
 166
 167 private:
 168         // prohibit instantiation because we're a singleton
 169         CSelfTestRegistry();
 170
 171         // private data
 172         typedef NLMISC::CSmartPtr<ISelfTestClass> TSelfTestClassSmartPtr;
 173         typedef std::map<TSelfTestClassSmartPtr,NLMISC::CSString> TTests; // map from test object pointer to description
 174         TTests _Tests;
 175 };
 176
 177
 178 //-----------------------------------------------------------------------------
 179 // macro REGISTER_SELF_TEST
 180 //-----------------------------------------------------------------------------
 181
 182 #define REGISTER_SELF_TEST(CLASS,DESCRIPTION)\
 183         struct CSelfTestRegisterer_##CLASS\
 184         {\
 185                 CSelfTestRegisterer_##CLASS() { CSelfTestRegistry::getInstance().registerTestObject(new CLASS,DESCRIPTION); }\
 186         } selfTestRegisterer_##CLASS;\
 187
 188
 189 //-----------------------------------------------------------------------------
 190 #endif