feat(sdk): create ObservableRoomMessage marker interface

Author: xeruf

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

@@ -3,6 +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.room.ObservableRoomMessage
 import sc.protocol.room.RoomOrchestrationMessage
 
 /**
@@ -17,7 +18,7 @@ data class GameResult(
         val scores: List<PlayerScore>,
         @XStreamImplicit(itemFieldName = "winner")
         val winners: List<Player>?
-): RoomOrchestrationMessage {
+): RoomOrchestrationMessage, ObservableRoomMessage {
 
     val isRegular: Boolean
         get() = scores.all { it.cause == ScoreCause.REGULAR }

sdk/src/server-api/sc/networking/clients/AdminClient.kt

@@ -2,7 +2,7 @@ package sc.networking.clients
 
 import sc.protocol.requests.ObservationRequest
 import sc.protocol.requests.PrepareGameRequest
-import sc.protocol.room.RoomMessage
+import sc.protocol.room.ObservableRoomMessage
 
 class AdminClient(private val client: LobbyClient) {
 
@@ -15,7 +15,7 @@ class AdminClient(private val client: LobbyClient) {
             GameController(roomId, client)
 
     /** Registers [listener] onto the given room. */
-    fun observe(roomId: String, listener: (RoomMessage) -> Unit) {
+    fun observe(roomId: String, listener: (ObservableRoomMessage) -> Unit) {
         client.observeRoom(roomId, listener)
         client.send(ObservationRequest(roomId))
     }

sdk/src/server-api/sc/networking/clients/LobbyClient.java

@@ -32,7 +32,7 @@ public final class LobbyClient extends XStreamClient implements IPollsHistory {
   private final List<ILobbyClientListener> listeners = new ArrayList<>();
   private final List<IHistoryListener> historyListeners = new ArrayList<>();
 
-  private final Map<String, Consumer<RoomMessage>> roomObservers = new HashMap<>();
+  private final Map<String, Consumer<ObservableRoomMessage>> roomObservers = new HashMap<>();
   private Consumer<ResponsePacket> administrativeListener = null;
 
   public LobbyClient(String host, int port) throws IOException {
@@ -47,18 +47,20 @@ protected final void onObject(ProtocolPacket message) {
       RoomPacket packet = (RoomPacket) message;
       String roomId = packet.getRoomId();
       RoomMessage data = packet.getData();
-      roomObservers.getOrDefault(roomId, (m) -> {}).accept(data);
-      if (data instanceof MementoMessage) {
-        onNewState(roomId, ((MementoMessage) data).getState());
-      } else if (data instanceof GameResult) {
-        onGameOver(roomId, (GameResult) data);
-      } else if (data instanceof GamePaused) {
-        onGamePaused(roomId, ((GamePaused) data).getNextPlayer());
-      } else if (data instanceof ErrorMessage) {
-        ErrorMessage error = (ErrorMessage) data;
-        logger.warn("{} in room {}", error.getLogMessage(), roomId);
-        for (IHistoryListener listener : this.historyListeners) {
-          listener.onGameError(roomId, error);
+      if(data instanceof ObservableRoomMessage) {
+        roomObservers.getOrDefault(roomId, (m) -> {}).accept((ObservableRoomMessage) data);
+        if (data instanceof MementoMessage) {
+          onNewState(roomId, ((MementoMessage) data).getState());
+        } else if (data instanceof GameResult) {
+          onGameOver(roomId, (GameResult) data);
+        } else if (data instanceof GamePaused) {
+          onGamePaused(roomId, ((GamePaused) data).getNextPlayer());
+        } else if (data instanceof ErrorMessage) {
+          ErrorMessage error = (ErrorMessage) data;
+          logger.warn("{} in room {}", error.getLogMessage(), roomId);
+          for (IHistoryListener listener : this.historyListeners) {
+            listener.onGameError(roomId, error);
+          }
         }
       } else {
         onRoomMessage(roomId, data);
@@ -197,7 +199,7 @@ public ObservingClient observe(String roomId, boolean isPaused) {
   /** Sets observer to observe messages in the given room.
    * Whether administrative messages are received depends on authentication,
    * which has to be done separately. */
-  public void observeRoom(String roomId, Consumer<RoomMessage> observer) {
+  public void observeRoom(String roomId, Consumer<ObservableRoomMessage> observer) {
     roomObservers.put(roomId, observer);
   }
 

sdk/src/server-api/sc/protocol/room/ErrorMessage.kt

@@ -9,7 +9,7 @@ data class ErrorMessage(
         val originalMessage: RoomMessage,
         @XStreamAsAttribute
         val message: String,
-): RoomOrchestrationMessage {
+): RoomOrchestrationMessage, ObservableRoomMessage {
     val logMessage
         get() = "$originalMessage caused an error: $message"
 }

sdk/src/server-api/sc/protocol/room/GamePaused.kt

@@ -14,4 +14,4 @@ import sc.framework.plugins.Player
 data class GamePaused(
         @XStreamAsAttribute
         val nextPlayer: Player
-): RoomOrchestrationMessage
+): ObservableRoomMessage

sdk/src/server-api/sc/protocol/room/MementoMessage.kt

@@ -10,6 +10,6 @@ import sc.framework.plugins.IPerspectiveProvider
 data class MementoMessage(
         val state: IGameState,
         @XStreamOmitField private val perspective: Any?
-): RoomMessage, IPerspectiveProvider {
+): ObservableRoomMessage, IPerspectiveProvider {
     override fun getPerspective() = perspective
 }

sdk/src/server-api/sc/protocol/room/RoomMessage.kt

@@ -1,8 +1,10 @@
 package sc.protocol.room
 
-/** Implemented by any message sent within a GameRoom. */
+/** A sent within a GameRoom. */
 interface RoomMessage
 
-/** Implemented by any message within a room
- * that does not concern the progress of the game. */
+/** Marks a [RoomMessage] that does not concern the progress of the game. */
 interface RoomOrchestrationMessage: RoomMessage
+
+/** Marks a [RoomMessage] that can be received by observers. */
+interface ObservableRoomMessage: RoomMessage

server/src/sc/server/gaming/GameRoom.java

@@ -154,7 +154,7 @@ public void saveReplay(Writer writer) throws IOException {
   }
 
   /** Send the given message to all Players and Observers in this room. */
-  private void broadcast(RoomMessage message) {
+  private void broadcast(ObservableRoomMessage message) {
     broadcast(createRoomPacket(message));
   }
 
@@ -165,7 +165,7 @@ private void broadcast(ProtocolPacket packet) {
   }
 
   /** Send Message to all registered Observers. */
-  private void observerBroadcast(RoomMessage message) {
+  private void observerBroadcast(ObservableRoomMessage message) {
     observers.forEach(observer -> observer.send(createRoomPacket(message)));
   }