ryzom/client/src/ping.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This source file has been modified by the following contributors:
   5 // Copyright (C) 2013  Jan BOON (Kaetemi) <jan.boon@kaetemi.be>
   6 //
   7 // This program is free software: you can redistribute it and/or modify
   8 // it under the terms of the GNU Affero General Public License as
   9 // published by the Free Software Foundation, either version 3 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU Affero General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU Affero General Public License
  18 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 #ifndef CL_PING_H
  21 #define CL_PING_H
  22
  23 #include <nel/misc/types_nl.h>
  24 #include <nel/misc/cdb.h>
  25
  26 ///////////
  27 // CLASS //
  28 ///////////
  29 /**
  30  * Class to manage the ping computed with the database.
  31  * \author Guillaume PUZIN
  32  * \author Nevrax France
  33  * \date 2003
  34  */
  35 class CPing : public NLMISC::ICDBNode::IPropertyObserver
  36 {
  37 private:
  38         uint32  _Ping;
  39         bool    _RdyToPing;
  40
  41 public:
  42         // Constructor.
  43         CPing() {_Ping = 0; _RdyToPing = true;}
  44         // Destructor.
  45         ~CPing() {;}
  46
  47         // Add an observer on the database for the ping.
  48         void init();
  49
  50         // Release the observer on the database for the ping.
  51         void release();
  52
  53         // Method called when the ping message is back.
  54         virtual void update(NLMISC::ICDBNode* node);
  55
  56         // return the ping in ms.
  57         uint32 getValue() {return _Ping;}
  58
  59         void rdyToPing(bool rdy) {_RdyToPing = rdy;}
  60         bool rdyToPing() const {return _RdyToPing;}
  61 };
  62
  63 #endif // CL_PING_H
  64
  65 /* end of file */