Extracted portions of Client to GameDataUtils. Removed the bot loop entirely for reinsertion via BotWrapper, so this revision is in a non-working state.

Author: dgant

src/main/java/bwapi/BWClient.java

@@ -44,6 +44,7 @@ public void startGame(boolean autoContinue) {
      * @param configuration Settings for playing games with this client.
      */
     public void startGame(BWClientConfiguration configuration) {
+        configuration.validate();
         Client client = new Client(configuration);
         client.reconnect();
         handler = new EventHandler(eventListener, client);
@@ -53,10 +54,10 @@ public void startGame(BWClientConfiguration configuration) {
                 if (!client.isConnected()) {
                     return;
                 }
-                client.update(handler);
+                client.update();
             }
             while (getGame().isInGame()) {
-                client.update(handler);
+                client.update();
                 if (!client.isConnected()) {
                     System.out.println("Reconnecting...");
                     client.reconnect();

src/main/java/bwapi/BWClientConfiguration.java

@@ -5,6 +5,11 @@
  */
 public class BWClientConfiguration {
 
+    /**
+     * Set to `true` for more explicit error messages (which might spam the terminal).
+     */
+    public boolean debugConnection;
+
     /**
      * When true, restarts the client loop when a game ends, allowing the client to play multiple games without restarting.
      */
@@ -24,18 +29,19 @@ public class BWClientConfiguration {
     public boolean async = false;
 
     /**
-     * If JBWAPI detects that this much time (in nanoseconds) has passed since a bot's event handlers began, returns control back to BWAPI.
-     * Real-time human play typically uses the "fastest" game speed, which has 42.86ms (42,860ns) between frames.
+     * How frequently (in nanoseconds) to poll for the bot's event handlers completing. Acts as a floor on the bot's frame duration.
      */
-    public int asyncFrameDurationNanosMax = 40000;
+    public int asyncFrameDurationNanosMin = 500;
 
     /**
-     * How frequently (in nanoseconds) to poll for the bot's event handlers completing. Acts as a floor on the bot's frame duration.
+     * If JBWAPI detects that this much time (in nanoseconds) has passed since a bot's event handlers began, returns control back to BWAPI.
+     * Real-time human play typically uses the "fastest" game speed, which has 42.86ms (42,860ns) between frames.
      */
-    public int asyncFrameDurationNanosMin = 500;
+    public int asyncFrameDurationNanosMax = 40000;
 
     /**
-     * The maximum number of frames to buffer while waiting on a bot
+     * The maximum number of frames to buffer while waiting on a bot.
+     * Each frame buffered adds about 33 megabytes to JBWAPI's memory footprint.
      */
     public int asyncFrameBufferSize = 10;
 
@@ -49,7 +55,17 @@ public class BWClientConfiguration {
     public boolean asyncWaitOnFrameZero = true;
 
     /**
-     * Set to `true` for more explicit error messages (which might spam the terminal).
+     * Checks that the configuration is in a valid state. Throws an IllegalArgumentException if it isn't.
      */
-    public boolean debugConnection;
+    public void validate() {
+        if (async && asyncFrameDurationNanosMin <= 0) {
+            throw new IllegalArgumentException("asyncFrameDurationNanosMin needs to be a positive number (it's how long JBWAPI waits to poll for a completed frame.");
+        }
+        if (async && asyncFrameDurationNanosMax < 0) {
+            throw new IllegalArgumentException("asyncFrameDurationNanosMax needs to be a non-negative number (it's how long JBWAPI waits for a bot response before returning control to BWAPI).");
+        }
+        if (async && asyncFrameBufferSize < 1) {
+            throw new IllegalArgumentException("asyncFrameBufferSize needs to be a positive number (There needs to be at least one frame buffer).");
+        }
+    }
 }

src/main/java/bwapi/BotWrapper.java

@@ -0,0 +1,62 @@
+/*
+MIT License
+
+Copyright (c) 2018 Hannes Bredberg
+Modified work Copyright (c) 2018 Jasper
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+
+package bwapi;
+
+import java.nio.ByteBuffer;
+
+/**
+ * Manages invocation of bot event handlers
+ */
+public class BotWrapper {
+    private EventHandler eventHandler;
+    private ByteBuffer sharedMemory;
+    private BWClientConfiguration configuration;
+
+    private FrameBuffer frameBuffer;
+
+    public BotWrapper(ByteBuffer sharedMemory, EventHandler eventHandler, BWClientConfiguration configuration) {
+        this.sharedMemory = sharedMemory;
+        this.eventHandler = eventHandler;
+        this.configuration = configuration;
+
+        if (configuration.async) {
+            frameBuffer = new FrameBuffer(configuration.asyncFrameBufferSize);
+        }
+    }
+
+    public void run() {
+        if (configuration.async) {
+            // TODO: Synchronize
+            frameBuffer.enqueueFrame();
+        } else {
+            /*
+            for (int i = 0; i < gameData.getEventCount(); i++) {
+                eventHandler.operation(gameData.getEvents(i));
+            }
+            */
+        }
+    }
+}

src/main/java/bwapi/Client.java

@@ -25,9 +25,7 @@ of this software and associated documentation files (the "Software"), to deal
 
 package bwapi;
 
-import bwapi.ClientData.Command;
 import bwapi.ClientData.GameData;
-import bwapi.ClientData.Shape;
 import com.sun.jna.Native;
 import com.sun.jna.platform.win32.Kernel32;
 import com.sun.jna.win32.W32APIOptions;
@@ -48,17 +46,14 @@ public interface EventHandler {
     }
 
     private static final int READ_WRITE = 0x1 | 0x2 | 0x4;
-
     private static final int SUPPORTED_BWAPI_VERSION = 10003;
-    static final int MAX_COUNT = 19999;
-    static final int MAX_STRING_SIZE = 1024;
 
     private ClientData clientData;
     private ClientData.GameData gameData;
     private boolean connected = false;
     private RandomAccessFile pipeObjectHandle = null;
-    private ByteBuffer mapFileHandle = null;
     private ByteBuffer gameTableFileHandle = null;
+    private ByteBuffer mapFileHandle = null;
 
     private BWClientConfiguration configuration = new BWClientConfiguration();
 
@@ -70,7 +65,8 @@ public interface EventHandler {
      * For test purposes only
      */
     Client(ByteBuffer buffer) {
-        clientData = new ClientData(buffer);
+        clientData = new ClientData();
+        clientData.setBuffer(buffer);
         gameData = clientData.new GameData(0);
     }
 
@@ -86,7 +82,7 @@ boolean isConnected() {
         return connected;
     }
 
-    void reconnect(){
+    void reconnect() {
         while (!connect()) {
             sleep(1000);
         }
@@ -111,8 +107,8 @@ void disconnect() {
             pipeObjectHandle = null;
         }
 
-        mapFileHandle = null;
         gameTableFileHandle = null;
+        mapFileHandle = null;
         gameData = null;
         connected = false;
     }
@@ -126,6 +122,7 @@ boolean connect() {
         int serverProcID = -1;
         int gameTableIndex = -1;
 
+        // Expose the BWAPI list of games from shared memory via a ByteBuffer
         try {
             gameTableFileHandle = Kernel32.INSTANCE.MapViewOfFile(
                     MappingKernel.INSTANCE.OpenFileMapping(READ_WRITE, false, "Local\\bwapi_shared_memory_game_list"), READ_WRITE, 0, 0, GameTable.SIZE)
@@ -185,6 +182,7 @@ boolean connect() {
         }
         System.out.println("Connected");
 
+        // Expose the raw game data from shared memory via a ByteBuffer
         try {
             mapFileHandle = Kernel32.INSTANCE.MapViewOfFile(MappingKernel.INSTANCE
                             .OpenFileMapping(READ_WRITE, false, sharedMemoryName), READ_WRITE,
@@ -200,7 +198,8 @@ boolean connect() {
             return false;
         }
         try {
-            clientData = new ClientData(mapFileHandle);
+            clientData = new ClientData();
+            clientData.setBuffer(mapFileHandle);
             gameData = clientData.new GameData(0);
         }
         catch (Exception e) {
@@ -239,7 +238,7 @@ boolean connect() {
         return true;
     }
 
-    void update(final EventHandler handler) {
+    void update() {
         byte code = 1;
         try {
             pipeObjectHandle.writeByte(code);
@@ -265,60 +264,10 @@ void update(final EventHandler handler) {
                 return;
             }
         }
-        for (int i = 0; i < gameData.getEventCount(); i++) {
-            handler.operation(gameData.getEvents(i));
-        }
-    }
-
-    String eventString(final int s) {
-        return gameData.getEventStrings(s);
-    }
-
-    int addString(final String string) {
-        int stringCount = gameData.getStringCount();
-        if (stringCount >= MAX_COUNT) {
-            throw new IllegalStateException("Too many strings!");
-        }
-
-        //truncate string if its size equals or exceeds 1024
-        final String stringTruncated = string.length() >= MAX_STRING_SIZE
-                ? string.substring(0, MAX_STRING_SIZE - 1)
-                : string;
-
-        gameData.setStringCount(stringCount + 1);
-        gameData.setStrings(stringCount, stringTruncated);
-        return stringCount;
-    }
-
-    Shape addShape() {
-        int shapeCount = gameData.getShapeCount();
-        if (shapeCount >= MAX_COUNT) {
-            throw new IllegalStateException("Too many shapes!");
-        }
-        gameData.setShapeCount(shapeCount + 1);
-        return gameData.getShapes(shapeCount);
-    }
-
-    Command addCommand() {
-        final int commandCount = gameData.getCommandCount();
-        if (commandCount >= MAX_COUNT) {
-            throw new IllegalStateException("Too many commands!");
-        }
-        gameData.setCommandCount(commandCount + 1);
-        return gameData.getCommands(commandCount);
-    }
-
-    ClientData.UnitCommand addUnitCommand() {
-        int unitCommandCount = gameData.getUnitCommandCount();
-        if (unitCommandCount >= MAX_COUNT) {
-            throw new IllegalStateException("Too many unit commands!");
-        }
-        gameData.setUnitCommandCount(unitCommandCount + 1);
-        return gameData.getUnitCommands(unitCommandCount);
     }
 
     private void sleep(final int millis) {
-        try{
+        try {
             Thread.sleep(millis);
         }
         catch (Exception ignored) {