com.comphenix.protocol.injector.spigot

Class AbstractPlayerHandler

java.lang.Object

com.comphenix.protocol.injector.spigot.AbstractPlayerHandler

All Implemented Interfaces:

PlayerInjectionHandler

public abstract class AbstractPlayerHandler
extends Object
implements PlayerInjectionHandler

Nested Class Summary

Nested classes/interfaces inherited from interface com.comphenix.protocol.injector.player.PlayerInjectionHandler

PlayerInjectionHandler.ConflictStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected PacketTypeSet	sendingFilters

Constructor Summary

Constructors

Constructor and Description
AbstractPlayerHandler(PacketTypeSet sendingFilters)

Method Summary

Modifier and Type	Method and Description
void	addPacketHandler(PacketType type, Set<ListenerOptions> options) Add an underlying packet handler of the given type.
boolean	canRecievePackets() Whether or not this player injection handler can also receive packets.
void	checkListener(PacketListener listener) Determine if a listener is valid or not.
void	checkListener(Set<PacketListener> listeners) Determine if the given listeners are valid.
void	close() Close any lingering proxy injections.
org.bukkit.entity.Player	getPlayerByConnection(DataInputStream inputStream) Retrieve a player by its DataInput connection.
PlayerInjectHooks	getPlayerHook() Retrieves how the server packets are read.
PlayerInjectHooks	getPlayerHook(GamePhase phase) Retrieves how the server packets are read.
Set<PacketType>	getSendingFilters() Retrieve the current list of registered sending listeners.
void	removePacketHandler(PacketType type) Remove an underlying packet handler of this type.
void	setPlayerHook(GamePhase phase, PlayerInjectHooks playerHook) Sets how the server packets are read.
void	setPlayerHook(PlayerInjectHooks playerHook) Sets how the server packets are read.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.comphenix.protocol.injector.player.PlayerInjectionHandler

getChannel, getProtocolVersion, handleDisconnect, handlePacketRecieved, hasMainThreadListener, injectPlayer, recieveClientPacket, sendServerPacket, uninjectPlayer, uninjectPlayer, updatePlayer

Field Detail

sendingFilters

protected PacketTypeSet sendingFilters

Constructor Detail

AbstractPlayerHandler

public AbstractPlayerHandler(PacketTypeSet sendingFilters)

Method Detail

setPlayerHook

public void setPlayerHook(GamePhase phase,
                          PlayerInjectHooks playerHook)

Description copied from interface: PlayerInjectionHandler

Sets how the server packets are read.

Specified by:

setPlayerHook in interface PlayerInjectionHandler

Parameters:

phase - - the current game phase.

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

setPlayerHook

public void setPlayerHook(PlayerInjectHooks playerHook)

Description copied from interface: PlayerInjectionHandler

Sets how the server packets are read.

Specified by:

setPlayerHook in interface PlayerInjectionHandler

Parameters:

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

addPacketHandler

public void addPacketHandler(PacketType type,
                             Set<ListenerOptions> options)

Description copied from interface: PlayerInjectionHandler

Add an underlying packet handler of the given type.

Specified by:

addPacketHandler in interface PlayerInjectionHandler

Parameters:

type - - packet type to register.

options - - any specified listener options.

removePacketHandler

public void removePacketHandler(PacketType type)

Description copied from interface: PlayerInjectionHandler

Remove an underlying packet handler of this type.

Specified by:

removePacketHandler in interface PlayerInjectionHandler

Parameters:

type - - packet type to unregister.

getSendingFilters

public Set<PacketType> getSendingFilters()

Description copied from interface: PlayerInjectionHandler

Retrieve the current list of registered sending listeners.

Specified by:

getSendingFilters in interface PlayerInjectionHandler

Returns:

List of the sending listeners's packet IDs.

close

public void close()

Description copied from interface: PlayerInjectionHandler

Close any lingering proxy injections.

Specified by:

close in interface PlayerInjectionHandler

getPlayerHook

public PlayerInjectHooks getPlayerHook(GamePhase phase)

Description copied from interface: PlayerInjectionHandler

Retrieves how the server packets are read.

Specified by:

getPlayerHook in interface PlayerInjectionHandler

Parameters:

phase - - the current game phase.

Returns:

Injection method for reading server packets.

canRecievePackets

public boolean canRecievePackets()

Description copied from interface: PlayerInjectionHandler

Whether or not this player injection handler can also receive packets.

Specified by:

canRecievePackets in interface PlayerInjectionHandler

Returns:

TRUE if it can, FALSE otherwise.

getPlayerHook

public PlayerInjectHooks getPlayerHook()

Description copied from interface: PlayerInjectionHandler

Retrieves how the server packets are read.

Specified by:

getPlayerHook in interface PlayerInjectionHandler

Returns:

Injection method for reading server packets.

getPlayerByConnection

public org.bukkit.entity.Player getPlayerByConnection(DataInputStream inputStream)
                                               throws InterruptedException

Description copied from interface: PlayerInjectionHandler

Retrieve a player by its DataInput connection.

Specified by:

getPlayerByConnection in interface PlayerInjectionHandler

Parameters:

inputStream - - the associated DataInput connection.

Returns:

The player.

Throws:

InterruptedException - If the thread was interrupted during the wait.

checkListener

public void checkListener(PacketListener listener)

Description copied from interface: PlayerInjectionHandler

Determine if a listener is valid or not.

If not, a warning will be printed to the console.

Specified by:

checkListener in interface PlayerInjectionHandler

Parameters:

listener - - listener to check.

checkListener

public void checkListener(Set<PacketListener> listeners)

Description copied from interface: PlayerInjectionHandler

Determine if the given listeners are valid.

Specified by:

checkListener in interface PlayerInjectionHandler

Parameters:

listeners - - listeners to check.