Package org.spongepowered.api.network.channel

Interface ChannelManager

public interface ChannelManager
A manager handling custom payloads via Channels to and from EngineConnections.

  • Method Details

    • get

      Optional<Channel> get(ResourceKey channelKey)
      Gets a channel binding if a channel exists for the given key.
      Parameters:
      channelKey - The channel key
      Returns:
      The channel if it exists

    • ofType

      <C extends Channel> C ofType(ResourceKey channelKey, Class<C> channelType)
      Gets a Channel by the given channel key. If the channel exists and it matches the given channel type, it is returned. If the channel doesn't match a IllegalStateException is thrown.
      Parameters:
      channelKey - The channel key
      channelType - The channel type
      Returns:
      A new or existing channel binding
      Throws:
      IllegalStateException - if the existing channel is not of the given type

    • channels

      Collection<Channel> channels()
      Gets an immutable collection of all the channels that are registered.
      Returns:
      The channels