Merge branch 'plugin-message-event' into merged

api/src/main/java/com/velocitypowered/api/event/connection/PluginMessageEvent.java

@@ -0,0 +1,94 @@
+package com.velocitypowered.api.event.connection;
+
+import com.google.common.base.Preconditions;
+import com.google.common.io.ByteArrayDataInput;
+import com.google.common.io.ByteStreams;
+import com.velocitypowered.api.event.ResultedEvent;
+import com.velocitypowered.api.proxy.messages.ChannelIdentifier;
+import com.velocitypowered.api.proxy.messages.ChannelMessageSink;
+import com.velocitypowered.api.proxy.messages.ChannelMessageSource;
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+import java.util.Arrays;
+
+/**
+ * This event is fired when a plugin message is sent to the proxy, either from a client ({@link com.velocitypowered.api.proxy.Player})
+ * or a server ({@link com.velocitypowered.api.proxy.ServerConnection}).
+ */
+public class PluginMessageEvent implements ResultedEvent<PluginMessageEvent.ForwardResult> {
+    private final ChannelMessageSource source;
+    private final ChannelMessageSink target;
+    private final ChannelIdentifier identifier;
+    private final byte[] data;
+    private ForwardResult result;
+
+    public PluginMessageEvent(ChannelMessageSource source, ChannelMessageSink target, ChannelIdentifier identifier, byte[] data) {
+        this.source = Preconditions.checkNotNull(source, "source");
+        this.target = Preconditions.checkNotNull(target, "target");
+        this.identifier = Preconditions.checkNotNull(identifier, "identifier");
+        this.data = Preconditions.checkNotNull(data, "data");
+        this.result = ForwardResult.forward();
+    }
+
+    @Override
+    public ForwardResult getResult() {
+        return result;
+    }
+
+    @Override
+    public void setResult(@NonNull ForwardResult result) {
+        this.result = Preconditions.checkNotNull(result, "result");
+    }
+
+    public ChannelMessageSource getSource() {
+        return source;
+    }
+
+    public ChannelMessageSink getTarget() {
+        return target;
+    }
+
+    public ChannelIdentifier getIdentifier() {
+        return identifier;
+    }
+
+    public byte[] getData() {
+        return Arrays.copyOf(data, data.length);
+    }
+
+    public ByteArrayDataInput dataAsDataStream() {
+        return ByteStreams.newDataInput(data);
+    }
+
+    /**
+     * A result determining whether or not to forward this message on.
+     */
+    public static class ForwardResult implements ResultedEvent.Result {
+        private static final ForwardResult ALLOWED = new ForwardResult(true);
+        private static final ForwardResult DENIED = new ForwardResult(false);
+
+        private final boolean allowed;
+
+        private ForwardResult(boolean b) {
+            this.allowed = b;
+        }
+
+        @Override
+        public boolean isAllowed() {
+            return allowed;
+        }
+
+        @Override
+        public String toString() {
+            return allowed ? "forward to sink" : "handled message at proxy";
+        }
+
+        public static ForwardResult forward() {
+            return ALLOWED;
+        }
+
+        public static ForwardResult handled() {
+            return DENIED;
+        }
+    }
+}

api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelRegistrar.java

@@ -1,16 +1,14 @@
 package com.velocitypowered.api.proxy.messages;
 
 /**
- * Represents an interface to register and unregister {@link MessageHandler} instances for handling plugin messages from
- * the client or the server.
+ * Represents an interface to register and unregister {@link ChannelIdentifier}s for the proxy to listen on.
  */
 public interface ChannelRegistrar {
     /**
-     * Registers the specified message handler to listen for plugin messages on the specified channels.
-     * @param handler the handler to register
+     * Registers the specified message identifiers to listen on for the
      * @param identifiers the channel identifiers to register
      */
-    void register(MessageHandler handler, ChannelIdentifier... identifiers);
+    void register(ChannelIdentifier... identifiers);
 
     /**
      * Unregisters the handler for the specified channel.

api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelSide.java

@@ -1,15 +0,0 @@
-package com.velocitypowered.api.proxy.messages;
-
-/**
- * Represents from "which side" of the proxy the plugin message came from.
- */
-public enum ChannelSide {
-    /**
-     * The plugin message came from a server that a client was connected to.
-     */
-    FROM_SERVER,
-    /**
-     * The plugin message came from the client.
-     */
-    FROM_CLIENT
-}

api/src/main/java/com/velocitypowered/api/proxy/messages/MessageHandler.java

@@ -1,28 +0,0 @@
-package com.velocitypowered.api.proxy.messages;
-
-/**
- * Represents a handler for handling plugin messages.
- */
-public interface MessageHandler {
-    /**
-     * Handles an incoming plugin message.
-     * @param source the source of the plugin message
-     * @param side from where the plugin message originated
-     * @param identifier the channel on which the message was sent
-     * @param data the data inside the plugin message
-     * @return a {@link ForwardStatus} indicating whether or not to forward this plugin message on
-     */
-    ForwardStatus handle(ChannelMessageSource source, ChannelSide side, ChannelIdentifier identifier, byte[] data);
-
-    enum ForwardStatus {
-        /**
-         * Forwards this plugin message on to the client or server, depending on the {@link ChannelSide} it originated
-         * from.
-         */
-        FORWARD,
-        /**
-         * Discard the plugin message and do not forward it on.
-         */
-        HANDLED
-    }
-}