[Orxonox-commit 7374] r11990 - in code/branches/Masterserver_FS18/src/libraries/network: . packet

mdedial at orxonox.net mdedial at orxonox.net
Thu May 24 15:24:01 CEST 2018


Author: mdedial
Date: 2018-05-24 15:24:00 +0200 (Thu, 24 May 2018)
New Revision: 11990

Modified:
   code/branches/Masterserver_FS18/src/libraries/network/ClientConnection.cc
   code/branches/Masterserver_FS18/src/libraries/network/ClientConnection.h
   code/branches/Masterserver_FS18/src/libraries/network/Connection.cc
   code/branches/Masterserver_FS18/src/libraries/network/FunctionCallManager.cc
   code/branches/Masterserver_FS18/src/libraries/network/FunctionCallManager.h
   code/branches/Masterserver_FS18/src/libraries/network/GamestateManager.cc
   code/branches/Masterserver_FS18/src/libraries/network/GamestateManager.h
   code/branches/Masterserver_FS18/src/libraries/network/Host.cc
   code/branches/Masterserver_FS18/src/libraries/network/LANDiscoverable.cc
   code/branches/Masterserver_FS18/src/libraries/network/LANDiscoverable.h
   code/branches/Masterserver_FS18/src/libraries/network/LANDiscovery.cc
   code/branches/Masterserver_FS18/src/libraries/network/MasterServer.cc
   code/branches/Masterserver_FS18/src/libraries/network/MasterServerComm.cc
   code/branches/Masterserver_FS18/src/libraries/network/Server.cc
   code/branches/Masterserver_FS18/src/libraries/network/Server.h
   code/branches/Masterserver_FS18/src/libraries/network/ServerConnection.cc
   code/branches/Masterserver_FS18/src/libraries/network/packet/ClassID.cc
Log:
Clean up code, remove TODOs and dead code.


Modified: code/branches/Masterserver_FS18/src/libraries/network/ClientConnection.cc
===================================================================
--- code/branches/Masterserver_FS18/src/libraries/network/ClientConnection.cc	2018-05-24 13:20:52 UTC (rev 11989)
+++ code/branches/Masterserver_FS18/src/libraries/network/ClientConnection.cc	2018-05-24 13:24:00 UTC (rev 11990)
@@ -104,8 +104,8 @@
       if( enet_host_service(this->host_, &event, NETWORK_CLIENT_WAIT_TIME)>=0 && event.type == ENET_EVENT_TYPE_CONNECT )
       {
         // manually add server to list of peers
-        /*incomingEvent inEvent = */Connection::preprocessConnectEvent(event);
-//         addPeer(inEvent.peerID);
+        Connection::preprocessConnectEvent(event);
+
         // start communication thread
         this->established_=true;
         Connection::startCommunicationThread();
@@ -154,7 +154,6 @@
   void ClientConnection::addPacket(ENetPacket *packet, uint8_t channelID) {
     assert( this->server_ );
     assert( packet );
-//     return Connection::addPacket( packet, NETWORK_PEER_ID_SERVER, channelID );
     // HACK: actually there should be a way to do this using addPacket and the correct peerID
     return Connection::broadcastPacket(packet, channelID);
   }
@@ -167,7 +166,7 @@
   {
     this->established_=false;
     orxout(internal_error, context::network) << "Received disconnect Packet from Server!" << endl;
-        // server closed the connection
+    // server closed the connection
     this->stopCommunicationThread();
     this->connectionClosed();
   }

Modified: code/branches/Masterserver_FS18/src/libraries/network/ClientConnection.h
===================================================================
--- code/branches/Masterserver_FS18/src/libraries/network/ClientConnection.h	2018-05-24 13:20:52 UTC (rev 11989)
+++ code/branches/Masterserver_FS18/src/libraries/network/ClientConnection.h	2018-05-24 13:24:00 UTC (rev 11990)
@@ -43,9 +43,6 @@
     void setServerAddress( const std::string& serverAddress );
     void setPort( unsigned int port );
 
-//     ENetEvent *getEvent();
-    // check wheter the packet queue is empty
-//     bool queueEmpty();
     // create a new listener thread
     virtual bool establishConnection();
     virtual bool closeConnection();

Modified: code/branches/Masterserver_FS18/src/libraries/network/Connection.cc
===================================================================
--- code/branches/Masterserver_FS18/src/libraries/network/Connection.cc	2018-05-24 13:20:52 UTC (rev 11989)
+++ code/branches/Masterserver_FS18/src/libraries/network/Connection.cc	2018-05-24 13:24:00 UTC (rev 11990)
@@ -71,9 +71,6 @@
     // Delete the mutexes
     delete this->incomingEventsMutex_;
     delete this->outgoingEventsMutex_;
-
-    // TODO: Why is enet_deinitialize() not called here?
-    // Would make sense, since its counterpart, enet_initialize(), is called in the constructor.
   }
 
   /**
@@ -171,16 +168,13 @@
       }
       
       // Sleep for 1ms
-      // TODO: Why?
       msleep(1);
       
       // Send all waiting outgoing packets
-      // TODO: Why do we need a mutex to read a single variable?
       this->outgoingEventsMutex_->lock();
       uint32_t outgoingEventsCount = this->outgoingEvents_.size();
       this->outgoingEventsMutex_->unlock();
 
-      // TODO: Not convinced about how mutexes are used here, seems kinda pointless
       while(outgoingEventsCount > 0)
       {
         this->outgoingEventsMutex_->lock();
@@ -405,5 +399,4 @@
     enet_host_compress_with_range_coder( this->host_ );
   }
 
-
 }

Modified: code/branches/Masterserver_FS18/src/libraries/network/FunctionCallManager.cc
===================================================================
--- code/branches/Masterserver_FS18/src/libraries/network/FunctionCallManager.cc	2018-05-24 13:20:52 UTC (rev 11989)
+++ code/branches/Masterserver_FS18/src/libraries/network/FunctionCallManager.cc	2018-05-24 13:24:00 UTC (rev 11990)
@@ -61,11 +61,9 @@
 {
   for (const auto& mapEntry : FunctionCallManager::sPeerMap_ )
   {
-    // TODO: This seems rather pointless, as it wouldn't be called anyways if the map was empty.
     assert(!FunctionCallManager::sPeerMap_.empty());
     mapEntry.second->send(host);
   }
-  // TODO: Why is the map cleared here?
   FunctionCallManager::sPeerMap_.clear();
 }
 

Modified: code/branches/Masterserver_FS18/src/libraries/network/FunctionCallManager.h
===================================================================
--- code/branches/Masterserver_FS18/src/libraries/network/FunctionCallManager.h	2018-05-24 13:20:52 UTC (rev 11989)
+++ code/branches/Masterserver_FS18/src/libraries/network/FunctionCallManager.h	2018-05-24 13:24:00 UTC (rev 11990)
@@ -55,9 +55,6 @@
   // Maps peer IDs to function calls
   static std::map<uint32_t, packet::FunctionCalls*>                           sPeerMap_;
 
-  // TODO: What's up with the pair within the pair?
-  // Vector of pairs
-  // The pair consists of the FunctionCall and another pair, which...
   static std::vector<std::pair<FunctionCall,std::pair<uint32_t, uint32_t>>> sIncomingFunctionCallBuffer_;
 
 protected:

Modified: code/branches/Masterserver_FS18/src/libraries/network/GamestateManager.cc
===================================================================
--- code/branches/Masterserver_FS18/src/libraries/network/GamestateManager.cc	2018-05-24 13:20:52 UTC (rev 11989)
+++ code/branches/Masterserver_FS18/src/libraries/network/GamestateManager.cc	2018-05-24 13:24:00 UTC (rev 11990)
@@ -85,7 +85,7 @@
 
   bool GamestateManager::update()
   {
-    return getSnapshot();
+    return this->getSnapshot();
   }
 
   bool GamestateManager::addGamestate(packet::Gamestate *gs, unsigned int clientID)
@@ -118,8 +118,8 @@
     // now push only the most recent gamestates we received (ignore obsolete ones)
     for(const auto& gsPair : this->gamestateQueue)
     {
-      OrxVerify(processGamestate(gsPair.second), "ERROR: could not process Gamestate");
-      sendAck(gsPair.second->getID(), gsPair.second->getPeerID());
+      OrxVerify(this->processGamestate(gsPair.second), "ERROR: could not process Gamestate");
+      this->sendAck(gsPair.second->getID(), gsPair.second->getPeerID());
       delete gsPair.second;
     }
     // now clear the queue
@@ -213,7 +213,6 @@
     }
 
     std::vector<packet::Gamestate*> peerGamestates;
-    // TODO: mapEntry is an incredibly bad name
     for(const auto& mapEntry : this->peerMap_)
     {
       if(!mapEntry.second.isSynched)
@@ -255,7 +254,6 @@
     // choose whether the next gamestate is the first or not
 
     // Create a copy of the gamestate
-    // TODO: Does this actually create a copy of the gamestate?
     packet::Gamestate *gs = new packet::Gamestate(*gamestate); //this is neccessary because the gamestate are being kept (to diff them later on) for each client seperately
     this->peerMap_[peerID].gamestates[gamestate->getID()] = gs;
 

Modified: code/branches/Masterserver_FS18/src/libraries/network/GamestateManager.h
===================================================================
--- code/branches/Masterserver_FS18/src/libraries/network/GamestateManager.h	2018-05-24 13:20:52 UTC (rev 11989)
+++ code/branches/Masterserver_FS18/src/libraries/network/GamestateManager.h	2018-05-24 13:24:00 UTC (rev 11990)
@@ -110,7 +110,6 @@
   private:
     bool processGamestate(packet::Gamestate *gs);
 
-    // TODO: What is the purpose of the gamestateQueue?
     std::map<unsigned int, packet::Gamestate*> gamestateQueue;
 
     // Each peerID maps to a peerInfo struct

Modified: code/branches/Masterserver_FS18/src/libraries/network/Host.cc
===================================================================
--- code/branches/Masterserver_FS18/src/libraries/network/Host.cc	2018-05-24 13:20:52 UTC (rev 11989)
+++ code/branches/Masterserver_FS18/src/libraries/network/Host.cc	2018-05-24 13:24:00 UTC (rev 11990)
@@ -53,7 +53,6 @@
   {
     Host::instances_s.push_back(this);
 
-    // TODO: What does this do?
     ModifyConsoleCommand(__CC_printRTT_group, __CC_printRTT_name).setObject(this);
 
     this->bIsActive_ = false;

Modified: code/branches/Masterserver_FS18/src/libraries/network/LANDiscoverable.cc
===================================================================
--- code/branches/Masterserver_FS18/src/libraries/network/LANDiscoverable.cc	2018-05-24 13:20:52 UTC (rev 11989)
+++ code/branches/Masterserver_FS18/src/libraries/network/LANDiscoverable.cc	2018-05-24 13:24:00 UTC (rev 11990)
@@ -120,8 +120,6 @@
             info.setServerName(this->ownName);
             info.setClientNumber(this->clientNumber);
             info.send(event.peer);
-//             ENetPacket* packet = enet_packet_create( LAN_DISCOVERY_ACK, strlen(LAN_DISCOVERY_ACK)+1, ENET_PACKET_FLAG_RELIABLE );
-//             enet_peer_send(event.peer, 0, packet );
             enet_host_flush(this->host_);
           }
           break;

Modified: code/branches/Masterserver_FS18/src/libraries/network/LANDiscoverable.h
===================================================================
--- code/branches/Masterserver_FS18/src/libraries/network/LANDiscoverable.h	2018-05-24 13:20:52 UTC (rev 11989)
+++ code/branches/Masterserver_FS18/src/libraries/network/LANDiscoverable.h	2018-05-24 13:24:00 UTC (rev 11990)
@@ -42,8 +42,7 @@
       virtual ~LANDiscoverable();
       void setActivity( bool bActive );
       void update();
-      void updateClientNumber(int clientNumber) {this->clientNumber = clientNumber;}
-;
+      void updateClientNumber(int clientNumber) { this->clientNumber = clientNumber; }
       /** Function used for the configuration file parameter update */
       void setConfigValues();
 

Modified: code/branches/Masterserver_FS18/src/libraries/network/LANDiscovery.cc
===================================================================
--- code/branches/Masterserver_FS18/src/libraries/network/LANDiscovery.cc	2018-05-24 13:20:52 UTC (rev 11989)
+++ code/branches/Masterserver_FS18/src/libraries/network/LANDiscovery.cc	2018-05-24 13:24:00 UTC (rev 11990)
@@ -60,7 +60,6 @@
     memset(&address, 0, sizeof(ENetAddress));
     address.port = LAN_DISCOVERY_PORT;
 
-    /* TODO: check for availability of each protocol */
     /* IPv4 */
     address.host = ENET_HOST_BROADCAST;
     peer = enet_host_connect(this->host_, &address, 0, 0);
@@ -101,8 +100,6 @@
             if( it==this->servers_.end() )
               this->servers_.push_back(info);
           }
-//           enet_address_get_host_ip(&event.peer->address, buffer, buflen );
-//           serverIPs.push_back(std::string(buffer));
           break;
         default:
           break;

Modified: code/branches/Masterserver_FS18/src/libraries/network/MasterServer.cc
===================================================================
--- code/branches/Masterserver_FS18/src/libraries/network/MasterServer.cc	2018-05-24 13:20:52 UTC (rev 11989)
+++ code/branches/Masterserver_FS18/src/libraries/network/MasterServer.cc	2018-05-24 13:24:00 UTC (rev 11990)
@@ -39,7 +39,6 @@
   /* commands for the terminal interface */
   SetConsoleCommand( "ms-listservers", &MasterServer::listServers );
   SetConsoleCommand( "ms-delserver", &MasterServer::delServer );
-  //SetConsoleCommand( "ms-serverinfo", &MasterServer::serverInfo );
 
   /* forward declaration so the linker doesn't complain */
   MasterServer *MasterServer::instance = nullptr;

Modified: code/branches/Masterserver_FS18/src/libraries/network/MasterServerComm.cc
===================================================================
--- code/branches/Masterserver_FS18/src/libraries/network/MasterServerComm.cc	2018-05-24 13:20:52 UTC (rev 11989)
+++ code/branches/Masterserver_FS18/src/libraries/network/MasterServerComm.cc	2018-05-24 13:24:00 UTC (rev 11990)
@@ -37,7 +37,6 @@
   { /* nothing anymore, everything's been outsourced to 
      * the initialize method to facilitate debugging
      */
-    /* register object in orxonox */
   } 
 
   int MasterServerComm::initialize()
@@ -48,10 +47,6 @@
       return 1;
     }
 
-    /* initialize the event holder */
-//     this->event = (ENetEvent *)calloc( sizeof(ENetEvent), 1 );
-    
-
     /* initiate the client */
     this->client = enet_host_create( nullptr /* create a client host */,
         1,
@@ -225,10 +220,6 @@
 
     /* One could just use enet_host_service() instead. */
     enet_host_flush( this->client );
-   
-    /* free the packet */
-    // PLEASE: never do this, because enet will free the packet once it's delivered. this will cause double frees
-//     enet_packet_destroy( packet );
 
     /* all done. */
     return 0;
@@ -247,8 +238,6 @@
 
     /* One could just use enet_host_service() instead. */
     enet_host_flush( this->client );
-    // PLEASE: never do this, because enet will free the packet once it's delivered. this will cause double frees
-//     enet_packet_destroy( packet );
 
     /* all done. */
     return 0;

Modified: code/branches/Masterserver_FS18/src/libraries/network/Server.cc
===================================================================
--- code/branches/Masterserver_FS18/src/libraries/network/Server.cc	2018-05-24 13:20:52 UTC (rev 11989)
+++ code/branches/Masterserver_FS18/src/libraries/network/Server.cc	2018-05-24 13:24:00 UTC (rev 11990)
@@ -166,7 +166,7 @@
       if(timeSinceLastUpdate_ >= NETWORK_PERIOD)
       {
         timeSinceLastUpdate_ -= static_cast<unsigned int>(timeSinceLastUpdate_ / NETWORK_PERIOD) * NETWORK_PERIOD;
-        updateGamestate();
+        this->updateGamestate();
       }
     }
   }
@@ -177,15 +177,6 @@
   }
 
   /**
-   * Return ping time to client in milliseconds.
-   */
-  unsigned int Server::getRTT(unsigned int clientID)
-  {
-    // TODO: Implement
-    return 0;
-  }
-
-  /**
    * Print ping time to client in milliseconds.
    */
   void Server::printRTT()
@@ -194,15 +185,6 @@
   }
 
   /**
-   * Return packet loss ratio to client (scales from 0 to 1).
-   */
-  float Server::getPacketLoss(unsigned int clientID)
-  {
-    // TODO: Implement
-    return 0.;
-  }
-
-  /**
    * Take a new snapshot of the gamestate and send it to the clients.
    */
   void Server::updateGamestate()
@@ -213,8 +195,8 @@
       return;
     }
     GamestateManager::update();
-    sendGameStates();
-    sendObjectDeletes();
+    this->sendGameStates();
+    this->sendObjectDeletes();
   }
 
   /**
@@ -255,9 +237,6 @@
       orxout(internal_warning, context::network) << "Server: could not broadcast deleteObjects packet" << endl;
     }
 
-    // TODO: Possible memory leak?
-    // del is allocated but only deleted if fetchIDs() returns false
-
     return true;
   }
 
@@ -276,7 +255,7 @@
 
     orxout(internal_info, context::network) << "Server: added client id: " << peerID << endl;
 
-    createClient(peerID);
+    this->createClient(peerID);
   }
 
   /**
@@ -297,9 +276,6 @@
       }
     }
 
-    // TODO: What happens if no peer with this ID is found?
-    // Should probably at least log
-
     WANDiscoverable::updateClientNumber(this->clientIDs_.size());
     LANDiscoverable::updateClientNumber(this->clientIDs_.size());
 
@@ -338,7 +314,7 @@
   {
 
     // synchronise class ids
-    syncClassid(clientID);
+    this->syncClassid(clientID);
 
     // now synchronise functionIDs
     packet::FunctionIDs *fIDs = new packet::FunctionIDs();
@@ -345,7 +321,6 @@
     fIDs->setPeerID(clientID);
     bool b = fIDs->send(static_cast<Host*>(this));
     assert(b);
-    // TODO: assert probably isn't the way to go here, as a packet which fails to send will crash the game...
 
     GamestateManager::setSynched(clientID);
 
@@ -355,7 +330,6 @@
     w->setPeerID(clientID);
     b = w->send(static_cast<Host*>(this));
     assert(b);
-    // TODO: assert probably isn't the way to go here, as a packet which fails to send will crash the game...
 
     (void)b; // avoid compiler warning
     return true;
@@ -379,7 +353,7 @@
   void Server::doSendChat(const std::string& message, unsigned int sourceID, unsigned int targetID)
   {
     // check if the target exists. just ignore the message otherwise
-    if (!this->isValidTarget(targetID)) // TODO: remove this if an invalid clientIDs don't trigger assertions anymore
+    if (!this->isValidTarget(targetID))
     {
       return;
     }
@@ -433,7 +407,7 @@
   {
     packet::ClassID *classid = new packet::ClassID();
     classid->setPeerID(clientID);
-    // TODO: Better to do this with a for loop
+
     int failures = 0;
     while(!classid->send(static_cast<Host*>(this)) && failures < 10)\
     {
@@ -440,7 +414,6 @@
       failures++;
     }
     assert(failures<10);
-    // TODO: assert probably isn't the way to go here, as 10 failed packets will crash the game...
     orxout(verbose, context::network) << "syncClassid:\tall synchClassID packets have been sent" << endl;
   }
 

Modified: code/branches/Masterserver_FS18/src/libraries/network/Server.h
===================================================================
--- code/branches/Masterserver_FS18/src/libraries/network/Server.h	2018-05-24 13:20:52 UTC (rev 11989)
+++ code/branches/Masterserver_FS18/src/libraries/network/Server.h	2018-05-24 13:24:00 UTC (rev 11990)
@@ -37,7 +37,6 @@
 #include "util/UtilPrereqs.h"
 #include "core/CorePrereqs.h"
 #include "Host.h"
-// #include "GamestateManager.h"
 #include "ServerConnection.h"
 #include "LANDiscoverable.h"
 #include "WANDiscoverable.h"
@@ -61,19 +60,17 @@
     void open();
     void close();
     virtual void queuePacket(ENetPacket *packet, int clientID, uint8_t channelID) override;
-    virtual bool sendPacket( packet::Packet* packet ) override{ return packet->send( static_cast<Host*>(this) ); }
+    virtual bool sendPacket( packet::Packet* packet ) override { return packet->send( static_cast<Host*>(this) ); }
     void update(const Clock& time);
-    unsigned int getRTT(unsigned int clientID);
     virtual void printRTT() override;
-    float getPacketLoss(unsigned int clientID);
-    int getClientCount() { return this->clientIDs_.size();}
-    std::string getServerName() { return this->serverName_;}
+    int getClientCount() { return this->clientIDs_.size(); }
+    std::string getServerName() { return this->serverName_; }
 
   protected:
     void updateGamestate();
   private:
-    virtual bool isServer_() override{return true;}
-    unsigned int playerID(){return 0;}
+    virtual bool isServer_() override { return true; }
+    unsigned int playerID() { return 0; }
 
     virtual void addPeer(uint32_t peerID) override;
     virtual void removePeer(uint32_t peerID) override;

Modified: code/branches/Masterserver_FS18/src/libraries/network/ServerConnection.cc
===================================================================
--- code/branches/Masterserver_FS18/src/libraries/network/ServerConnection.cc	2018-05-24 13:20:52 UTC (rev 11989)
+++ code/branches/Masterserver_FS18/src/libraries/network/ServerConnection.cc	2018-05-24 13:24:00 UTC (rev 11990)
@@ -38,12 +38,6 @@
 
 namespace orxonox
 {
-
-  // TODO: Calls to the Connection superclass are done as follows:
-  // Connection::startCommunicationThread()
-  // However, these methods are not overridden.
-  // Why can't we just do this->startCommunicationThread()?
-
   /**
    * Constructor
    */
@@ -130,7 +124,7 @@
   bool ServerConnection::closeListener()
   {
     this->bListening_ = false;
-    disconnectClients();
+    this->disconnectClients();
     Connection::stopCommunicationThread();
     enet_host_destroy(this->host_);
     return true;
@@ -141,13 +135,12 @@
    * @param packet The packet to send
    * @param clientID The ID of the recipient
    * @param channelID The channel ID
-   * TODO: Not sure yet how this actually works
    */
   void ServerConnection::addPacket(ENetPacket *packet, unsigned int clientID, uint8_t channelID)
   {
     if (clientID == NETWORK_PEER_ID_BROADCAST)
     {
-      broadcastPacket(packet, channelID);
+      this->broadcastPacket(packet, channelID);
     }
     else
     {

Modified: code/branches/Masterserver_FS18/src/libraries/network/packet/ClassID.cc
===================================================================
--- code/branches/Masterserver_FS18/src/libraries/network/packet/ClassID.cc	2018-05-24 13:20:52 UTC (rev 11989)
+++ code/branches/Masterserver_FS18/src/libraries/network/packet/ClassID.cc	2018-05-24 13:24:00 UTC (rev 11990)
@@ -117,8 +117,6 @@
   return totalsize;
 }
 
-// TODO: This parses the packet and calls ClassByString()
-// However, the resulting Identifier is discarded...
 bool ClassID::process(orxonox::Host* host) {
   int nrOfClasses;
   uint8_t *temp = this->data_ + sizeof(uint32_t); //skip the packetid



More information about the Orxonox-commit mailing list