com.comphenix.protocol.injector

Class DelayedPacketManager

java.lang.Object

com.comphenix.protocol.injector.DelayedPacketManager

All Implemented Interfaces:

InternalManager, PacketStream, ProtocolManager

public class DelayedPacketManager
extends java.lang.Object
implements ProtocolManager, InternalManager

A protocol manager that delays all packet listener registrations and unregistrations until an underlying protocol manager can be constructed.

Author:

Kristian

Field Summary

Fields

Modifier and Type	Field and Description
static ReportType	REPORT_CANNOT_REGISTER_QUEUED_LISTENER
static ReportType	REPORT_CANNOT_SEND_QUEUED_PACKET

Constructor Summary

Constructors

Constructor and Description
DelayedPacketManager(ErrorReporter reporter, MinecraftVersion version)

Method Summary

Methods

Modifier and Type	Method and Description
void	addPacketListener(PacketListener listener) Adds a packet listener.
void	broadcastServerPacket(PacketContainer packet) Broadcast a given packet to every connected player on the server.
void	broadcastServerPacket(PacketContainer packet, org.bukkit.entity.Entity entity, boolean includeTracker) Broadcast a packet to every player that is receiving information about a given entity.
void	broadcastServerPacket(PacketContainer packet, org.bukkit.Location origin, int maxObserverDistance) Broadcast a packet to every player within the given maximum observer distance.
void	close() Called when ProtocolLib is closing.
PacketContainer	createPacket(int id) Deprecated.
PacketContainer	createPacket(int id, boolean forceDefaults) Deprecated.
PacketContainer	createPacket(PacketType type) Constructs a new encapsulated Minecraft packet with the given ID.
PacketContainer	createPacket(PacketType type, boolean forceDefaults) Constructs a new encapsulated Minecraft packet with the given ID.
PacketConstructor	createPacketConstructor(int id, java.lang.Object... arguments) Construct a packet using the special builtin Minecraft constructors.
PacketConstructor	createPacketConstructor(PacketType type, java.lang.Object... arguments) Construct a packet using the special builtin Minecraft constructors.
AsynchronousManager	getAsynchronousManager() Retrieve the current asynchronous packet manager.
InternalManager	getDelegate() Retrieve the underlying protocol manager.
org.bukkit.entity.Entity	getEntityFromID(org.bukkit.World container, int id) Retrieve the associated entity.
java.util.List<org.bukkit.entity.Player>	getEntityTrackers(org.bukkit.entity.Entity entity) Retrieve every client that is receiving information about a given entity.
MinecraftVersion	getMinecraftVersion() Retrieve the current Minecraft version.
com.google.common.collect.ImmutableSet<PacketListener>	getPacketListeners() Retrieves a list of every registered packet listener.
PacketFilterManager.PlayerInjectHooks	getPlayerHook() Retrieves how the server packets are read.
java.util.Set<java.lang.Integer>	getReceivingFilters() Deprecated.
java.util.Set<PacketType>	getReceivingFilterTypes() Retrieves a immutable set containing the type of the received client packets that will be observed by listeners.
java.util.Set<java.lang.Integer>	getSendingFilters() Deprecated.
java.util.Set<PacketType>	getSendingFilterTypes() Retrieves a immutable set containing the type of the sent server packets that will be observed by listeners.
boolean	isClosed() Determines whether or not this protocol manager has been disabled.
boolean	isDebug() Determine if debug mode is enabled.
void	recieveClientPacket(org.bukkit.entity.Player sender, PacketContainer packet) Simulate recieving a certain packet from a given player.
void	recieveClientPacket(org.bukkit.entity.Player sender, PacketContainer packet, boolean filters) Simulate receiving a certain packet from a given player.
void	recieveClientPacket(org.bukkit.entity.Player sender, PacketContainer packet, NetworkMarker marker, boolean filters) Simulate recieving a certain packet from a given player.
void	registerEvents(org.bukkit.plugin.PluginManager manager, org.bukkit.plugin.Plugin plugin) Register this protocol manager on Bukkit.
void	removePacketListener(PacketListener listener) Removes a given packet listener.
void	removePacketListeners(org.bukkit.plugin.Plugin plugin) Removes every listener associated with the given plugin.
void	sendServerPacket(org.bukkit.entity.Player receiver, PacketContainer packet) Send a packet to the given player.
void	sendServerPacket(org.bukkit.entity.Player receiver, PacketContainer packet, boolean filters) Send a packet to the given player.
void	sendServerPacket(org.bukkit.entity.Player receiver, PacketContainer packet, NetworkMarker marker, boolean filters) Send a packet to the given player.
void	setAsynchronousManager(AsynchronousManager asyncManager) Update the asynchronous manager.
void	setDebug(boolean debug) Set whether or not debug mode is enabled.
protected void	setDelegate(InternalManager delegate) Update the delegate to the underlying manager.
void	setPlayerHook(PacketFilterManager.PlayerInjectHooks playerHook) Sets how the server packets are read.
void	updateEntity(org.bukkit.entity.Entity entity, java.util.List<org.bukkit.entity.Player> observers) Completely resend an entity to a list of clients.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REPORT_CANNOT_SEND_QUEUED_PACKET

public static final ReportType REPORT_CANNOT_SEND_QUEUED_PACKET

REPORT_CANNOT_REGISTER_QUEUED_LISTENER

public static final ReportType REPORT_CANNOT_REGISTER_QUEUED_LISTENER

Constructor Detail

DelayedPacketManager

public DelayedPacketManager(@Nonnull
                    ErrorReporter reporter,
                    @Nonnull
                    MinecraftVersion version)

Method Detail

getDelegate

public InternalManager getDelegate()

Retrieve the underlying protocol manager.

Returns:

The underlying manager.

getMinecraftVersion

public MinecraftVersion getMinecraftVersion()

Description copied from interface: ProtocolManager

Retrieve the current Minecraft version.

Specified by:

getMinecraftVersion in interface ProtocolManager

Returns:

The current version.

setDelegate

protected void setDelegate(InternalManager delegate)

Update the delegate to the underlying manager.

This will prompt this packet manager to immediately transmit and register all queued packets an listeners.

Parameters:

delegate - - delegate to the new manager.

setPlayerHook

public void setPlayerHook(PacketFilterManager.PlayerInjectHooks playerHook)

Description copied from interface: InternalManager

Sets how the server packets are read.

Specified by:

setPlayerHook in interface InternalManager

Parameters:

playerHook - - the new injection method for reading server packets.

getPlayerHook

public PacketFilterManager.PlayerInjectHooks getPlayerHook()

Description copied from interface: InternalManager

Retrieves how the server packets are read.

Specified by:

getPlayerHook in interface InternalManager

Returns:

Injection method for reading server packets.

sendServerPacket

public void sendServerPacket(org.bukkit.entity.Player receiver,
                    PacketContainer packet)
                      throws java.lang.reflect.InvocationTargetException

Description copied from interface: PacketStream

Send a packet to the given player.

Specified by:

sendServerPacket in interface PacketStream

Parameters:

receiver - - the reciever.

packet - - packet to send.

Throws:

java.lang.reflect.InvocationTargetException - - if an error occured when sending the packet.

sendServerPacket

public void sendServerPacket(org.bukkit.entity.Player receiver,
                    PacketContainer packet,
                    boolean filters)
                      throws java.lang.reflect.InvocationTargetException

Description copied from interface: ProtocolManager

Send a packet to the given player.

Re-sending a previously cancelled packet is discouraged. Use AsyncMarker.incrementProcessingDelay() to delay a packet until a certain condition has been met.

Specified by:

sendServerPacket in interface PacketStream

Specified by:

sendServerPacket in interface ProtocolManager

Parameters:

receiver - - the receiver.

packet - - packet to send.

filters - - whether or not to invoke any packet filters below ListenerPriority.MONITOR.

Throws:

java.lang.reflect.InvocationTargetException - - if an error occurred when sending the packet.

sendServerPacket

public void sendServerPacket(org.bukkit.entity.Player receiver,
                    PacketContainer packet,
                    NetworkMarker marker,
                    boolean filters)
                      throws java.lang.reflect.InvocationTargetException

Description copied from interface: PacketStream

Send a packet to the given player.

Specified by:

sendServerPacket in interface PacketStream

Parameters:

receiver - - the receiver.

packet - - packet to send.

marker - - the network marker to use.

filters - - whether or not to invoke any packet filters below ListenerPriority.MONITOR.

Throws:

java.lang.reflect.InvocationTargetException - - if an error occured when sending the packet.

recieveClientPacket

public void recieveClientPacket(org.bukkit.entity.Player sender,
                       PacketContainer packet)
                         throws java.lang.IllegalAccessException,
                                java.lang.reflect.InvocationTargetException

Description copied from interface: PacketStream

Simulate recieving a certain packet from a given player.

Specified by:

recieveClientPacket in interface PacketStream

Parameters:

sender - - the sender.

packet - - the packet that was sent.

Throws:

java.lang.IllegalAccessException - If the underlying method caused an error.

java.lang.reflect.InvocationTargetException - If the reflection machinery failed.

recieveClientPacket

public void recieveClientPacket(org.bukkit.entity.Player sender,
                       PacketContainer packet,
                       boolean filters)
                         throws java.lang.IllegalAccessException,
                                java.lang.reflect.InvocationTargetException

Description copied from interface: ProtocolManager

Simulate receiving a certain packet from a given player.

Receiving a previously cancelled packet is discouraged. Use AsyncMarker.incrementProcessingDelay() to delay a packet until a certain condition has been met.

Specified by:

recieveClientPacket in interface PacketStream

Specified by:

recieveClientPacket in interface ProtocolManager

Parameters:

sender - - the sender.

packet - - the packet that was sent.

filters - - whether or not to invoke any packet filters below ListenerPriority.MONITOR.

Throws:

java.lang.IllegalAccessException - If the underlying method caused an error.

java.lang.reflect.InvocationTargetException - If the reflection machinery failed.

recieveClientPacket

public void recieveClientPacket(org.bukkit.entity.Player sender,
                       PacketContainer packet,
                       NetworkMarker marker,
                       boolean filters)
                         throws java.lang.IllegalAccessException,
                                java.lang.reflect.InvocationTargetException

Description copied from interface: PacketStream

Simulate recieving a certain packet from a given player.

Specified by:

recieveClientPacket in interface PacketStream

Parameters:

sender - - the sender.

packet - - the packet that was sent.

marker - - the network marker to use.

filters - - whether or not to invoke any packet filters below ListenerPriority.MONITOR.

Throws:

java.lang.IllegalAccessException - If the underlying method caused an error.

java.lang.reflect.InvocationTargetException - If the reflection machinery failed.

broadcastServerPacket

public void broadcastServerPacket(PacketContainer packet,
                         org.bukkit.entity.Entity entity,
                         boolean includeTracker)

Description copied from interface: ProtocolManager

Broadcast a packet to every player that is receiving information about a given entity.

This is usually every player in the same world within an observable distance. If the entity is a player, it will only be included if includeTracker is TRUE.

Specified by:

broadcastServerPacket in interface ProtocolManager

Parameters:

packet - - the packet to broadcast.

entity - - the entity whose trackers we will inform.

includeTracker - - whether or not to also transmit the packet to the entity, if it is a tracker.

broadcastServerPacket

public void broadcastServerPacket(PacketContainer packet,
                         org.bukkit.Location origin,
                         int maxObserverDistance)

Description copied from interface: ProtocolManager

Broadcast a packet to every player within the given maximum observer distance.

Specified by:

broadcastServerPacket in interface ProtocolManager

Parameters:

packet - - the packet to broadcast.

origin - - the origin to consider when calculating the distance to each observer.

maxObserverDistance - - the maximum distance to the origin.

broadcastServerPacket

public void broadcastServerPacket(PacketContainer packet)

Description copied from interface: ProtocolManager

Broadcast a given packet to every connected player on the server.

Specified by:

broadcastServerPacket in interface ProtocolManager

Parameters:

packet - - the packet to broadcast.

getPacketListeners

public com.google.common.collect.ImmutableSet<PacketListener> getPacketListeners()

Description copied from interface: ProtocolManager

Retrieves a list of every registered packet listener.

Specified by:

getPacketListeners in interface ProtocolManager

Returns:

Every registered packet listener.

addPacketListener

public void addPacketListener(PacketListener listener)

Description copied from interface: ProtocolManager

Adds a packet listener.

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.

Specified by:

addPacketListener in interface ProtocolManager

Parameters:

listener - - new packet listener.

removePacketListener

public void removePacketListener(PacketListener listener)

Description copied from interface: ProtocolManager

Removes a given packet listener.

Attempting to remove a listener that doesn't exist has no effect.

Specified by:

removePacketListener in interface ProtocolManager

Parameters:

listener - - the packet listener to remove.

removePacketListeners

public void removePacketListeners(org.bukkit.plugin.Plugin plugin)

Description copied from interface: ProtocolManager

Removes every listener associated with the given plugin.

Specified by:

removePacketListeners in interface ProtocolManager

Parameters:

plugin - - the plugin to unload.

createPacket

@Deprecated
public PacketContainer createPacket(int id)

Deprecated.

Description copied from interface: ProtocolManager

Constructs a new encapsulated Minecraft packet with the given ID.

Deprecated: Use ProtocolManager.createPacket(PacketType) instead.

Specified by:

createPacket in interface ProtocolManager

Parameters:

id - - packet ID.

Returns:

New encapsulated Minecraft packet.

createPacket

@Deprecated
public PacketContainer createPacket(int id,
                                      boolean forceDefaults)

Deprecated.

Description copied from interface: ProtocolManager

Constructs a new encapsulated Minecraft packet with the given ID.

If set to true, the forceDefaults option will force the system to automatically 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 forceDefaults option is true, the List or Set will be automatically created.

Deprecated: Use ProtocolManager.createPacket(PacketType, boolean) instead.

Specified by:

createPacket in interface ProtocolManager

Parameters:

id - - packet ID.

forceDefaults - - TRUE to use sensible defaults in most fields, FALSE otherwise.

Returns:

New encapsulated Minecraft packet.

createPacketConstructor

public PacketConstructor createPacketConstructor(int id,
                                        java.lang.Object... arguments)

Description copied from interface: ProtocolManager

Construct a packet using the special builtin Minecraft constructors.

Deprecated: Use ProtocolManager.createPacketConstructor(PacketType, Object...) instead.

Specified by:

createPacketConstructor in interface ProtocolManager

Parameters:

id - - the packet ID.

arguments - - arguments that will be passed to the constructor.

Returns:

The packet constructor.

createPacketConstructor

public PacketConstructor createPacketConstructor(PacketType type,
                                        java.lang.Object... arguments)

Description copied from interface: ProtocolManager

Construct a packet using the special builtin Minecraft constructors.

Specified by:

createPacketConstructor in interface ProtocolManager

arguments - - arguments that will be passed to the constructor.

Returns:

The packet constructor.

getSendingFilters

@Deprecated
public java.util.Set<java.lang.Integer> getSendingFilters()

Deprecated.

Description copied from interface: ProtocolManager

Retrieves a immutable set containing the ID of the sent server packets that will be observed by listeners.

Deprecated: Use ProtocolManager.getSendingFilterTypes() instead.

Specified by:

getSendingFilters in interface ProtocolManager

Returns:

Every filtered server packet.

getReceivingFilters

@Deprecated
public java.util.Set<java.lang.Integer> getReceivingFilters()

Deprecated.

Description copied from interface: ProtocolManager

Retrieves a immutable set containing the ID of the received client packets that will be observed by listeners.

Deprecated: Use ProtocolManager.getReceivingFilterTypes() instead.

Specified by:

getReceivingFilters in interface ProtocolManager

Returns:

Every filtered client packet.

createPacket

public PacketContainer createPacket(PacketType type)

Description copied from interface: ProtocolManager

Constructs a new encapsulated Minecraft packet with the given ID.

Specified by:

createPacket in interface ProtocolManager

Parameters:

type - - packet type.

Returns:

New encapsulated Minecraft packet.

createPacket

public PacketContainer createPacket(PacketType type,
                           boolean forceDefaults)

Description copied from interface: ProtocolManager

Constructs a new encapsulated Minecraft packet with the given ID.

If set to true, the forceDefaults option will force the system to automatically 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 forceDefaults option is true, the List or Set will be automatically created.

Specified by:

createPacket in interface ProtocolManager

Parameters:

type - - packet type.

forceDefaults - - TRUE to use sensible defaults in most fields, FALSE otherwise.

Returns:

New encapsulated Minecraft packet.

getSendingFilterTypes

public java.util.Set<PacketType> getSendingFilterTypes()

Description copied from interface: ProtocolManager

Retrieves a immutable set containing the type of the sent server packets that will be observed by listeners.

Specified by:

getSendingFilterTypes in interface ProtocolManager

Returns:

Every filtered server packet.

getReceivingFilterTypes

public java.util.Set<PacketType> getReceivingFilterTypes()

Description copied from interface: ProtocolManager

Retrieves a immutable set containing the type of the received client packets that will be observed by listeners.

Specified by:

getReceivingFilterTypes in interface ProtocolManager

Returns:

Every filtered client packet.

updateEntity

public void updateEntity(org.bukkit.entity.Entity entity,
                java.util.List<org.bukkit.entity.Player> observers)
                  throws FieldAccessException

Description copied from interface: ProtocolManager

Completely resend an entity to a list of clients.

Note that this method is NOT thread safe. If you call this method from anything but the main thread, it will throw an exception.

Specified by:

updateEntity in interface ProtocolManager

Parameters:

entity - - entity to refresh.

observers - - the clients to update.

Throws:

FieldAccessException

getEntityFromID

public org.bukkit.entity.Entity getEntityFromID(org.bukkit.World container,
                                       int id)
                                         throws FieldAccessException

Description copied from interface: ProtocolManager

Retrieve the associated entity.

Specified by:

getEntityFromID in interface ProtocolManager

Parameters:

container - - the world the entity belongs to.

id - - the unique ID of the entity.

Returns:

The associated entity.

Throws:

FieldAccessException - Reflection failed.

getEntityTrackers

public java.util.List<org.bukkit.entity.Player> getEntityTrackers(org.bukkit.entity.Entity entity)
                                                           throws FieldAccessException

Description copied from interface: ProtocolManager

Retrieve every client that is receiving information about a given entity.

Specified by:

getEntityTrackers in interface ProtocolManager

Parameters:

entity - - the entity that is being tracked.

Returns:

Every client/player that is tracking the given entity.

Throws:

FieldAccessException - If reflection failed.

isClosed

public boolean isClosed()

Description copied from interface: ProtocolManager

Determines whether or not this protocol manager has been disabled.

Specified by:

isClosed in interface ProtocolManager

Returns:

TRUE if it has, FALSE otherwise.

getAsynchronousManager

public AsynchronousManager getAsynchronousManager()

Description copied from interface: ProtocolManager

Retrieve the current asynchronous packet manager.

Specified by:

getAsynchronousManager in interface ProtocolManager

Returns:

Asynchronous packet manager.

isDebug

public boolean isDebug()

Description copied from interface: InternalManager

Determine if debug mode is enabled.

Specified by:

isDebug in interface InternalManager

Returns:

TRUE if it is, FALSE otherwise.

setDebug

public void setDebug(boolean debug)

Description copied from interface: InternalManager

Set whether or not debug mode is enabled.

Specified by:

setDebug in interface InternalManager

Parameters:

debug - - TRUE if it is, FALSE otherwise.

setAsynchronousManager

public void setAsynchronousManager(AsynchronousManager asyncManager)

Update the asynchronous manager. This must be set.

Parameters:

asyncManager - - the asynchronous manager.

registerEvents

public void registerEvents(org.bukkit.plugin.PluginManager manager,
                  org.bukkit.plugin.Plugin plugin)

Description copied from interface: InternalManager

Register this protocol manager on Bukkit.

Specified by:

registerEvents in interface InternalManager

Parameters:

manager - - Bukkit plugin manager that provides player join/leave events.

plugin - - the parent plugin.

close

public void close()

Description copied from interface: InternalManager

Called when ProtocolLib is closing.

Specified by:

close in interface InternalManager