Interface ChannelRegistrar

public interface ChannelRegistrar
Manages registration of plugin message channels.

Plugin message channels allow communication between the proxy and backend servers. Channels must be registered before they can be used to send or receive messages.

Example Usage

ChannelIdentifier channel = ChannelIdentifier.create("myplugin", "data");

// Register the channel
proxy.getChannelRegistrar().register(channel);

// Later, unregister when done
proxy.getChannelRegistrar().unregister(channel);
See Also:

  • Method Details

    • register

      void register(@Nonnull ChannelIdentifier channel)
      Registers a plugin message channel.

      After registration, the proxy will listen for messages on this channel and fire PluginMessageEvent when messages are received.

      Parameters:
      channel - the channel to register

    • register

      void register(@Nonnull ChannelIdentifier... channels)
      Registers multiple plugin message channels.
      Parameters:
      channels - the channels to register

    • unregister

      void unregister(@Nonnull ChannelIdentifier channel)
      Unregisters a plugin message channel.

      After unregistration, messages on this channel will no longer be processed.

      Parameters:
      channel - the channel to unregister

    • unregister

      void unregister(@Nonnull ChannelIdentifier... channels)
      Unregisters multiple plugin message channels.
      Parameters:
      channels - the channels to unregister

    • isRegistered

      boolean isRegistered(@Nonnull ChannelIdentifier channel)
      Checks if a channel is registered.
      Parameters:
      channel - the channel to check
      Returns:
      true if the channel is registered

    • getRegisteredChannels

      @Nonnull Collection<ChannelIdentifier> getRegisteredChannels()
      Gets all registered channels.
      Returns:
      an unmodifiable collection of registered channels