Replace more instances with agnostic scheduler

Author: dmulloy2

src/main/java/com/comphenix/protocol/ProtocolLib.java

@@ -25,6 +25,10 @@
 import com.comphenix.protocol.injector.InternalManager;
 import com.comphenix.protocol.injector.PacketFilterManager;
 import com.comphenix.protocol.metrics.Statistics;
+import com.comphenix.protocol.scheduler.DefaultScheduler;
+import com.comphenix.protocol.scheduler.FoliaScheduler;
+import com.comphenix.protocol.scheduler.ProtocolScheduler;
+import com.comphenix.protocol.scheduler.Task;
 import com.comphenix.protocol.updater.Updater;
 import com.comphenix.protocol.updater.Updater.UpdateType;
 import com.comphenix.protocol.utility.*;
@@ -34,6 +38,7 @@
 import java.io.File;
 import java.io.IOException;
 import java.util.HashSet;
+import java.util.Optional;
 import java.util.Set;
 import java.util.concurrent.TimeUnit;
 import java.util.logging.Handler;
@@ -90,20 +95,21 @@ public class ProtocolLib extends JavaPlugin {
     // these fields are only existing once, we can make them static
     private static Logger logger;
     private static ProtocolConfig config;
-
     private static InternalManager protocolManager;
     private static ErrorReporter reporter = new BasicErrorReporter();
 
     private Statistics statistics;
 
-    private int packetTask = -1;
+    private Task packetTask = null;
     private int tickCounter = 0;
     private int configExpectedMod = -1;
 
     // updater
     private Updater updater;
     private Handler redirectHandler;
 
+    private ProtocolScheduler scheduler;
+
     // commands
     private CommandProtocol commandProtocol;
     private CommandPacket commandPacket;
@@ -155,6 +161,10 @@ public void onLoad() {
         }
 
         try {
+            this.scheduler = Util.isUsingFolia()
+                    ? new FoliaScheduler(this)
+                    : new DefaultScheduler(this);
+
             // Check for other versions
             this.checkConflictingVersions();
 
@@ -171,7 +181,7 @@ public void onLoad() {
                     .minecraftVersion(version)
                     .reporter(reporter)
                     .build();
-            ProtocolLibrary.init(this, config, protocolManager, reporter);
+            ProtocolLibrary.init(this, config, protocolManager, scheduler, reporter);
 
             // Setup error reporter
             detailedReporter.addGlobalParameter("manager", protocolManager);
@@ -483,12 +493,12 @@ private void disablePlugin() {
 
     private void createPacketTask(Server server) {
         try {
-            if (this.packetTask >= 0) {
+            if (this.packetTask != null) {
                 throw new IllegalStateException("Packet task has already been created");
             }
 
             // Attempt to create task
-            this.packetTask = SchedulerUtil.scheduleSyncRepeatingTask(this, () -> {
+            this.packetTask = scheduler.scheduleSyncRepeatingTask(() -> {
                 AsyncFilterManager manager = (AsyncFilterManager) protocolManager.getAsynchronousManager();
                 // We KNOW we're on the main thread at the moment
                 manager.sendProcessedPackets(ProtocolLib.this.tickCounter++, true);
@@ -504,7 +514,7 @@ private void createPacketTask(Server server) {
         } catch (OutOfMemoryError e) {
             throw e;
         } catch (Throwable e) {
-            if (this.packetTask == -1) {
+            if (this.packetTask == null) {
                 reporter.reportDetailed(this, Report.newBuilder(REPORT_CANNOT_CREATE_TIMEOUT_TASK).error(e));
             }
         }
@@ -563,9 +573,9 @@ public void onDisable() {
         }
 
         // Clean up
-        if (this.packetTask >= 0) {
-            SchedulerUtil.cancelTask(this, packetTask);
-            this.packetTask = -1;
+        if (this.packetTask != null) {
+            packetTask.cancel();
+            this.packetTask = null;
         }
 
         // And redirect handler too
@@ -601,6 +611,10 @@ public ProtocolConfig getProtocolConfig() {
         return config;
     }
 
+    public ProtocolScheduler getScheduler() {
+        return scheduler;
+    }
+
     // Different commands
     private enum ProtocolCommand {
         FILTER,

src/main/java/com/comphenix/protocol/ProtocolLibrary.java

@@ -16,6 +16,7 @@
 
 import com.comphenix.protocol.error.BasicErrorReporter;
 import com.comphenix.protocol.error.ErrorReporter;
+import com.comphenix.protocol.scheduler.ProtocolScheduler;
 import com.comphenix.protocol.utility.MinecraftVersion;
 import java.util.List;
 import com.google.common.collect.ImmutableList;
@@ -51,17 +52,20 @@ public class ProtocolLibrary {
     private static Plugin plugin;
     private static ProtocolConfig config;
     private static ProtocolManager manager;
+    private static ProtocolScheduler scheduler;
     private static ErrorReporter reporter = new BasicErrorReporter();
 
     private static boolean updatesDisabled;
     private static boolean initialized;
 
-    protected static void init(Plugin plugin, ProtocolConfig config, ProtocolManager manager, ErrorReporter reporter) {
+    protected static void init(Plugin plugin, ProtocolConfig config, ProtocolManager manager,
+                               ProtocolScheduler scheduler, ErrorReporter reporter) {
         Validate.isTrue(!initialized, "ProtocolLib has already been initialized.");
         ProtocolLibrary.plugin = plugin;
         ProtocolLibrary.config = config;
         ProtocolLibrary.manager = manager;
         ProtocolLibrary.reporter = reporter;
+        ProtocolLibrary.scheduler = scheduler;
         initialized = true;
     }
 
@@ -89,6 +93,10 @@ public static ProtocolManager getProtocolManager() {
         return manager;
     }
 
+    public static ProtocolScheduler getScheduler() {
+        return scheduler;
+    }
+
     /**
      * Retrieve the current error reporter.
      * @return Current error reporter.

src/main/java/com/comphenix/protocol/async/AsyncFilterManager.java

@@ -33,13 +33,13 @@
 import com.comphenix.protocol.events.PacketListener;
 import com.comphenix.protocol.injector.PrioritizedListener;
 import com.comphenix.protocol.injector.SortedPacketListenerList;
+import com.comphenix.protocol.scheduler.ProtocolScheduler;
 import com.google.common.base.Objects;
 import com.google.common.collect.ImmutableSet;
 import com.google.common.collect.Iterables;
 
 import org.bukkit.entity.Player;
 import org.bukkit.plugin.Plugin;
-import org.bukkit.scheduler.BukkitScheduler;
 
 /**
  * Represents a filter manager for asynchronous packets.
@@ -67,7 +67,7 @@ public class AsyncFilterManager implements AsynchronousManager {
     private final Thread mainThread;
 
     // Default scheduler
-    private final BukkitScheduler scheduler;
+    private final ProtocolScheduler scheduler;
 
     // Current packet index
     private final AtomicInteger currentSendingIndex = new AtomicInteger();
@@ -82,7 +82,7 @@ public class AsyncFilterManager implements AsynchronousManager {
      * @param reporter - desired error reporter.
      * @param scheduler - task scheduler.
      */
-    public AsyncFilterManager(ErrorReporter reporter, BukkitScheduler scheduler) {
+    public AsyncFilterManager(ErrorReporter reporter, ProtocolScheduler scheduler) {
         // Initialize timeout listeners
         this.serverTimeoutListeners = new SortedPacketListenerList();
         this.clientTimeoutListeners = new SortedPacketListenerList();
@@ -340,7 +340,7 @@ public Set<PacketType> getSendingTypes() {
      * Retrieve the current task scheduler.
      * @return Current task scheduler.
      */
-    public BukkitScheduler getScheduler() {
+    public ProtocolScheduler getScheduler() {
         return scheduler;
     }
 

src/main/java/com/comphenix/protocol/async/AsyncListenerHandler.java

@@ -31,6 +31,7 @@
 import com.comphenix.protocol.events.PacketAdapter;
 import com.comphenix.protocol.events.PacketEvent;
 import com.comphenix.protocol.events.PacketListener;
+import com.comphenix.protocol.scheduler.Task;
 import com.comphenix.protocol.timing.TimedListenerManager;
 import com.comphenix.protocol.timing.TimedListenerManager.ListenerType;
 import com.comphenix.protocol.timing.TimedTracker;
@@ -91,13 +92,13 @@ public class AsyncListenerHandler {
     private final Object stopLock = new Object();
 
     // Processing task on the main thread
-    private int syncTask = -1;
+    private Task syncTask = null;
 
     // Minecraft main thread
     private Thread mainThread;
 
     // Warn plugins that the async listener handler must be started
-    private int warningTask;
+    private Task warningTask;
 
     // Timing manager
     private TimedListenerManager timedManager = TimedListenerManager.getInstance();
@@ -121,19 +122,16 @@ public class AsyncListenerHandler {
     }
 
     private void startWarningTask() {
-        warningTask = filterManager.getScheduler().scheduleSyncDelayedTask(getPlugin(), () -> ProtocolLibrary.getErrorReporter().reportWarning(AsyncListenerHandler.this, Report.
+        warningTask = filterManager.getScheduler().scheduleSyncDelayedTask(() -> ProtocolLibrary.getErrorReporter().reportWarning(AsyncListenerHandler.this, Report.
                                                                  newBuilder(REPORT_HANDLER_NOT_STARTED).
                                                                  messageParam(listener.getPlugin(), AsyncListenerHandler.this).
                                                                  build()), 2 * TICKS_PER_SECOND);
     }
 
     private void stopWarningTask() {
-        int taskId = warningTask;
-        
-        // Ensure we have a task to cancel
-        if (warningTask >= 0) {
-            filterManager.getScheduler().cancelTask(taskId);
-            warningTask = -1;
+        if (warningTask != null) {
+            warningTask.cancel();
+            warningTask = null;
         }
     }
 
@@ -406,10 +404,10 @@ public synchronized boolean syncStart(final long time, final TimeUnit unit) {
         final long tickDelay = 1;
         final int workerID = nextID.incrementAndGet();
 
-        if (syncTask < 0) {
+        if (syncTask == null) {
             stopWarningTask();
 
-            syncTask = filterManager.getScheduler().scheduleSyncRepeatingTask(getPlugin(), () -> {
+            syncTask = filterManager.getScheduler().scheduleSyncRepeatingTask(() -> {
                 long stopTime = System.nanoTime() + unit.convert(time, TimeUnit.NANOSECONDS);
 
                 while (!cancelled) {
@@ -435,7 +433,7 @@ public synchronized boolean syncStart(final long time, final TimeUnit unit) {
             }, tickDelay, tickDelay);
 
             // This is very bad - force the caller to handle it
-            if (syncTask < 0)
+            if (syncTask == null)
                 throw new IllegalStateException("Cannot start synchronous task.");
             else
                 return true;
@@ -449,10 +447,9 @@ public synchronized boolean syncStart(final long time, final TimeUnit unit) {
      * @return TRUE if we stopped any processing tasks, FALSE if it has already been stopped.
      */
     public synchronized boolean syncStop() {
-        if (syncTask > 0) {
-            filterManager.getScheduler().cancelTask(syncTask);
-            
-            syncTask = -1;
+        if (syncTask != null) {
+            syncTask.cancel();
+            syncTask = null;
             return true;
         } else {
             return false;

src/main/java/com/comphenix/protocol/injector/PacketFilterBuilder.java

@@ -1,5 +1,6 @@
 package com.comphenix.protocol.injector;
 
+import com.comphenix.protocol.ProtocolLib;
 import com.comphenix.protocol.async.AsyncFilterManager;
 import com.comphenix.protocol.error.ErrorReporter;
 import com.comphenix.protocol.utility.MinecraftVersion;
@@ -10,7 +11,7 @@
 public class PacketFilterBuilder {
 
     private Server server;
-    private Plugin library;
+    private ProtocolLib library;
     private MinecraftVersion mcVersion;
     private ErrorReporter reporter;
     private AsyncFilterManager asyncManager;
@@ -32,7 +33,7 @@ public PacketFilterBuilder server(@Nonnull Server server) {
      * @param library - plugin instance.
      * @return This builder, for chaining.
      */
-    public PacketFilterBuilder library(@Nonnull Plugin library) {
+    public PacketFilterBuilder library(@Nonnull ProtocolLib library) {
         this.library = library;
         return this;
     }
@@ -116,7 +117,7 @@ public InternalManager build() {
             throw new IllegalArgumentException("reporter cannot be NULL.");
         }
 
-        this.asyncManager = new AsyncFilterManager(this.reporter, this.server.getScheduler());
+        this.asyncManager = new AsyncFilterManager(this.reporter, this.library.getScheduler());
         return new PacketFilterManager(this);
     }
 }

src/main/java/com/comphenix/protocol/scheduler/DefaultScheduler.java

@@ -0,0 +1,32 @@
+package com.comphenix.protocol.scheduler;
+
+import org.bukkit.plugin.Plugin;
+import org.bukkit.scheduler.BukkitScheduler;
+
+public class DefaultScheduler implements ProtocolScheduler {
+    private final Plugin plugin;
+    private final BukkitScheduler scheduler;
+
+    public DefaultScheduler(Plugin plugin) {
+        this.plugin = plugin;
+        this.scheduler = plugin.getServer().getScheduler();
+    }
+
+    @Override
+    public Task scheduleSyncRepeatingTask(Runnable task, long delay, long period) {
+        int taskId = scheduler.scheduleSyncRepeatingTask(plugin, task, delay, period);
+        return taskId >= 0 ? new DefaultTask(scheduler, taskId) : null;
+    }
+
+    @Override
+    public Task runTask(Runnable task) {
+        int taskId = scheduler.runTask(plugin, task).getTaskId();
+        return taskId >= 0 ? new DefaultTask(scheduler, taskId) : null;
+    }
+
+    @Override
+    public Task scheduleSyncDelayedTask(Runnable task, long delay) {
+        int taskId = scheduler.scheduleSyncDelayedTask(plugin, task, delay);
+        return taskId >= 0 ? new DefaultTask(scheduler, taskId) : null;
+    }
+}

src/main/java/com/comphenix/protocol/scheduler/DefaultTask.java

@@ -0,0 +1,19 @@
+package com.comphenix.protocol.scheduler;
+
+import org.bukkit.scheduler.BukkitScheduler;
+import org.bukkit.scheduler.BukkitTask;
+
+public class DefaultTask implements Task {
+    private final int taskId;
+    private final BukkitScheduler scheduler;
+
+    public DefaultTask(BukkitScheduler scheduler, int taskId) {
+        this.taskId = taskId;
+        this.scheduler = scheduler;
+    }
+
+    @Override
+    public void cancel() {
+        scheduler.cancelTask(taskId);
+    }
+}