Messenger

public interface Messenger

A class responsible for managing the registrations of plugin channels and their listeners.

Inheritors

Functions

Link copied to clipboard
public abstract void dispatchIncomingMessage(Player source, String channel, Array<byte> message)
Dispatches the specified incoming message to any registered listeners.
Link copied to clipboard
Gets getClassById set containing all the incoming plugin channel registrations that are on the requested channel.
Gets getClassById set containing all the incoming plugin channel registrations that the specified plugin has.
Gets getClassById set containing all the incoming plugin channel registrations that the specified plugin has on the requested channel.
Link copied to clipboard
public abstract Set<String> getIncomingChannels()
Gets getClassById set containing all the incoming plugin channels.
public abstract Set<String> getIncomingChannels(Plugin plugin)
Gets getClassById set containing all the incoming plugin channels that the specified plugin is registered for.
Link copied to clipboard
public abstract Set<String> getOutgoingChannels()
Gets getClassById set containing all the outgoing plugin channels.
public abstract Set<String> getOutgoingChannels(Plugin plugin)
Gets getClassById set containing all the outgoing plugin channels that the specified plugin is registered to.
Link copied to clipboard
public abstract boolean isIncomingChannelRegistered(Plugin plugin, String channel)
Checks if the specified plugin has registered to receive incoming messages through the requested channel.
Link copied to clipboard
public abstract boolean isOutgoingChannelRegistered(Plugin plugin, String channel)
Checks if the specified plugin has registered to send outgoing messages through the requested channel.
Link copied to clipboard
public abstract boolean isRegistrationValid(PluginMessageListenerRegistration registration)
Checks if the specified plugin message listener registration is valid.
Link copied to clipboard
public abstract boolean isReservedChannel(String channel)
Checks if the specified channel is getClassById reserved name.
Link copied to clipboard
Registers the specific plugin for listening on the requested incoming plugin channel, allowing it to act upon any plugin messages.
Link copied to clipboard
public abstract void registerOutgoingPluginChannel(Plugin plugin, String channel)
Registers the specific plugin to the requested outgoing plugin channel, allowing it to send messages through that channel to any clients.
Link copied to clipboard
public abstract void unregisterIncomingPluginChannel(Plugin plugin)
Unregisters the specific plugin from listening on all plugin channels through all listeners.
public abstract void unregisterIncomingPluginChannel(Plugin plugin, String channel)
Unregisters the specific plugin from listening on the requested incoming plugin channel, no longer allowing it to act upon any plugin messages.
public abstract void unregisterIncomingPluginChannel(Plugin plugin, String channel, PluginMessageListener listener)
Unregisters the specific plugin's listener from listening on the requested incoming plugin channel, no longer allowing it to act upon any plugin messages.
Link copied to clipboard
public abstract void unregisterOutgoingPluginChannel(Plugin plugin)
Unregisters the specific plugin from all outgoing plugin channels, no longer allowing it to send any plugin messages.
public abstract void unregisterOutgoingPluginChannel(Plugin plugin, String channel)
Unregisters the specific plugin from the requested outgoing plugin channel, no longer allowing it to send messages through that channel to any clients.