ryzom/client/src/net_manager.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 // Copyright (C) 2013  Laszlo KIS-ADAM (dfighter) <dfighter1985@gmail.com>
   7 //
   8 // This program is free software: you can redistribute it and/or modify
   9 // it under the terms of the GNU Affero General Public License as
  10 // published by the Free Software Foundation, either version 3 of the
  11 // License, or (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU Affero General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU Affero General Public License
  19 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20
  21
  22
  23 #ifndef CL_NET_MANAGER_H
  24 #define CL_NET_MANAGER_H
  25
  26 //#define CLIENT_MULTI
  27
  28 /////////////
  29 // INCLUDE //
  30 /////////////
  31 // Misc.
  32 #include "nel/misc/types_nl.h"
  33 // Client.
  34 #include "network_connection.h"
  35 // Game Share
  36 #include "game_share/generic_xml_msg_mngr.h"
  37 #include "game_share/chat_group.h"
  38
  39
  40
  41 //////////////
  42 // FUNCTION //
  43 //////////////
  44 void initializeNetwork();
  45
  46
  47 namespace NLMISC
  48 {
  49         class CBitMemStream;
  50         class CCDBNodeLeaf;
  51 };
  52
  53
  54 ///////////
  55 // CLASS //
  56 ///////////
  57 /**
  58  * Class to manage the network.
  59  * \author Guillaume PUZIN
  60  * \author Nevrax France
  61  * \date 2001
  62  */
  63 class CNetManager : public CNetworkConnection
  64 {
  65 public:
  66         /// Constructor.
  67         CNetManager();
  68
  69         /**
  70          * Updates the whole connection with the frontend.
  71          * Call this method evently.
  72          *
  73          * Behaviour in login state when a firewall does not grant the sending:
  74          * - When a sending is refused (error "Blocking operation interrupted")
  75          * the exception EBlockedByFirewall in thrown. The first time, a time-out is armed.
  76          * - In a later attempt, if the time-out expired, the function sets state to
  77          * Disconnect, then throws EBlockedByFirewall.
  78          *
  79          * \return bool 'true' if data were sent/received.
  80          */
  81         bool update();
  82
  83         bool getConnectionQuality();
  84
  85         /**
  86          * Buffers a bitmemstream, that will be converted into a generic action, to be sent later to the server (at next update).
  87          */
  88         void push (NLMISC::CBitMemStream &msg);
  89
  90         /**
  91          * Buffers a target action
  92          */
  93         void pushTarget(CLFECOMMON::TCLEntityId slot);
  94
  95         /**
  96          * Buffers a pick-up action
  97          */
  98         void pushPickup(CLFECOMMON::TCLEntityId slot, LHSTATE::TLHState lootOrHarvest);
  99
 100         /**
 101          * Send
 102          */
 103         void send(NLMISC::TGameCycle);
 104
 105         /**
 106          * Send last information without changes (only acknowedges frontend)
 107          */
 108         void send();
 109
 110         /**
 111          * Disconnects the current connection
 112          */
 113         void disconnect();
 114
 115         /**
 116          * Reset data and reinit the socket
 117          */
 118         void reinit();
 119
 120         /**
 121          * Waits for server to answer
 122          */
 123         void waitForServer();
 124
 125 #ifdef ENABLE_INCOMING_MSG_RECORDER
 126         /// Start/stop replaying the incoming messages (in offline mode)
 127         void setReplayingMode( bool onOff, const std::string& filename = "");
 128         bool isReplayStarting() const {return _IsReplayStarting;}
 129         void startReplay();
 130
 131 protected:
 132         bool _IsReplayStarting;
 133 #endif
 134
 135         NLMISC::CRefPtr<NLMISC::CCDBNodeLeaf> m_PingLeaf;
 136         NLMISC::CRefPtr<NLMISC::CCDBNodeLeaf> m_UploadLeaf;
 137         NLMISC::CRefPtr<NLMISC::CCDBNodeLeaf> m_DownloadLeaf;
 138         NLMISC::CRefPtr<NLMISC::CCDBNodeLeaf> m_PacketLostLeaf;
 139         NLMISC::CRefPtr<NLMISC::CCDBNodeLeaf> m_ServerStateLeaf;
 140         NLMISC::CRefPtr<NLMISC::CCDBNodeLeaf> m_ConnectionQualityLeaf;
 141 };
 142
 143
 144 //////////////
 145 // FUNCTION //
 146 //////////////
 147 // The impulse callback to receive all msg from the frontend.
 148 void impulseCallBack(NLMISC::CBitMemStream &, sint32 packet, void *arg);
 149
 150 #define ALL_MANAGERS std::vector<CNetManager*>::iterator inm; for( inm=_NetManagers.begin(); inm!=_NetManagers.end(); ++inm ) (*inm)
 151 #define FIRST_MANAGER _NetManagers[0]
 152
 153 /*
 154  *
 155  */
 156 class CNetManagerMulti
 157 {
 158 public:
 159         /// Constructor.
 160         CNetManagerMulti() {}
 161
 162         /// Create the net managers
 163         void    init( const std::string& cookie, const std::string& addr );
 164
 165         /// Destructor
 166         ~CNetManagerMulti() { std::vector<CNetManager*>::iterator inm; for( inm=_NetManagers.begin(); inm!=_NetManagers.end(); ++inm ) delete (*inm); }
 167
 168         /**
 169          * Updates the whole connection with the frontend.
 170          * Call this method evently.
 171          * \return bool : 'true' if data were sent/received.
 172          */
 173         bool update() { ALL_MANAGERS->update(); return true; }
 174
 175         /**
 176          * Buffers a bitmemstream, that will be converted into a generic action, to be sent later to the server (at next update).
 177          */
 178         void push (NLMISC::CBitMemStream &msg) { ALL_MANAGERS->push( msg ); }
 179
 180         /**
 181          * Buffers a target action
 182          */
 183         void pushTarget(CLFECOMMON::TCLEntityId slot) { ALL_MANAGERS->pushTarget( slot ); }
 184
 185         /**
 186          * Buffers a pick-up action
 187          */
 188         void pushPickup(CLFECOMMON::TCLEntityId slot, LHSTATE::TLHState lootOrHarvest) { ALL_MANAGERS->pushPickup( slot, lootOrHarvest ); }
 189
 190         /**
 191          * Send
 192          */
 193         void send(NLMISC::TGameCycle gc) {      ALL_MANAGERS->send( gc ); }
 194
 195         /**
 196          * Send
 197          */
 198         void send() { ALL_MANAGERS->send(); }
 199
 200         /**
 201          * Disconnects the current connection
 202          */
 203         void disconnect() { ALL_MANAGERS->disconnect(); }
 204
 205
 206         /**
 207          * Waits for server to answer
 208          */
 209         void waitForServer() { ALL_MANAGERS->waitForServer(); }
 210
 211 #ifdef ENABLE_INCOMING_MSG_RECORDER
 212         void setRecordingMode( bool onOff, const std::string& filename = "") {}
 213         void setReplayingMode( bool onOff, const std::string& filename = "") {}
 214         bool isReplayStarting() const {return false;}
 215         void startReplay()  {}
 216         bool isRecording() const {return false;}
 217         bool isReplaying() const {return false;}
 218 #endif
 219
 220
 221         NLMISC::TTime           getCurrentClientTime() { return FIRST_MANAGER->getCurrentClientTime(); }                // the time currently played at this frame (in the past)
 222         NLMISC::TGameCycle      getCurrentClientTick() { return FIRST_MANAGER->getCurrentClientTick(); }                // the tick for the current frame (also in the past)
 223         NLMISC::TGameCycle      getCurrentServerTick() { return FIRST_MANAGER->getCurrentServerTick(); }                // the last tick sent by the server.
 224         NLMISC::TTime           getMachineTimeAtTick() { return  FIRST_MANAGER->getMachineTimeAtTick(); }               // the machine time at the beginning of the current tick
 225         NLMISC::TTicks          getMachineTicksAtTick() { return FIRST_MANAGER->getMachineTicksAtTick(); }
 226         sint32                          getMsPerTick() { return FIRST_MANAGER->getMsPerTick(); }
 227         NLMISC::TGameCycle      getSynchronize() { return FIRST_MANAGER->getSynchronize(); }
 228         uint32                          getBestPing() { return FIRST_MANAGER->getBestPing(); }
 229         uint32                          getPing() const { return FIRST_MANAGER->getPing(); }
 230         NLMISC::TTime           getLCT() { return FIRST_MANAGER->getLCT(); }                                                                                    // Lag compensation time
 231         NLMISC::TTime           getUpdateTime() { return FIRST_MANAGER->getUpdateTime(); }
 232         NLMISC::TTicks          getUpdateTicks() { return FIRST_MANAGER->getUpdateTicks(); }
 233         uint32                          getUserId() { return 0; }
 234         const char*                     getConnectionStateCStr() { return ""; }
 235         bool                            getConnectionQuality() { return true; }
 236
 237         // Return an estimated smooth server tick. Increment only and accelerate/decelerate according to network
 238         sint64                          getCurrentSmoothServerTick() const { return FIRST_MANAGER->getCurrentSmoothServerTick(); }
 239         // Convert a GameCycle to a SmoothServerTick
 240         sint32                          convertToSmoothServerTick(NLMISC::TGameCycle t) const { return (sint32)(FIRST_MANAGER->convertToSmoothServerTick(t)); }
 241         // @}
 242
 243         void                            flushSendBuffer() { ALL_MANAGERS->flushSendBuffer(); }
 244         void                            quit() { ALL_MANAGERS->quit(); }
 245
 246         /// Set the Lag Compensation Time in ms (default: 1000)
 247         void                            setLCT( NLMISC::TTime lct ) { ALL_MANAGERS->setLCT( lct ); }
 248
 249         const NLNET::CInetAddress&      getAddress() { return FIRST_MANAGER->getAddress(); }
 250
 251         /// Set player's reference position
 252         void                            setReferencePosition(const NLMISC::CVectorD &position) { ALL_MANAGERS->setReferencePosition( position ); }
 253
 254         const std::vector<CNetworkConnection::CChange>                  &getChanges() { return FIRST_MANAGER->getChanges(); }
 255
 256         //void                                                          clearChanges() { ALL_MANAGERS->clearChanges(); }
 257
 258         void                            setImpulseCallback(CNetworkConnection::TImpulseCallback callback, void *argument = NULL) { FIRST_MANAGER->setImpulseCallback( callback, argument ); }
 259         void                            setDataBase(NLMISC::CCDBNodeBranch *database) { ALL_MANAGERS->setDataBase( database ); }
 260         bool                            connect(std::string &result) { bool res = false; std::vector<CNetManager*>::iterator inm; for( inm=_NetManagers.begin(); inm!=_NetManagers.end(); ++inm ) if ( (*inm)->connect( result ) ) res = true; return res; }
 261         CNetworkConnection::TConnectionState    getConnectionState() const { return FIRST_MANAGER->getConnectionState(); }
 262
 263         float                           getMeanPacketLoss() { return FIRST_MANAGER->getMeanPacketLoss(); }
 264         uint32                          getTotalLostPackets() { return FIRST_MANAGER->getTotalLostPackets(); }
 265         float                           getMeanUpload() { return FIRST_MANAGER->getMeanUpload(); }
 266         float                           getMeanDownload() { return FIRST_MANAGER->getMeanDownload(); }
 267
 268         const NLNET::CLoginCookie&      getLoginCookie() const { return FIRST_MANAGER->getLoginCookie(); }
 269 private:
 270
 271         std::vector<CNetManager*>       _NetManagers;
 272 };
 273
 274 /* ----------------------------
 275  * Access to web, for mail/forum
 276  */
 277
 278 extern uint32                                   ShardId;
 279 extern TSessionId                               CharacterHomeSessionId;
 280 extern std::string                              WebServer;
 281
 282 ////////////
 283 // GLOBAL //
 284 ////////////
 285 #ifdef CLIENT_MULTI
 286 extern CNetManagerMulti                 NetMngr;
 287 #else
 288 extern CNetManager                              NetMngr;
 289 #endif
 290 extern CGenericXmlMsgHeaderManager      GenericMsgHeaderMngr;
 291
 292 extern bool UseFemaleTitles;
 293
 294
 295 #endif // CL_NET_MANAGER_H
 296
 297 /* End of net_manager.h */