com.comphenix.protocol.injector.player

Interface PlayerInjectionHandler

public interface PlayerInjectionHandler

Method Summary

Methods

Modifier and Type	Method and Description
void	addPacketHandler(int packetID) Add an underlying packet handler of the given ID.
void	checkListener(PacketListener listener) Determine if a listener is valid or not.
void	checkListener(java.util.Set<PacketListener> listeners) Determine if the given listeners are valid.
void	close() Close any lingering proxy injections.
Player	getPlayerByConnection(java.io.DataInputStream inputStream) Retrieve a player by its DataInput connection.
Player	getPlayerByConnection(java.io.DataInputStream inputStream, long playerTimeout, java.util.concurrent.TimeUnit unit) Retrieve a player by its DataInput connection.
PacketFilterManager.PlayerInjectHooks	getPlayerHook() Retrieves how the server packets are read.
PacketFilterManager.PlayerInjectHooks	getPlayerHook(GamePhase phase) Retrieves how the server packets are read.
java.util.Set<java.lang.Integer>	getSendingFilters() Retrieve the current list of registered sending listeners.
void	handleDisconnect(Player player) Invoke special routines for handling disconnect before a player is uninjected.
void	injectPlayer(Player player) Initialize a player hook, allowing us to read server packets.
void	processPacket(Player player, java.lang.Object mcPacket) Process a packet as if it were sent by the given player.
void	removePacketHandler(int packetID) Remove an underlying packet handler of ths ID.
void	scheduleDataInputRefresh(Player player) Inform the current PlayerInjector that it should update the DataInputStream next.
void	sendServerPacket(Player reciever, PacketContainer packet, boolean filters) Send the given packet to the given reciever.
void	setPlayerHook(GamePhase phase, PacketFilterManager.PlayerInjectHooks playerHook) Sets how the server packets are read.
void	setPlayerHook(PacketFilterManager.PlayerInjectHooks playerHook) Sets how the server packets are read.
boolean	uninjectPlayer(java.net.InetSocketAddress address) Unregisters a player by the given address.
boolean	uninjectPlayer(Player player) Unregisters the given player.

Method Detail

getPlayerHook

PacketFilterManager.PlayerInjectHooks getPlayerHook()

Retrieves how the server packets are read.

Returns:

Injection method for reading server packets.

getPlayerHook

PacketFilterManager.PlayerInjectHooks getPlayerHook(GamePhase phase)

Retrieves how the server packets are read.

Parameters:

phase - - the current game phase.

Returns:

Injection method for reading server packets.

setPlayerHook

void setPlayerHook(PacketFilterManager.PlayerInjectHooks playerHook)

Sets how the server packets are read.

Parameters:

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

setPlayerHook

void setPlayerHook(GamePhase phase,
                 PacketFilterManager.PlayerInjectHooks playerHook)

Sets how the server packets are read.

Parameters:

phase - - the current game phase.

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

addPacketHandler

void addPacketHandler(int packetID)

Add an underlying packet handler of the given ID.

Parameters:

packetID - - packet ID to register.

removePacketHandler

void removePacketHandler(int packetID)

Remove an underlying packet handler of ths ID.

Parameters:

packetID - - packet ID to unregister.

getPlayerByConnection

Player getPlayerByConnection(java.io.DataInputStream inputStream)
                             throws java.lang.InterruptedException

Retrieve a player by its DataInput connection.

Parameters:

inputStream - - the associated DataInput connection.

Returns:

The player.

Throws:

java.lang.InterruptedException - If the thread was interrupted during the wait.

getPlayerByConnection

Player getPlayerByConnection(java.io.DataInputStream inputStream,
                           long playerTimeout,
                           java.util.concurrent.TimeUnit unit)
                             throws java.lang.InterruptedException

Retrieve a player by its DataInput connection.

Parameters:

inputStream - - the associated DataInput connection.

playerTimeout - - the amount of time to wait for a result.

unit - - unit of playerTimeout.

Returns:

The player.

Throws:

java.lang.InterruptedException - If the thread was interrupted during the wait.

injectPlayer

void injectPlayer(Player player)

Initialize a player hook, allowing us to read server packets.

This call will be ignored if there's no listener that can receive the given events.

Parameters:

player - - player to hook.

handleDisconnect

void handleDisconnect(Player player)

Invoke special routines for handling disconnect before a player is uninjected.

Parameters:

player - - player to process.

uninjectPlayer

boolean uninjectPlayer(Player player)

Unregisters the given player.

Parameters:

player - - player to unregister.

Returns:

TRUE if a player has been uninjected, FALSE otherwise.

uninjectPlayer

boolean uninjectPlayer(java.net.InetSocketAddress address)

Unregisters a player by the given address.

If the server handler has been created before we've gotten a chance to unject the player, the method will try a workaround to remove the injected hook in the NetServerHandler.

Parameters:

address - - address of the player to unregister.

Returns:

TRUE if a player has been uninjected, FALSE otherwise.

sendServerPacket

void sendServerPacket(Player reciever,
                    PacketContainer packet,
                    boolean filters)
                      throws java.lang.reflect.InvocationTargetException

Send the given packet to the given reciever.

Parameters:

reciever - - the player receiver.

packet - - the packet to send.

filters - - whether or not to invoke the packet filters.

Throws:

java.lang.reflect.InvocationTargetException - If an error occured during sending.

processPacket

void processPacket(Player player,
                 java.lang.Object mcPacket)
                   throws java.lang.IllegalAccessException,
                          java.lang.reflect.InvocationTargetException

Process a packet as if it were sent by the given player.

Parameters:

player - - the sender.

mcPacket - - the packet to process.

Throws:

java.lang.IllegalAccessException - If the reflection machinery failed.

java.lang.reflect.InvocationTargetException - If the underlying method caused an error.

checkListener

void checkListener(java.util.Set<PacketListener> listeners)

Determine if the given listeners are valid.

Parameters:

listeners - - listeners to check.

checkListener

void checkListener(PacketListener listener)

Determine if a listener is valid or not.

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

Parameters:

listener - - listener to check.

getSendingFilters

java.util.Set<java.lang.Integer> getSendingFilters()

Retrieve the current list of registered sending listeners.

Returns:

List of the sending listeners's packet IDs.

close

void close()

Close any lingering proxy injections.

scheduleDataInputRefresh

void scheduleDataInputRefresh(Player player)

Inform the current PlayerInjector that it should update the DataInputStream next.

Parameters:

player - - the player to update.