Browse Source

Abstrakte KartenServerClient Klasse hinzugefügt

Kolja Strohm 6 years ago
parent
commit
4edc525082
1 changed files with 45 additions and 1 deletions
  1. 45 1
      Include/KSGNetwork.h

+ 45 - 1
Include/KSGNetwork.h

@@ -92,6 +92,7 @@ namespace KSGClient
         virtual SpielHistorieListe *release() = 0;
     };
 
+    // Enthält Informationen zu einem Account
     struct AccountInfo
     {
     protected:
@@ -111,6 +112,7 @@ namespace KSGClient
         virtual AccountInfo *release() = 0;
     };
 
+    // Enthält Informationen zur Aktivität eines Accounts an einem bestimmten Tag
     struct AccountActivityInfo
     {
     protected:
@@ -129,6 +131,7 @@ namespace KSGClient
         virtual AccountActivityInfo *release() = 0;
     };
 
+    // Enthält eine Nachricht, die von Chat Server gesendet wurde
     struct ChatServerNachricht
     {
     protected:
@@ -776,7 +779,48 @@ namespace KSGClient
     //  Kann nur von eingeloggten Clients verwendet werden
     class KartenServerClient
     {
-
+    public:
+        // verbindet sich mit dem zugewiesenen Karten Server
+        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
+        bool verbinde();
+        // lädt eine Karte herunter und speichert sie unter data/tmp/Karten/{id}/spiel
+        //  id: Die Id der Karte
+        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
+        bool downloadKarte( int id );
+        // lädt das Titelbild Karte herunter und speichert es unter data/tmp/Karten/{id}/titel.ltdb
+        //  id: Die Id der Karte
+        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
+        bool downloadKarteTitel( int id );
+        // lädt die Beschreibung Karte herunter und speichert sie unter data/tmp/Karten/{id}/beschreibung.ksgs
+        //  id: Die Id der Karte
+        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
+        bool downloadKarteBeschreibung( int id );
+        // lädt die Minimap Karte herunter und speichert es unter data/tmp/Karten/{id}/minimap.ltdb
+        //  id: Die Id der Karte
+        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
+        bool downloadKarteMinimap( int id );
+        // lädt das Ladebild Karte herunter und speichert es unter data/tmp/Karten/{id}/ladebild.ltdb
+        //  id: Die Id der Karte
+        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
+        bool downloadKarteLadebild( int id );
+        // Erhält die Verbindung aufrecht
+        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
+        //  Sollte während einer bestehenden Verbindung etwa einmal alle 60 Sekunden aufgerufen werden, da sonst der Router die Verbindung automatisch trennt
+        bool keepAlive();
+        // Trennt die Verbindung zum Server
+        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
+        //  Sollte erst nach einem erfolgreichen Aufruf von verbinde aufgerufen werden
+        bool trenne();
+        // Gibt 1 zurück, falls der Client verbunden ist, 0 sonst
+        bool istVerbunden() const;
+        // gibt den Letzten Fehlertext zuück
+        //  sollte erst aufgerufen werden, nachdem eine andere aufgerufene Methode fehlgeschlagen ist
+        char *getLetzterFehler() const;
+        // Erhöht den Reference Counter um 1 un gibt this zurück
+        KartenServerClient *getThis();
+        // Verringert den Reference Counter um 1 und gibt 0 zurück.
+        //  Falls der Reference Counter nach dem Aufruf auf 0 ist löscht sich das Objekt selbst 
+        KartenServerClient *release();
     };
 
     // Wird zum Online Spielen verwendet