rework(network): protocol message and packet inheritance

Most notably, separate RoomMessage from ProtocolMessage
to indicate what is sent where.

Author: xeruf

helpers/test-client/src/sc/TestClient.java

@@ -9,6 +9,9 @@
 import sc.api.plugins.IGamePlugin;
 import sc.framework.plugins.Player;
 import sc.networking.clients.XStreamClient;
+import sc.protocol.CloseConnection;
+import sc.protocol.ProtocolPacket;
+import sc.protocol.RoomPacket;
 import sc.protocol.requests.*;
 import sc.protocol.responses.*;
 import sc.server.Configuration;
@@ -185,7 +188,7 @@ public TestClient(String host, int port, int totalTests) throws IOException {
   private boolean gameProgressing = false;
 
   @Override
-  protected void onObject(@NotNull ProtocolMessage message) {
+  protected void onObject(@NotNull ProtocolPacket message) {
     if (message == null) {
       logger.warn("Received null message");
       return;

plugin/src/client/sc/plugin2021/AbstractClient.kt

@@ -1,16 +1,15 @@
 package sc.plugin2021
 
 import org.slf4j.LoggerFactory
-import sc.api.plugins.IGamePlugin
 import sc.api.plugins.IGameState
 import sc.framework.plugins.protocol.MoveRequest
 import sc.networking.clients.AbstractLobbyClientListener
 import sc.networking.clients.IControllableGame
 import sc.networking.clients.ILobbyClientListener
 import sc.networking.clients.LobbyClient
+import sc.protocol.RoomMessage
 import sc.protocol.responses.GamePreparedResponse
-import sc.protocol.responses.ProtocolErrorMessage
-import sc.protocol.responses.ProtocolMessage
+import sc.protocol.responses.ErrorMessage
 import sc.shared.GameResult
 import sc.shared.WelcomeMessage
 import java.net.ConnectException
@@ -57,10 +56,14 @@ abstract class AbstractClient(
             client.observe(handle.roomId)
 
     /** Called for any new message sent to the game room, e.g., move requests. */
-    override fun onRoomMessage(roomId: String, data: ProtocolMessage) {
+    override fun onRoomMessage(roomId: String, data: RoomMessage) {
         when(data) {
             is MoveRequest -> handler?.onRequestAction()
             is WelcomeMessage -> team = Team.valueOf(data.color.toUpperCase())
+            is ErrorMessage -> {
+                logger.debug("onError: Client $this received error ${data.message} in $roomId")
+                this.error = data.message
+            }
         }
         this.roomId = roomId
     }
@@ -69,12 +72,6 @@ abstract class AbstractClient(
     fun sendMove(move: Move) =
             client.sendMessageToRoom(roomId, move)
 
-    /** Called when an erroneous message is sent to the room. */
-    override fun onError(roomId: String?, error: ProtocolErrorMessage) {
-        logger.debug("onError: Client $this received error ${error.message} in $roomId")
-        this.error = error.message
-    }
-    
     /**
      * Called when game state has been received.
      * Happens after a client made a move.

plugin/src/server/sc/plugin2021/Game.kt

@@ -8,7 +8,7 @@ import sc.plugin2021.util.Constants
 import sc.plugin2021.util.GameRuleLogic
 import sc.plugin2021.util.MoveMistake
 import sc.plugin2021.util.WinReason
-import sc.protocol.responses.ProtocolMessage
+import sc.protocol.RoomMessage
 import sc.shared.InvalidMoveException
 import sc.shared.PlayerScore
 import sc.shared.ScoreCause
@@ -137,7 +137,7 @@ class Game(override val currentState: GameState = GameState()): AbstractGame<Pla
             ActionTimeout(true, Constants.HARD_TIMEOUT, Constants.SOFT_TIMEOUT)
 
     @Throws(InvalidMoveException::class)
-    override fun onRoundBasedAction(fromPlayer: Player, data: ProtocolMessage) {
+    override fun onRoundBasedAction(fromPlayer: Player, data: RoomMessage) {
         if (data !is Move)
             throw InvalidMoveException(MoveMistake.INVALID_FORMAT)
 

sdk/src/framework/sc/shared/GameResult.kt

@@ -3,7 +3,7 @@ package sc.shared
 import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamImplicit
 import sc.framework.plugins.Player
-import sc.protocol.responses.ProtocolMessage
+import sc.protocol.RoomMessage
 
 /**
  * Das Endergebnis eines Spiels.
@@ -17,7 +17,7 @@ data class GameResult(
         val scores: List<PlayerScore>,
         @XStreamImplicit(itemFieldName = "winner")
         val winners: List<Player>?
-): ProtocolMessage {
+): RoomMessage {
 
     val isRegular: Boolean
         get() = scores.all { it.cause == ScoreCause.REGULAR }

sdk/src/framework/sc/shared/WelcomeMessage.kt

@@ -3,13 +3,13 @@ package sc.shared
 import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamAsAttribute
 import sc.api.plugins.ITeam
-import sc.protocol.responses.ProtocolMessage
+import sc.protocol.RoomMessage
 
 /** Nachricht, die zu Beginn eines Spiels an einen Client geschickt wird, um ihm seine Spielerfarbe mitzuteilen.  */
 @Suppress("DataClassPrivateConstructor")
 @XStreamAlias(value = "welcomeMessage")
 data class WelcomeMessage private constructor(
         @XStreamAsAttribute val color: String
-): ProtocolMessage {
+): RoomMessage {
     constructor(color: ITeam): this(color.name)
 }

sdk/src/server-api/sc/api/plugins/IGameInstance.kt

@@ -4,7 +4,7 @@ import sc.api.plugins.exceptions.GameLogicException
 import sc.api.plugins.exceptions.TooManyPlayersException
 import sc.api.plugins.host.IGameListener
 import sc.framework.plugins.Player
-import sc.protocol.responses.ProtocolMessage
+import sc.protocol.RoomMessage
 import sc.shared.InvalidMoveException
 import sc.shared.PlayerScore
 import sc.shared.ScoreCause
@@ -30,7 +30,7 @@ interface IGameInstance {
      * @throws InvalidMoveException if the received move violates the rules
      */
     @Throws(GameLogicException::class, InvalidMoveException::class)
-    fun onAction(fromPlayer: Player, data: ProtocolMessage)
+    fun onAction(fromPlayer: Player, data: RoomMessage)
     fun addGameListener(listener: IGameListener)
     fun removeGameListener(listener: IGameListener)
 

sdk/src/server-api/sc/api/plugins/IGameState.kt

@@ -1,6 +1,6 @@
 package sc.api.plugins
 
-import sc.protocol.responses.ProtocolMessage
+import sc.protocol.RoomMessage
 
 /**
  * Ein `GameState` beinhaltet alle Informationen, die den Spielstand zu
@@ -25,7 +25,7 @@ import sc.protocol.responses.ProtocolMessage
  *
  * @author Niklas, Sören, Janek
  */
-interface IGameState : ProtocolMessage, Cloneable {
+interface IGameState : RoomMessage, Cloneable {
     /** Aktuelle Zugzahl  */
     val turn: Int
 

sdk/src/server-api/sc/api/plugins/IMove.kt

@@ -1,5 +1,5 @@
 package sc.api.plugins
 
-import sc.protocol.responses.ProtocolMessage
+import sc.protocol.RoomMessage
 
-interface IMove: ProtocolMessage
+interface IMove: RoomMessage

sdk/src/server-api/sc/api/plugins/exceptions/NotYourTurnException.kt

@@ -1,10 +1,10 @@
 package sc.api.plugins.exceptions
 
 import sc.framework.plugins.Player
-import sc.protocol.responses.ProtocolMessage
+import sc.protocol.RoomMessage
 
 data class NotYourTurnException(
         val expected: Player?,
         val actual: Player,
-        val data: ProtocolMessage):
-        GameLogicException("It's not your turn yet; expected: $expected, got $actual (msg was $data).")
+        val data: RoomMessage
+): GameLogicException("It's not your turn yet; expected: $expected, got $actual (msg was $data).")

sdk/src/server-api/sc/api/plugins/host/GameLoader.java

@@ -5,7 +5,7 @@
 import sc.api.plugins.IGameState;
 import sc.networking.clients.GameLoaderClient;
 import sc.networking.clients.IHistoryListener;
-import sc.protocol.responses.ProtocolErrorMessage;
+import sc.protocol.responses.ErrorMessage;
 import sc.shared.GameResult;
 
 import java.io.File;
@@ -68,7 +68,7 @@ public Object loadGame(InputStream file) throws IOException {
   }
 
   @Override
-  public void onGameError(String roomId, ProtocolErrorMessage error) {
+  public void onGameError(String roomId, ErrorMessage error) {
   }
 
   @Override