Archiviert
13
0

Improved documentation in a few places.

Dieser Commit ist enthalten in:
Kristian S. Stangeland 2012-09-15 01:04:08 +02:00
Ursprung 4505e31965
Commit f2effab907
6 geänderte Dateien mit 41 neuen und 16 gelöschten Zeilen

Datei anzeigen

@ -81,6 +81,8 @@ public class ProtocolLibrary extends JavaPlugin {
/** /**
* Retrieve the metrics instance used to measure users of this library. * Retrieve the metrics instance used to measure users of this library.
* <p>
* Note that this method may return NULL when the server is reloading or shutting down.
* @return Metrics instance container. * @return Metrics instance container.
*/ */
public Statistics getStatistics() { public Statistics getStatistics() {

Datei anzeigen

@ -41,12 +41,18 @@ public interface ProtocolManager {
/** /**
* Adds a packet listener. * Adds a packet listener.
* <p>
* Adding an already registered listener has no effect. If you need to change the packets
* the current listener is observing, you must first remove the packet listener before you
* can register it again.
* @param listener - new packet listener. * @param listener - new packet listener.
*/ */
public void addPacketListener(PacketListener listener); public void addPacketListener(PacketListener listener);
/** /**
* Removes a given packet listener. * Removes a given packet listener.
* <p>
* Attempting to remove a listener that doesn't exist has no effect.
* @param listener - the packet listener to remove. * @param listener - the packet listener to remove.
*/ */
public void removePacketListener(PacketListener listener); public void removePacketListener(PacketListener listener);
@ -107,16 +113,16 @@ public interface ProtocolManager {
/** /**
* Constructs a new encapsulated Minecraft packet with the given ID. * Constructs a new encapsulated Minecraft packet with the given ID.
* <p> * <p>
* If set to true, the skip default option will prevent the system from assigning * If set to true, the <i>forceDefaults</i> option will force the system to automatically
* non-primitive fields in the packet to a new default instance. For instance, certain * give non-primitive fields in the packet sensible default values. For instance, certain
* packets - like Packet60Explosion - require a List or Set to be non-null. If the * packets - like Packet60Explosion - require a List or Set to be non-null. If the
* skipDefaults option is false, the List or Set will be automatically created. * forceDefaults option is true, the List or Set will be automatically created.
* *
* @param id - packet ID. * @param id - packet ID.
* @param skipDefaults - TRUE to skip setting default values, FALSE otherwise. * @param forceDefaults - TRUE to use sensible defaults in most fields, FALSE otherwise.
* @return New encapsulated Minecraft packet. * @return New encapsulated Minecraft packet.
*/ */
public PacketContainer createPacket(int id, boolean skipDefaults); public PacketContainer createPacket(int id, boolean forceDefaults);
/** /**
* Retrieves a immutable set containing the ID of the sent server packets that will be observed by listeners. * Retrieves a immutable set containing the ID of the sent server packets that will be observed by listeners.

Datei anzeigen

@ -19,7 +19,6 @@ package com.comphenix.protocol.events;
import org.bukkit.plugin.Plugin; import org.bukkit.plugin.Plugin;
/** /**
* Represents a packet listener with useful constructors. * Represents a packet listener with useful constructors.
* *
@ -33,7 +32,7 @@ public abstract class PacketAdapter implements PacketListener {
protected ListeningWhitelist sendingWhitelist = ListeningWhitelist.EMPTY_WHITELIST; protected ListeningWhitelist sendingWhitelist = ListeningWhitelist.EMPTY_WHITELIST;
/** /**
* Initialize a packet listener. * Initialize a packet listener with default priority.
* @param plugin - the plugin that spawned this listener. * @param plugin - the plugin that spawned this listener.
* @param connectionSide - the packet type the listener is looking for. * @param connectionSide - the packet type the listener is looking for.
* @param packets - the packet IDs the listener is looking for. * @param packets - the packet IDs the listener is looking for.
@ -43,7 +42,7 @@ public abstract class PacketAdapter implements PacketListener {
} }
/** /**
* Initialize a packet listener. * Initialize a packet listener for a single connection side.
* @param plugin - the plugin that spawned this listener. * @param plugin - the plugin that spawned this listener.
* @param connectionSide - the packet type the listener is looking for. * @param connectionSide - the packet type the listener is looking for.
* @param listenerPriority - the event priority. * @param listenerPriority - the event priority.

Datei anzeigen

@ -21,6 +21,8 @@ import org.bukkit.plugin.Plugin;
/** /**
* Represents a listener that recieves notifications when packets are sent or recieved. * Represents a listener that recieves notifications when packets are sent or recieved.
* <p>
* Use {@link PacketAdapter} for a simple wrapper around this interface.
* @author Kristian * @author Kristian
*/ */
public interface PacketListener { public interface PacketListener {

Datei anzeigen

@ -29,6 +29,7 @@ public class ConcurrentListenerMultimap {
/** /**
* Adds a listener to its requested list of packet recievers. * Adds a listener to its requested list of packet recievers.
* @param listener - listener with a list of packets to recieve notifcations for. * @param listener - listener with a list of packets to recieve notifcations for.
* @param whitelist - the packet whitelist to use.
*/ */
public void addListener(PacketListener listener, ListeningWhitelist whitelist) { public void addListener(PacketListener listener, ListeningWhitelist whitelist) {
@ -66,6 +67,7 @@ public class ConcurrentListenerMultimap {
/** /**
* Removes the given listener from the packet event list. * Removes the given listener from the packet event list.
* @param listener - listener to remove. * @param listener - listener to remove.
* @param whitelist - the packet whitelist that was used.
* @return Every packet ID that was removed due to no listeners. * @return Every packet ID that was removed due to no listeners.
*/ */
public List<Integer> removeListener(PacketListener listener, ListeningWhitelist whitelist) { public List<Integer> removeListener(PacketListener listener, ListeningWhitelist whitelist) {
@ -113,7 +115,7 @@ public class ConcurrentListenerMultimap {
for (PrioritizedListener element : list) { for (PrioritizedListener element : list) {
try { try {
element.getListener().onPacketReceiving(event); element.getListener().onPacketReceiving(event);
} catch (Exception e) { } catch (Throwable e) {
// Minecraft doesn't want your Exception. // Minecraft doesn't want your Exception.
logger.log(Level.SEVERE, logger.log(Level.SEVERE,
"Exception occured in onPacketReceiving() for " + "Exception occured in onPacketReceiving() for " +
@ -138,7 +140,7 @@ public class ConcurrentListenerMultimap {
for (PrioritizedListener element : list) { for (PrioritizedListener element : list) {
try { try {
element.getListener().onPacketSending(event); element.getListener().onPacketSending(event);
} catch (Exception e) { } catch (Throwable e) {
// Minecraft doesn't want your Exception. // Minecraft doesn't want your Exception.
logger.log(Level.SEVERE, logger.log(Level.SEVERE,
"Exception occured in onPacketReceiving() for " + "Exception occured in onPacketReceiving() for " +

Datei anzeigen

@ -40,6 +40,7 @@ import org.bukkit.event.EventPriority;
import org.bukkit.event.Listener; import org.bukkit.event.Listener;
import org.bukkit.event.player.PlayerJoinEvent; import org.bukkit.event.player.PlayerJoinEvent;
import org.bukkit.event.player.PlayerQuitEvent; import org.bukkit.event.player.PlayerQuitEvent;
import org.bukkit.event.server.PluginDisableEvent;
import org.bukkit.plugin.Plugin; import org.bukkit.plugin.Plugin;
import org.bukkit.plugin.PluginManager; import org.bukkit.plugin.PluginManager;
@ -270,15 +271,15 @@ public final class PacketFilterManager implements ProtocolManager {
@Override @Override
public PacketContainer createPacket(int id) { public PacketContainer createPacket(int id) {
return createPacket(id, false); return createPacket(id, true);
} }
@Override @Override
public PacketContainer createPacket(int id, boolean skipDefaults) { public PacketContainer createPacket(int id, boolean forceDefaults) {
PacketContainer packet = new PacketContainer(id); PacketContainer packet = new PacketContainer(id);
// Use any default values if possible // Use any default values if possible
if (!skipDefaults) { if (forceDefaults) {
try { try {
packet.getModifier().writeDefaults(); packet.getModifier().writeDefaults();
} catch (FieldAccessException e) { } catch (FieldAccessException e) {
@ -331,7 +332,7 @@ public final class PacketFilterManager implements ProtocolManager {
* @param manager - Bukkit plugin manager that provides player join/leave events. * @param manager - Bukkit plugin manager that provides player join/leave events.
* @param plugin - the parent plugin. * @param plugin - the parent plugin.
*/ */
public void registerEvents(PluginManager manager, Plugin plugin) { public void registerEvents(PluginManager manager, final Plugin plugin) {
try { try {
manager.registerEvents(new Listener() { manager.registerEvents(new Listener() {
@ -345,6 +346,15 @@ public final class PacketFilterManager implements ProtocolManager {
public void onPlayerQuit(PlayerQuitEvent event) { public void onPlayerQuit(PlayerQuitEvent event) {
uninjectPlayer(event.getPlayer()); uninjectPlayer(event.getPlayer());
} }
@EventHandler(priority = EventPriority.NORMAL, ignoreCancelled = true)
public void onPluginDisabled(PluginDisableEvent event) {
// Clean up in case the plugin forgets
if (event.getPlugin() != plugin) {
removePacketListeners(event.getPlugin());
}
}
}, plugin); }, plugin);
} catch (NoSuchMethodError e) { } catch (NoSuchMethodError e) {
@ -370,6 +380,7 @@ public final class PacketFilterManager implements ProtocolManager {
// Get event types // Get event types
Object playerJoinType = Enum.valueOf(eventTypes, "PLAYER_JOIN"); Object playerJoinType = Enum.valueOf(eventTypes, "PLAYER_JOIN");
Object playerQuitType = Enum.valueOf(eventTypes, "PLAYER_QUIT"); Object playerQuitType = Enum.valueOf(eventTypes, "PLAYER_QUIT");
Object pluginDisabledType = Enum.valueOf(eventTypes, "PLUGIN_DISABLE");
// The player listener! Good times. // The player listener! Good times.
Class<?> playerListener = loader.loadClass("org.bukkit.event.player.PlayerListener"); Class<?> playerListener = loader.loadClass("org.bukkit.event.player.PlayerListener");
@ -394,6 +405,8 @@ public final class PacketFilterManager implements ProtocolManager {
injectPlayer(((PlayerJoinEvent) event).getPlayer()); injectPlayer(((PlayerJoinEvent) event).getPlayer());
else if (event instanceof PlayerQuitEvent) else if (event instanceof PlayerQuitEvent)
injectPlayer(((PlayerQuitEvent) event).getPlayer()); injectPlayer(((PlayerQuitEvent) event).getPlayer());
else if (event instanceof PluginDisableEvent)
removePacketListeners(((PluginDisableEvent) event).getPlugin());
} }
return null; return null;
@ -405,6 +418,7 @@ public final class PacketFilterManager implements ProtocolManager {
registerEvent.invoke(manager, playerJoinType, proxy, priorityNormal, plugin); registerEvent.invoke(manager, playerJoinType, proxy, priorityNormal, plugin);
registerEvent.invoke(manager, playerQuitType, proxy, priorityNormal, plugin); registerEvent.invoke(manager, playerQuitType, proxy, priorityNormal, plugin);
registerEvent.invoke(manager, pluginDisabledType, proxy, priorityNormal, plugin);
// A lot can go wrong // A lot can go wrong
} catch (ClassNotFoundException e1) { } catch (ClassNotFoundException e1) {