ryzom/server/src/ai_data_service/ai_service.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
  18
  19 #ifndef RYAI_AI_SERVICE_H
  20 #define RYAI_AI_SERVICE_H
  21
  22 #define RYAI_AI_SERVICE_MAX_SERVICES 256
  23
  24
  25 #include "nel/misc/types_nl.h"
  26 #include "nel/net/message.h"
  27 #include "nel/net/unified_network.h"
  28
  29 #include <list>
  30
  31
  32 /*
  33   ---------------------------------------------------------------------------
  34
  35   This class defines both the singleton that manages the ai services and the
  36   class type of the ai services themselves. The singleton interface can be found
  37   at the end of the class
  38
  39   ---------------------------------------------------------------------------
  40 */
  41
  42 class CAIService
  43 {
  44
  45 //===================================================================
  46 //  ***            START OF THE INSTANTIATED CLASS               ***
  47 //===================================================================
  48
  49
  50 public:
  51         //---------------------------------------------------
  52         // INSTANTIATED CLASS: Public methods
  53
  54         // a few read accessors
  55         NLNET::TServiceId id() const;
  56         bool isUp() const;
  57
  58         uint powerCPU() const;
  59         uint powerRAM() const;
  60
  61         // assign a given manager to this service (ie open and run it)
  62         void assignMgr(sint mgrId);
  63
  64         // unassign a manager currently running on this service (ie close it)
  65         void unassignMgr(sint mgrId);
  66
  67         // reassign a manager currently assigned to this service to another service
  68         void reassignMgr(sint mgrId, NLNET::TServiceId serviceId);
  69
  70
  71 private:
  72         //---------------------------------------------------
  73         // INSTANTIATED CLASS: Private methods
  74
  75         CAIService();   // may only be instantiated by the singleton
  76
  77
  78 private:
  79         //---------------------------------------------------
  80         // INSTANTIATED CLASS: Private data
  81
  82         bool _isUp;                             // flag says the service is up
  83
  84         uint _powerCPU;                 // maximum CPU weight allowed on service
  85         uint _powerRAM;                 // maximum RAM weight allowed on service
  86
  87         uint _unusedPowerCPU;   // remaining CPU capacity (after counting weight of running managers)
  88         uint _unusedPowerRAM;   // remaining RAM capacity (after counting weight of running managers)
  89
  90         uint _dataSentCount;    // number of data packets sent to service
  91         uint _dataAckCount;             // number of data acknowledges received from service
  92
  93         // vector of buffers of data that are waiting to be sent to the service
  94         std::list<NLNET::CMessage> _dataToSend;
  95
  96 //===================================================================
  97 //  *** END OF THE INSTANTIATED CLASS *** START OF THE SINGLETON ***
  98 //===================================================================
  99
 100
 101 public:
 102         //---------------------------------------------------
 103         // SINGLETON: Public methods
 104
 105         // get the number of valid handles (ie the maximum number of managers allowed)
 106         static uint maxServices() { return RYAI_AI_SERVICE_MAX_SERVICES; }
 107
 108         // get the number of allocated managers
 109         static uint numServices();
 110
 111         // get a pointer to the manager with given handle (0..maxManagers-1)
 112         static CAIService *getServiceById(NLNET::TServiceId id);
 113
 114         // get a pointer to the manager with given index (0..numManagers-1)
 115         static CAIService *getServiceByIdx(uint idx);
 116
 117         // select a service to assign the manager to and assign it
 118         // if no services are available then the manager is queued until one
 119         // becomes available
 120         // managers opened via this interface are queued back up and re-launched
 121         // if their service goes down
 122         static void openMgr(sint mgrId);
 123
 124         // close a manager (on whichever service its running)
 125         static void closeMgr(sint mgrId);
 126
 127         // update routine called by service_main update every net loop
 128         static void update();
 129
 130 private:
 131         //---------------------------------------------------
 132         // SINGLETON: Private methods
 133
 134
 135 private:
 136         //---------------------------------------------------
 137         // SINGLETON: Private data
 138         static class CAIService _services[RYAI_AI_SERVICE_MAX_SERVICES];
 139
 140
 141 //===================================================================
 142 //  ***                 END OF THE SINGLETON                     ***
 143 //===================================================================
 144
 145 };
 146
 147
 148 #endif