Browse Source

Abstrakte AnmeldungServerClient Klasse hinzugefügt

Kolja Strohm 6 years ago
parent
commit
c3c9f4bdb3
1 changed files with 80 additions and 1 deletions
  1. 80 1
      Include/KSGNetwork.h

+ 80 - 1
Include/KSGNetwork.h

@@ -610,7 +610,86 @@ namespace KSGClient
     //  Kann nur von eingeloggten Clients verwendet werden
     class AnmeldungServerClient
     {
-
+    public:
+        // verbindet sich mit dem zugewiesenen Anmeldung Server
+        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
+        bool verbinde();
+        // erstellt eine gruppe
+        //  karteId: Die Id der Karte für die die Gruppe erstellt werden soll
+        //  Gibt bei Erfolg die Id der Gruppe zurück. Bei misserfolg wird 0 zurückgegeben
+        int gruppeErstellen( int karteId );
+        // Betritt eine Gruppe
+        //  gruppeId: Die Id der Gruppe
+        //  mitglieder: Nach erfolgreichem Aufruf enthält diese Liste die Lister der Account Ids der Gruppenmitglieder
+        //  anzahl: Nach erfolgreichem Aufruf wird hier die Anzahl der Gruppenmitglieder gespeichert
+        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
+        bool gruppeBetreten( int gruppeId, Framework::Array< int > *mitglieder, int *anzahl );
+        // Verlässt eine Gruppe
+        //  gruppeId: Die Id der Gruppe
+        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
+        bool gruppeVerlassen( int gruppeId );
+        // Trägt die Gruppe in die Warteschlange für die Karte ein (nur für den Gruppen Administrator)
+        //  gruppeId: Die Id der Gruppe
+        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
+        bool gruppeAnmelden( int gruppeId );
+        // Trägt die Gruppe aus der Warteschlange für die Karte aus (nur für den Gruppen Administrator)
+        //  gruppeId: Die Id der Gruppe
+        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
+        bool gruppeAbmelden( int gruppeId );
+        // läht Spieler ein die Gruppe zu betreten (nur für den Gruppen Administrator)
+        //  accountId: Die Id des Accounts
+        //  gruppeId: Die Id der Gruppe
+        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
+        bool gruppeSpielerEinladen( int accountId, int gruppeId );
+        // Zieht die Einladung eine Gruppe zu betreten zurück (nur für den Gruppen Administrator)
+        //  accountId: Die Id des Accounts
+        //  gruppeId: Die Id der Gruppe
+        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
+        bool gruppeEinladungAbbrechen( int accountId, int gruppeId );
+        // Einladung zur Gruppe ablehnen
+        //  gruppeId: Die Id der Gruppe
+        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
+        bool gruppeEinladungAblehnen( int gruppeId );
+        // wirft Spieler aus Gruppe (nur für den Gruppen Administrator)
+        //  accountId: Die Id des Accounts
+        //  gruppeId: Die Id der Gruppe
+        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
+        bool kickSpielerAusGruppe( int accountId, int gruppeId );
+        // Legt fest, ob die Spieler in der Gruppe alleine spielen wollen, oder ob weitere Spieler aus der Warteschlange hinzugefügt werden sollen bis die Karte voll ist
+        //  gruppeId: Die Id der Gruppe
+        //  spielStarte: 1:=alleine spielen, 0:=auf volles Spiel warten
+        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
+        bool gruppeSpielStarten( int gruppeId, bool spielStarten );
+        // Sendet eine Nachricht an den Gruppen Chat
+        //  gruppeId: Die Id der Gruppe
+        //  nachricht: Die Nachricht, die gesendet werden soll
+        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
+        bool gruppeNachricht( int gruppeId, char *nachricht );
+        // Meldet den eingeloggten Account in der Warteschlange für eine Karte an
+        //  karteId: Die Id der Karte
+        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
+        bool anmelden( int karteId );
+        // Meldet den eingeloggten Account aus der Warteschlange ab
+        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
+        bool abmelden();
+        // 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
+        AnmeldungServerClient *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 
+        AnmeldungServerClient *release();
     };
 
     // Wird verwendet um die aktuellen versionen der Karten vor dem Spiel herunterzuladen