com.comphenix.protocol.injector

Class DelayedPacketManager

java.lang.Object

com.comphenix.protocol.injector.DelayedPacketManager

All Implemented Interfaces:

InternalManager, PacketStream, ProtocolManager

public class DelayedPacketManager
extends Object
implements 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
static ReportType	REPORT_CANNOT_SEND_QUEUED_WIRE_PACKET

Constructor Summary

Constructors

Constructor and Description
DelayedPacketManager(ErrorReporter reporter, MinecraftVersion version)

Method Summary

Modifier and Type	Method and Description
void	addPacketListener(PacketListener listener)
void	broadcastServerPacket(PacketContainer packet)
void	broadcastServerPacket(PacketContainer packet, org.bukkit.entity.Entity entity, boolean includeTracker)
void	broadcastServerPacket(PacketContainer packet, org.bukkit.Location origin, int maxObserverDistance)
void	close() Called when ProtocolLib is closing.
PacketContainer	createPacket(int id) Deprecated.
PacketContainer	createPacket(int id, boolean forceDefaults) Deprecated.
PacketContainer	createPacket(PacketType type)
PacketContainer	createPacket(PacketType type, boolean forceDefaults)
PacketConstructor	createPacketConstructor(int id, Object... arguments)
PacketConstructor	createPacketConstructor(PacketType type, Object... arguments)
AsynchronousManager	getAsynchronousManager()
InternalManager	getDelegate() Retrieve the underlying protocol manager.
org.bukkit.entity.Entity	getEntityFromID(org.bukkit.World container, int id)
List<org.bukkit.entity.Player>	getEntityTrackers(org.bukkit.entity.Entity entity)
MinecraftVersion	getMinecraftVersion()
com.google.common.collect.ImmutableSet<PacketListener>	getPacketListeners()
PlayerInjectHooks	getPlayerHook() Retrieves how the server packets are read.
int	getProtocolVersion(org.bukkit.entity.Player player)
Set<Integer>	getReceivingFilters() Deprecated.
Set<PacketType>	getReceivingFilterTypes()
Set<Integer>	getSendingFilters() Deprecated.
Set<PacketType>	getSendingFilterTypes()
boolean	isClosed()
boolean	isDebug() Determine if debug mode is enabled.
void	recieveClientPacket(org.bukkit.entity.Player sender, PacketContainer packet)
void	recieveClientPacket(org.bukkit.entity.Player sender, PacketContainer packet, boolean filters)
void	recieveClientPacket(org.bukkit.entity.Player sender, PacketContainer packet, NetworkMarker marker, boolean filters)
void	registerEvents(org.bukkit.plugin.PluginManager manager, org.bukkit.plugin.Plugin plugin) Register this protocol manager on Bukkit.
void	removePacketListener(PacketListener listener)
void	removePacketListeners(org.bukkit.plugin.Plugin plugin)
void	sendServerPacket(org.bukkit.entity.Player receiver, PacketContainer packet)
void	sendServerPacket(org.bukkit.entity.Player receiver, PacketContainer packet, boolean filters)
void	sendServerPacket(org.bukkit.entity.Player receiver, PacketContainer packet, NetworkMarker marker, boolean filters)
void	sendWirePacket(org.bukkit.entity.Player receiver, int id, byte[] bytes)
void	sendWirePacket(org.bukkit.entity.Player receiver, WirePacket packet)
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(PlayerInjectHooks playerHook) Sets how the server packets are read.
void	updateEntity(org.bukkit.entity.Entity entity, List<org.bukkit.entity.Player> observers)
void	verifyWhitelist(PacketListener listener, ListeningWhitelist whitelist)

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_SEND_QUEUED_WIRE_PACKET

public static final ReportType REPORT_CANNOT_SEND_QUEUED_WIRE_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.

getProtocolVersion

public int getProtocolVersion(org.bukkit.entity.Player player)

Specified by:

getProtocolVersion in interface ProtocolManager

getMinecraftVersion

public MinecraftVersion getMinecraftVersion()

Specified by:

getMinecraftVersion in interface ProtocolManager

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(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 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 InvocationTargetException

Specified by:

sendServerPacket in interface PacketStream

Throws:

InvocationTargetException

sendServerPacket

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

Specified by:

sendServerPacket in interface PacketStream

Specified by:

sendServerPacket in interface ProtocolManager

Throws:

InvocationTargetException

sendServerPacket

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

Specified by:

sendServerPacket in interface PacketStream

Throws:

InvocationTargetException

sendWirePacket

public void sendWirePacket(org.bukkit.entity.Player receiver,
                           int id,
                           byte[] bytes)
                    throws InvocationTargetException

Specified by:

sendWirePacket in interface PacketStream

Throws:

InvocationTargetException

sendWirePacket

public void sendWirePacket(org.bukkit.entity.Player receiver,
                           WirePacket packet)
                    throws InvocationTargetException

Specified by:

sendWirePacket in interface PacketStream

Throws:

InvocationTargetException

recieveClientPacket

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

Specified by:

recieveClientPacket in interface PacketStream

Throws:

IllegalAccessException

InvocationTargetException

recieveClientPacket

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

Specified by:

recieveClientPacket in interface PacketStream

Specified by:

recieveClientPacket in interface ProtocolManager

Throws:

IllegalAccessException

InvocationTargetException

recieveClientPacket

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

Specified by:

recieveClientPacket in interface PacketStream

Throws:

IllegalAccessException

InvocationTargetException

broadcastServerPacket

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

Specified by:

broadcastServerPacket in interface ProtocolManager

broadcastServerPacket

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

Specified by:

broadcastServerPacket in interface ProtocolManager

broadcastServerPacket

public void broadcastServerPacket(PacketContainer packet)

Specified by:

broadcastServerPacket in interface ProtocolManager

getPacketListeners

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

Specified by:

getPacketListeners in interface ProtocolManager

addPacketListener

public void addPacketListener(PacketListener listener)

Specified by:

addPacketListener in interface ProtocolManager

removePacketListener

public void removePacketListener(PacketListener listener)

Specified by:

removePacketListener in interface ProtocolManager

removePacketListeners

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

Specified by:

removePacketListeners in interface ProtocolManager

createPacket

@Deprecated
public PacketContainer createPacket(int id)

Deprecated.

Specified by:

createPacket in interface ProtocolManager

createPacket

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

Deprecated.

Specified by:

createPacket in interface ProtocolManager

createPacketConstructor

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

Specified by:

createPacketConstructor in interface ProtocolManager

createPacketConstructor

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

Specified by:

createPacketConstructor in interface ProtocolManager

getSendingFilters

@Deprecated
public Set<Integer> getSendingFilters()

Deprecated.

Specified by:

getSendingFilters in interface ProtocolManager

getReceivingFilters

@Deprecated
public Set<Integer> getReceivingFilters()

Deprecated.

Specified by:

getReceivingFilters in interface ProtocolManager

createPacket

public PacketContainer createPacket(PacketType type)

Specified by:

createPacket in interface ProtocolManager

createPacket

public PacketContainer createPacket(PacketType type,
                                    boolean forceDefaults)

Specified by:

createPacket in interface ProtocolManager

getSendingFilterTypes

public Set<PacketType> getSendingFilterTypes()

Specified by:

getSendingFilterTypes in interface ProtocolManager

getReceivingFilterTypes

public Set<PacketType> getReceivingFilterTypes()

Specified by:

getReceivingFilterTypes in interface ProtocolManager

updateEntity

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

Specified by:

updateEntity in interface ProtocolManager

Throws:

FieldAccessException

getEntityFromID

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

Specified by:

getEntityFromID in interface ProtocolManager

Throws:

FieldAccessException

getEntityTrackers

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

Specified by:

getEntityTrackers in interface ProtocolManager

Throws:

FieldAccessException

isClosed

public boolean isClosed()

Specified by:

isClosed in interface ProtocolManager

getAsynchronousManager

public AsynchronousManager getAsynchronousManager()

Specified by:

getAsynchronousManager in interface ProtocolManager

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

verifyWhitelist

public void verifyWhitelist(PacketListener listener,
                            ListeningWhitelist whitelist)

Specified by:

verifyWhitelist in interface ProtocolManager