com.comphenix.protocol.injector.netty

Class ProtocolInjector

java.lang.Object

com.comphenix.protocol.injector.netty.ProtocolInjector

All Implemented Interfaces:

ChannelListener

public class ProtocolInjector
extends Object
implements ChannelListener

Field Summary

Fields

Modifier and Type	Field and Description
static ReportType	REPORT_CANNOT_INJECT_INCOMING_CHANNEL

Constructor Summary

Constructors

Constructor and Description
ProtocolInjector(org.bukkit.plugin.Plugin plugin, ListenerInvoker invoker, ErrorReporter reporter)

Method Summary

Modifier and Type	Method and Description
void	close() Clean up any remaning injections.
PacketInjector	getPacketInjector() Retrieve a view of this protocol injector as a packet injector.
PlayerInjectionHandler	getPlayerInjector()
ErrorReporter	getReporter() Retrieve the current error reporter.
boolean	hasListener(Class<?> packetClass) Determine if there is a packet listener for the given packet.
boolean	hasMainThreadListener(Class<?> packetClass) Determine if there is a server packet listener that must be executed on the main thread.
boolean	includeBuffer(Class<?> packetClass) Determine if we need the buffer data of a given client side packet.
void	inject() Inject into the spigot connection class.
void	injectPlayer(org.bukkit.entity.Player player) Inject our packet handling into a specific player.
boolean	isDebug() Determine if debug mode is enabled.
PacketEvent	onPacketReceiving(Injector injector, Object packet, NetworkMarker marker) Invoked when a packet is being received from a client.
PacketEvent	onPacketSending(Injector injector, Object packet, NetworkMarker marker) Invoked when a packet is being sent to the client.
void	setDebug(boolean debug) Set whether or not the debug mode is enabled.

Methods inherited from class java.lang.Object

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

Field Detail

REPORT_CANNOT_INJECT_INCOMING_CHANNEL

public static final ReportType REPORT_CANNOT_INJECT_INCOMING_CHANNEL

Constructor Detail

ProtocolInjector

public ProtocolInjector(org.bukkit.plugin.Plugin plugin,
                        ListenerInvoker invoker,
                        ErrorReporter reporter)

Method Detail

isDebug

public boolean isDebug()

Description copied from interface: ChannelListener

Determine if debug mode is enabled.

Specified by:

isDebug in interface ChannelListener

Returns:

TRUE if it is, FALSE otherwise.

setDebug

public void setDebug(boolean debug)

Set whether or not the debug mode is enabled.

Parameters:

debug - - TRUE if it is, FALSE otherwise.

inject

public void inject()

Inject into the spigot connection class.

hasListener

public boolean hasListener(Class<?> packetClass)

Description copied from interface: ChannelListener

Determine if there is a packet listener for the given packet.

Specified by:

hasListener in interface ChannelListener

Parameters:

packetClass - - the packet class to check.

Returns:

TRUE if there is such a listener, FALSE otherwise.

hasMainThreadListener

public boolean hasMainThreadListener(Class<?> packetClass)

Description copied from interface: ChannelListener

Determine if there is a server packet listener that must be executed on the main thread.

Specified by:

hasMainThreadListener in interface ChannelListener

Parameters:

packetClass - - the packet class to check.

Returns:

TRUE if there is, FALSE otherwise.

getReporter

public ErrorReporter getReporter()

Description copied from interface: ChannelListener

Retrieve the current error reporter.

Specified by:

getReporter in interface ChannelListener

Returns:

The error reporter.

injectPlayer

public void injectPlayer(org.bukkit.entity.Player player)

Inject our packet handling into a specific player.

Parameters:

player - Player to inject into

close

public void close()

Clean up any remaning injections.

onPacketSending

public PacketEvent onPacketSending(Injector injector,
                                   Object packet,
                                   NetworkMarker marker)

Description copied from interface: ChannelListener

Invoked when a packet is being sent to the client.

This is invoked on the main thread.

Specified by:

onPacketSending in interface ChannelListener

Parameters:

injector - - the channel injector.

packet - - the packet.

marker - - the network marker.

Returns:

The packet even that was passed to the listeners, with a possible packet change, or NULL.

onPacketReceiving

public PacketEvent onPacketReceiving(Injector injector,
                                     Object packet,
                                     NetworkMarker marker)

Description copied from interface: ChannelListener

Invoked when a packet is being received from a client.

This is invoked on an asynchronous worker thread.

Specified by:

onPacketReceiving in interface ChannelListener

Parameters:

injector - - the channel injector.

packet - - the packet.

marker - - the associated network marker, if any.

Returns:

The packet even that was passed to the listeners, with a possible packet change, or NULL.

includeBuffer

public boolean includeBuffer(Class<?> packetClass)

Description copied from interface: ChannelListener

Determine if we need the buffer data of a given client side packet.

Specified by:

includeBuffer in interface ChannelListener

Parameters:

packetClass - - the packet class.

Returns:

TRUE if we do, FALSE otherwise.

getPlayerInjector

public PlayerInjectionHandler getPlayerInjector()

getPacketInjector

public PacketInjector getPacketInjector()

Retrieve a view of this protocol injector as a packet injector.

Returns:

The packet injector.