com.comphenix.protocol.injector.spigot

Class SpigotPacketInjector

java.lang.Object

com.comphenix.protocol.injector.spigot.SpigotPacketInjector

public class SpigotPacketInjector
extends Object

Offload all the work to Spigot, if possible.

Author:

Kristian

Field Summary

Fields

Modifier and Type	Field and Description
static ReportType	REPORT_CANNOT_CLEANUP_SPIGOT

Constructor Summary

Constructors

Constructor and Description
SpigotPacketInjector(ErrorReporter reporter, ListenerInvoker invoker, org.bukkit.Server server) Create a new spigot injector.

Method Summary

Modifier and Type	Method and Description
static boolean	canUseSpigotListener() Determine if there is a Spigot packet listener.
void	cleanupAll() Invoked when the server is cleaning up.
ListenerInvoker	getInvoker() Retrieve the underlying listener invoker.
PacketInjector	getPacketInjector() Retrieve the dummy packet injection handler.
PlayerInjectionHandler	getPlayerHandler() Retrieve the dummy player injection handler.
PacketInjector	getProxyPacketInjector() Retrieve the real proxy packet injector.
boolean	hasRegistered() Determine if the Spigot packet listener has been registered.
Object	packetQueued(Object networkManager, Object connection, Object packet) Called when a packet is queued to be sent.
Object	packetReceived(Object networkManager, Object connection, Object packet) Called when a packet has been received and is about to be handled by the current Connection.
boolean	register(org.bukkit.plugin.Plugin plugin) Register the Spigot packet injector.
void	saveBuffered(Object handle, byte[] buffered) Save the buffered serialized input packet.
void	setProxyPacketInjector(PacketInjector proxyPacketInjector) Set the real proxy packet injector.

Methods inherited from class java.lang.Object

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

Field Detail

REPORT_CANNOT_CLEANUP_SPIGOT

public static final ReportType REPORT_CANNOT_CLEANUP_SPIGOT

Constructor Detail

SpigotPacketInjector

public SpigotPacketInjector(ErrorReporter reporter,
                            ListenerInvoker invoker,
                            org.bukkit.Server server)

Create a new spigot injector.

Parameters:

reporter - - error reporter

invoker - - listener invoker

server - - server

Method Detail

getInvoker

public ListenerInvoker getInvoker()

Retrieve the underlying listener invoker.

Returns:

The invoker.

setProxyPacketInjector

public void setProxyPacketInjector(PacketInjector proxyPacketInjector)

Set the real proxy packet injector.

Parameters:

proxyPacketInjector - - the real injector.

getProxyPacketInjector

public PacketInjector getProxyPacketInjector()

Retrieve the real proxy packet injector.

Returns:

The real injector.

canUseSpigotListener

public static boolean canUseSpigotListener()

Determine if there is a Spigot packet listener.

Returns:

Spigot packet listener.

register

public boolean register(org.bukkit.plugin.Plugin plugin)

Register the Spigot packet injector.

Parameters:

plugin - - the parent plugin.

Returns:

TRUE if we registered the plugin, FALSE otherwise.

hasRegistered

public boolean hasRegistered()

Determine if the Spigot packet listener has been registered.

Returns:

TRUE if it has, FALSE otherwise.

getPlayerHandler

public PlayerInjectionHandler getPlayerHandler()

Retrieve the dummy player injection handler.

Returns:

Dummy player injection handler.

getPacketInjector

public PacketInjector getPacketInjector()

Retrieve the dummy packet injection handler.

Returns:

Dummy packet injection handler.

saveBuffered

public void saveBuffered(Object handle,
                         byte[] buffered)

Save the buffered serialized input packet.

Parameters:

handle - - the associated packet.

buffered - - the buffere data to save.

packetReceived

public Object packetReceived(Object networkManager,
                             Object connection,
                             Object packet)

Called when a packet has been received and is about to be handled by the current Connection.

The returned packet will be the packet passed on for handling, or in the case of null being returned, not handled at all.

Parameters:

networkManager - - the NetworkManager receiving the packet

connection - - the connection which will handle the packet

packet - - the received packet

Returns:

the packet to be handled, or null to cancel

packetQueued

public Object packetQueued(Object networkManager,
                           Object connection,
                           Object packet)

Called when a packet is queued to be sent.

The returned packet will be the packet sent. In the case of null being returned, the packet will not be sent.

Parameters:

networkManager - - the NetworkManager which will send the packet

connection - - the connection which queued the packet

packet - - the queue packet

Returns:

the packet to be sent, or null if the packet will not be sent.

cleanupAll

public void cleanupAll()

Invoked when the server is cleaning up.