Merge pull request #5263 from kwvanderlinde/refactor/5262-better-mana…

…ge-ServerHeartBeatThread

Move heart beat task into MapToolClient

src/main/java/net/rptools/maptool/client/MapTool.java

@@ -686,8 +686,6 @@ private static void initialize() {
     chatAutoSave = new ChatAutoSave();
     chatAutoSave.setTimeout(AppPreferences.chatAutoSaveTimeInMinutes.get());
     AppPreferences.chatAutoSaveTimeInMinutes.onChange(chatAutoSave::setTimeout);
-
-    new ServerHeartBeatThread().start();
   }
 
   public static NoteFrame getProfilingNoteFrame() {
@@ -1393,30 +1391,6 @@ public static String getClientId() {
     return clientId;
   }
 
-  private static class ServerHeartBeatThread extends Thread {
-
-    public ServerHeartBeatThread() {
-      super("MapTool.ServerHeartBeatThread");
-    }
-
-    @Override
-    public void run() {
-
-      // This should always run, so we should be able to safely
-      // loop forever
-      while (true) {
-        try {
-          Thread.sleep(20000);
-        } catch (InterruptedException e) {
-          log.warn("Heartbeat thread interrupted", e);
-        }
-
-        ServerCommand command = client.getServerCommand();
-        command.heartbeat(getPlayer().getName());
-      }
-    }
-  }
-
   /**
    * Search for command line arguments for options. Expecting arguments specified as
    * -parameter=value pair and returns a string.

src/main/java/net/rptools/maptool/client/MapToolClient.java

@@ -21,6 +21,10 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
+import java.util.concurrent.Executors;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.ScheduledFuture;
+import java.util.concurrent.TimeUnit;
 import javax.annotation.Nullable;
 import net.rptools.clientserver.simple.connection.Connection;
 import net.rptools.maptool.client.events.PlayerConnected;
@@ -50,6 +54,9 @@
  */
 public class MapToolClient {
   private static final Logger log = LogManager.getLogger(MapToolClient.class);
+  private static final ScheduledExecutorService periodTaskExecutor =
+      Executors.newSingleThreadScheduledExecutor();
+  private static final long HEARTBEAT_SECONDS = 20;
 
   public enum State {
     New,
@@ -71,6 +78,8 @@ public enum State {
   private final ServerCommandClientImpl serverCommand;
   private State currentState = State.New;
 
+  private @Nullable ScheduledFuture<?> heartBeatHandle;
+
   private MapToolClient(
       @Nullable MapToolServer localServer,
       Campaign campaign,
@@ -187,11 +196,20 @@ public void start() throws IOException {
         serverCommand.stop();
         throw e;
       }
+
+      var task = new HeartBeatTask(serverCommand, conn.getId());
+      heartBeatHandle =
+          periodTaskExecutor.scheduleAtFixedRate(
+              task, HEARTBEAT_SECONDS, HEARTBEAT_SECONDS, TimeUnit.SECONDS);
     }
   }
 
   public void close() {
     if (transitionToState(State.Closed)) {
+      if (heartBeatHandle != null) {
+        heartBeatHandle.cancel(true);
+      }
+
       serverCommand.stop();
       if (conn.isAlive()) {
         conn.close();
@@ -317,4 +335,12 @@ private void onDisconnect(Connection connection) {
           });
     }
   }
+
+  private record HeartBeatTask(ServerCommand serverCommand, String name) implements Runnable {
+    @Override
+    public void run() {
+      log.debug("HeartBeatTask(…, {})#run()", name);
+      serverCommand.heartbeat(name);
+    }
+  }
 }

src/main/java/net/rptools/maptool/client/MapToolConnection.java

@@ -97,6 +97,10 @@ public void addDisconnectHandler(DisconnectHandler serverDisconnectHandler) {
     connection.addDisconnectHandler(serverDisconnectHandler);
   }
 
+  public String getId() {
+    return connection.getId();
+  }
+
   public boolean isAlive() {
     return connection.isAlive();
   }