Changeset 7750

Timestamp:

Dec 8, 2010, 7:33:11 PM (13 years ago)

Author:

smerkli

Message:

documentation.

Location:

code/branches/presentation/src/libraries/network

Files:

• MasterServer.cc (modified) (6 diffs)
• MasterServerProtocol.h (modified) (3 diffs)
• Server.cc (modified) (3 diffs)
• WANDiscovery.cc (modified) (2 diffs)
• WANDiscovery.h (modified) (1 diff)

code/branches/presentation/src/libraries/network/MasterServer.cc

@@ -61 +61 @@
         != mainlist.serverlist.end(); ++i ) 
     {
-      /* WORK MARK */
       /* send this particular server */
       /* build reply string */
@@ -88 +87 @@
     } 
 
-    /* send end-of-list packet */
+    /* create end-of-list packet */
     reply = enet_packet_create( MSPROTO_SERVERLIST_END,
         MSPROTO_SERVERLIST_END_LEN + 1,
         ENET_PACKET_FLAG_RELIABLE );
 
+    /* send end-of-list packet */
     enet_peer_send( event->peer, 0, reply );
 
@@ -159 +159 @@
   { /* validate packet */
     if( !event || !(event->packet) || !(event->peer) )
-      //|| !(event->packet->data) || !strlen(event->packet->data) )
     { COUT(2) << "No complete event given.\n";
       return -1;
@@ -168 +167 @@
     enet_address_get_host_ip( &(event->peer->address), addrconv, 49 );
 
-    /* DEBUG */
-    /* output debug info about the data that has come, to be removed */
+    /* output debug info about the data that has come */
     helper_output_debug( event, addrconv );
 
@@ -275 +273 @@
 
     /***** INITIALIZE GAME SERVER AND PEER LISTS *****/
-    //this->mainlist = new ServerList();
     this->peers = new PeerList();
 
@@ -292 +289 @@
     /* clear the list of connected game servers */
     /* clear the list of connected game clients */
-
   }
 

code/branches/presentation/src/libraries/network/MasterServerProtocol.h

@@ -33 +33 @@
 #define MS_ADDRESS "129.132.3.8"
 
+/* Client token (shows that the party sending data is a client */
 #define MSPROTO_CLIENT "CL"
 #define MSPROTO_CLIENT_LEN 2 
 
+/* Request: Serverlist (requiest made from client to master server */
 #define MSPROTO_REQ_LIST "REQ:LIST"
 #define MSPROTO_REQ_LIST_LEN 8
@@ -42 +44 @@
 
 
+/* Game server token (shows that the party sending data is a game server) */
 #define MSPROTO_GAME_SERVER "GS"
 #define MSPROTO_GAME_SERVER_LEN 2
 
+/* Register game server at the master server, meaning request to be taken into$
+ * the master servers game server list.
+ */
 #define MSPROTO_REGISTER_SERVER "REG:SER"
 #define MSPROTO_REGISTER_SERVER_LEN 7
 
+/* Server list item token */
 #define MSPROTO_SERVERLIST_ITEM "SI"
 #define MSPROTO_SERVERLIST_ITEM_LEN 2
+
+/* server list end token */
 #define MSPROTO_SERVERLIST_END "SL_END"
 #define MSPROTO_SERVERLIST_END_LEN 6
@@ -55 +64 @@
 
 
-
-
-
+/* default master server port */
 #define ORX_MSERVER_PORT 55566
 
 
+/* some constants for the networking of the master server, not very important.
+ * play with those if things don't work out well.$
+ */
 #define ORX_MSERVER_MAXCONNS 32
 #define ORX_MSERVER_MAXCHANS 2
 
 
-
-
 #endif /* MASTER_SERVER_PROTO */

code/branches/presentation/src/libraries/network/Server.cc

@@ -101 +101 @@
 
 
-  /* TODO */
+  /** helper that connects to the master server */
   void Server::helper_ConnectToMasterserver()
   {
@@ -173 +173 @@
   { 
     /* handle incoming data */
+    /* TODO this is to be implemented. */
 
     /* done handling, return all ok code 0 */
@@ -180 +181 @@
   void Server::helper_HandleMasterServerRequests()
   { 
+    /* poll the master server for replies and see whether something 
+     * has to be done or changed.
+     */
     this->msc.pollForReply( rephandler ); 
   }

code/branches/presentation/src/libraries/network/WANDiscovery.cc

@@ -47 +47 @@
     COUT(4) << "Creating WANDiscovery.\n";
   
-    /* register object with orxonox main class */
+    /* register object in orxonox */
     RegisterObject(WANDiscovery);
 
-    /* ... and register a config value function for it */
+    /* check for the masterserver address option in orxonox.ini */
     this->setConfigValues();
 
@@ -68 +68 @@
   void WANDiscovery::setConfigValues()
   {
+    /* update msaddress string from orxonox.ini config file, if it 
+     * has changed. 
+     */
     SetConfigValue( msaddress, "localhost");
   } 

code/branches/presentation/src/libraries/network/WANDiscovery.h

@@ -57 +57 @@
       ~WANDiscovery();
 
-      /** get content of msaddress */
+      /** \return Address of the master server
+       * 
+       * Get the master server address 
+       */
       std::string getMSAddress()
       { return this->msaddress; }