feat(network): create ResponsePacket interface

Author: xeruf

sdk/src/server-api/sc/protocol/ProtocolPacket.kt

@@ -1,3 +1,7 @@
 package sc.protocol
 
+/** Common interface for all packets sent via the XML Protocol. */
 interface ProtocolPacket
+
+/** Interface for all packets sent by the server to clients. */
+interface ResponsePacket : ProtocolPacket

sdk/src/server-api/sc/protocol/responses/ErrorPacket.kt

@@ -3,11 +3,12 @@ package sc.protocol.responses
 import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamAsAttribute
 import sc.protocol.ProtocolPacket
+import sc.protocol.ResponsePacket
 
 /** Response to an erroneous packet, including an error [message]. */
 @XStreamAlias("errorpacket")
 data class ErrorPacket(
         val originalRequest: ProtocolPacket,
         @XStreamAsAttribute
         val message: String,
-): ProtocolPacket
+): ResponsePacket

sdk/src/server-api/sc/protocol/responses/GamePreparedResponse.kt

@@ -3,7 +3,7 @@ package sc.protocol.responses
 import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamAsAttribute
 import com.thoughtworks.xstream.annotations.XStreamImplicit
-import sc.protocol.ProtocolPacket
+import sc.protocol.ResponsePacket
 
 /** Response to [sc.protocol.requests.PrepareGameRequest].
  * @param reservations the reservations for the reserved slots */
@@ -13,4 +13,4 @@ data class GamePreparedResponse(
         val roomId: String,
         @XStreamImplicit(itemFieldName = "reservation")
         val reservations: List<String>
-): ProtocolPacket
+): ResponsePacket

sdk/src/server-api/sc/protocol/responses/JoinedRoomResponse.kt

@@ -2,11 +2,11 @@ package sc.protocol.responses
 
 import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamAsAttribute
-import sc.protocol.ProtocolPacket
+import sc.protocol.ResponsePacket
 
 /** Response to client who successfully joined a game. */
 @XStreamAlias(value = "joined")
 data class JoinedRoomResponse(
         @XStreamAsAttribute
         val roomId: String
-): ProtocolPacket
+): ResponsePacket

sdk/src/server-api/sc/protocol/responses/ObservationResponse.kt

@@ -2,11 +2,11 @@ package sc.protocol.responses
 
 import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamAsAttribute
-import sc.protocol.ProtocolPacket
+import sc.protocol.ResponsePacket
 
 /** Sent to client as response to successfully joining a GameRoom as Observer. */
 @XStreamAlias(value = "observed")
 data class ObservationResponse(
         @XStreamAsAttribute
         val roomId: String
-): ProtocolPacket
+): ResponsePacket

sdk/src/server-api/sc/protocol/responses/PlayerScoreResponse.kt

@@ -2,13 +2,12 @@ package sc.protocol.responses
 
 import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamAsAttribute
-import sc.protocol.ProtocolPacket
-import sc.protocol.requests.ILobbyRequest
+import sc.protocol.ResponsePacket
 import sc.shared.Score
 
 /** Response to GetScoreForPlayerRequest. */
 @XStreamAlias("playerScore")
 data class PlayerScoreResponse(
         @XStreamAsAttribute
         val score: Score
-): ProtocolPacket
+): ResponsePacket

sdk/src/server-api/sc/protocol/responses/RoomWasJoinedEvent.kt

@@ -2,7 +2,7 @@ package sc.protocol.responses
 
 import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamAsAttribute
-import sc.protocol.ProtocolPacket
+import sc.protocol.ResponsePacket
 
 /** Sent to all administrative clients when a player joined a game via a JoinRoomRequest.
  * @param existing whether the joined room has existed beforehand or was newly created. */
@@ -12,4 +12,4 @@ data class RoomWasJoinedEvent(
         val roomId: String,
         @XStreamAsAttribute
         val existing: Boolean
-): ProtocolPacket
+): ResponsePacket

sdk/src/server-api/sc/protocol/responses/TestModeResponse.kt

@@ -2,12 +2,11 @@ package sc.protocol.responses
 
 import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamAsAttribute
-import sc.protocol.ProtocolPacket
-import sc.protocol.requests.ILobbyRequest
+import sc.protocol.ResponsePacket
 
 /** Response to TestModeRequest containing the current status of testMode. */
 @XStreamAlias(value = "testing")
 data class TestModeResponse(
         @XStreamAsAttribute
         val testMode: Boolean
-): ProtocolPacket
+): ResponsePacket