Interface Proxy

public interface Proxy
One way of talking to the other servers in a network, such as a plugin-message channel or Redis.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CHANNEL
    The plugin-message channel identifier used for BungeeCord / Velocity communication between the proxy and all backend servers.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isEnable()
    Whether this transport is turned on in the config and ready to use.
    void
    onDisable()
    Closes the connection or unregisters the channel.
    void
    onEnable()
    Opens the connection or registers the channel.
    boolean
    sendMessage(@NonNull FEntity sender, @NonNull ModuleName tag, byte @NonNull [] message)
    Sends an encoded message to the other servers.

  • Field Details

    • CHANNEL

      static final String CHANNEL
      The plugin-message channel identifier used for BungeeCord / Velocity communication between the proxy and all backend servers.
      See Also:

  • Method Details

    • isEnable

      boolean isEnable()
      Whether this transport is turned on in the config and ready to use.
      Returns:
      true if it can carry messages

    • onEnable

      void onEnable()
      Opens the connection or registers the channel.

    • onDisable

      void onDisable()
      Closes the connection or unregisters the channel.

    • sendMessage

      boolean sendMessage(@NonNull FEntity sender, @NonNull ModuleName tag, byte @NonNull [] message)
      Sends an encoded message to the other servers.
      Parameters:
      sender - the entity the message is from
      tag - the module the message belongs to
      message - the encoded payload
      Returns:
      true if it was handed to the transport