Configuration now can not be modified after game starts

Author: dgant

src/main/java/bwapi/BWClient.java

@@ -91,7 +91,7 @@ public void startGame(boolean autoContinue) {
      * @param gameConfiguration Settings for playing games with this client.
      */
     public void startGame(BWClientConfiguration gameConfiguration) {
-        gameConfiguration.validate();
+        gameConfiguration.validateAndLock();
         this.configuration = gameConfiguration;
         this.performanceMetrics = new PerformanceMetrics(configuration);
         botWrapper = new BotWrapper(configuration, eventListener);

src/main/java/bwapi/BWClientConfiguration.java

@@ -9,6 +9,7 @@ public class BWClientConfiguration {
      * Set to `true` for more explicit error messages (which might spam the terminal).
      */
     public BWClientConfiguration withDebugConnection(boolean value) {
+        throwIfLocked();
         debugConnection = value;
         return this;
     }
@@ -21,6 +22,7 @@ boolean getDebugConnection() {
      * When true, restarts the client loop when a game ends, allowing the client to play multiple games without restarting.
      */
     public BWClientConfiguration withAutoContinue(boolean value) {
+        throwIfLocked();
         autoContinue = value;
         return this;
     }
@@ -38,6 +40,7 @@ boolean getAutoContinue() {
      * Asynchronous operation will block until the bot's event handlers are complete.
      */
     public BWClientConfiguration withUnlimitedFrameZero(boolean value) {
+        throwIfLocked();
         unlimitedFrameZero = value;
         return this;
     }
@@ -53,6 +56,7 @@ boolean getUnlimitedFrameZero() {
      * Real-time human play typically uses the "fastest" game speed, which has 42.86ms (42,860ns) between frames.
      */
     public BWClientConfiguration withMaxFrameDurationMs(int value) {
+        throwIfLocked();
         maxFrameDurationMs = value;
         return this;
     }
@@ -73,6 +77,7 @@ int getMaxFrameDurationMs() {
      * issuing commands later than intended, and a marginally larger memory footprint.
      */
     public BWClientConfiguration withAsync(boolean value) {
+        throwIfLocked();
         async = value;
         return this;
     }
@@ -86,6 +91,7 @@ boolean getAsync() {
      * Each frame buffered adds about 33 megabytes to JBWAPI's memory footprint.
      */
     public BWClientConfiguration withAsyncFrameBufferCapacity(int size) {
+        throwIfLocked();
         asyncFrameBufferCapacity = size;
         return this;
     }
@@ -102,6 +108,7 @@ int getAsyncFrameBufferCapacity() {
      * the non-thread-safe switc from shared memory reads to frame buffer reads.
      */
     public BWClientConfiguration withAsyncUnsafe(boolean value) {
+        throwIfLocked();
         asyncUnsafe = value;
         return this;
     }
@@ -114,6 +121,7 @@ boolean getAsyncUnsafe() {
      * Toggles verbose logging, particularly of synchronization steps.
      */
     public BWClientConfiguration withLogVerbosely(boolean value) {
+        throwIfLocked();
         logVerbosely = value;
         return this;
     }
@@ -125,7 +133,7 @@ boolean getLogVerbosely() {
     /**
      * Checks that the configuration is in a valid state. Throws an IllegalArgumentException if it isn't.
      */
-    void validate() {
+    void validateAndLock() {
         if (asyncUnsafe && ! async) {
             throw new IllegalArgumentException("asyncUnsafe mode needs async mode.");
         }
@@ -135,6 +143,14 @@ void validate() {
         if (async && asyncFrameBufferCapacity < 1) {
             throw new IllegalArgumentException("asyncFrameBufferCapacity needs to be a positive number (There needs to be at least one frame buffer).");
         }
+        locked = true;
+    }
+    private boolean locked = false;
+
+    void throwIfLocked() {
+        if (locked) {
+            throw new RuntimeException("Configuration can not be modified after the game has started");
+        }
     }
 
     void log(String value) {

src/main/java/bwapi/BotWrapper.java

@@ -36,7 +36,7 @@ void startNewGame(ByteBuffer liveData, PerformanceMetrics performanceMetrics) {
         }
         this.performanceMetrics = performanceMetrics;
         botGame = new Game();
-        botGame.clientData().setBuffer(liveData);
+        botGame.botClientData().setBuffer(liveData);
         liveClientData.setBuffer(liveData);
         this.liveData = liveData;
         botThread = null;
@@ -76,7 +76,7 @@ void onFrame() {
         if (configuration.getAsync()) {
             configuration.log("Main: onFrame asynchronous start");
             long startNanos = System.nanoTime();
-            long endNanos = startNanos + configuration.getMaxFrameDurationMs() * 1000000;
+            long endNanos = startNanos + (long) configuration.getMaxFrameDurationMs() * 1000000;
             if (botThread == null) {
                 configuration.log("Main: Starting bot thread");
                 botThread = createBotThread();
@@ -94,7 +94,7 @@ void onFrame() {
                 try {
                     if (frameBuffer.empty()) {
                         configuration.log("Main: Putting bot on live data");
-                        botGame.clientData().setBuffer(liveData);
+                        botGame.botClientData().setBuffer(liveData);
                         setUnsafeReadReady(true);
                     } else {
                         setUnsafeReadReady(false);
@@ -125,7 +125,7 @@ void onFrame() {
                     // so there's no guarantee of safety here.
                     if (configuration.getAsyncUnsafe() && frameBuffer.size() == 1) {
                         configuration.log("Main: Weaning bot off live data");
-                        botGame.clientData().setBuffer(frameBuffer.peek());
+                        botGame.botClientData().setBuffer(frameBuffer.peek());
                     }
 
                     // Make bot exceptions fall through to the main thread.
@@ -209,7 +209,7 @@ private Thread createBotThread() {
                         // TODO: Maybe we should point it at live data from here?
                     } else {
                         configuration.log("Bot: Peeking next frame from buffer");
-                        botGame.clientData().setBuffer(frameBuffer.peek());
+                        botGame.botClientData().setBuffer(frameBuffer.peek());
                     }
 
                     configuration.log("Bot: Handling events on frame #" + botGame.getFrameCount());
@@ -235,22 +235,22 @@ private Thread createBotThread() {
     }
 
     private void handleEvents() {
-        ClientData.GameData gameData = botGame.clientData().gameData();
+        ClientData.GameData botGameData = botGame.botClientData().gameData();
 
         // Populate gameOver before invoking event handlers (in case the bot throws)
-        for (int i = 0; i < gameData.getEventCount(); i++) {
-            gameOver = gameOver || gameData.getEvents(i).getType() == EventType.MatchEnd;
+        for (int i = 0; i < botGameData.getEventCount(); i++) {
+            gameOver = gameOver || botGameData.getEvents(i).getType() == EventType.MatchEnd;
         }
 
         if (configuration.getAsync()) {
             performanceMetrics.getFramesBehind().record(Math.max(1, frameBuffer.framesBuffered()) - 1);
         }
 
         performanceMetrics.getBotResponse().timeIf(
-            ! gameOver && (gameData.getFrameCount() > 0 || ! configuration.getUnlimitedFrameZero()),
+            ! gameOver && (botGameData.getFrameCount() > 0 || ! configuration.getUnlimitedFrameZero()),
             () -> {
-                for (int i = 0; i < gameData.getEventCount(); i++) {
-                    EventHandler.operation(eventListener, botGame, gameData.getEvents(i));
+                for (int i = 0; i < botGameData.getEventCount(); i++) {
+                    EventHandler.operation(eventListener, botGame, botGameData.getEvents(i));
                 }
             });
     }