gyurix.protocol

Class Protocol

java.lang.Object

gyurix.protocol.Protocol

All Implemented Interfaces:

org.bukkit.event.Listener

Direct Known Subclasses:

ProtocolImpl, ProtocolLegacyImpl

public abstract class Protocol
extends java.lang.Object
implements org.bukkit.event.Listener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Protocol.PacketInListener Interface used for listening to incoming packets
static interface	Protocol.PacketOutListener Interface used for listening to outgoing packets

Constructor Summary

Constructors

Constructor and Description
Protocol()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the PacketAPI
static void	dispatchPacketInEvent(PacketInEvent event) Dispatches an incoming packet event
static void	dispatchPacketOutEvent(PacketOutEvent event) Dispatches an outgoing packet event
abstract java.lang.Object	getChannel(org.bukkit.entity.Player plr) Returns the channel of a Player
abstract org.bukkit.entity.Player	getPlayer(java.lang.Object channel) Returns the Player belonging to the given channel
abstract void	init() Initializes the PacketAPI
abstract void	injectPlayer(org.bukkit.entity.Player plr)
abstract void	printPipeline(java.lang.Iterable<java.util.Map.Entry<java.lang.String,?>> pipeline)
abstract void	receivePacket(java.lang.Object channel, java.lang.Object packet) Simulates receiving the given vanilla packet from a channel
void	receivePacket(org.bukkit.entity.Player player, java.lang.Object packet) Simulates receiving the given vanilla packet from a player
void	registerIncomingListener(org.bukkit.plugin.Plugin plugin, Protocol.PacketInListener listener, PacketInType packetType) Registers an incoming packet listener
void	registerOutgoingListener(org.bukkit.plugin.Plugin plugin, Protocol.PacketOutListener listener, PacketOutType packetType) Registers an outgoing packet listener
abstract void	registerServerChannelHook()
abstract void	removeHandler(java.lang.Object ch, java.lang.String handler)
abstract void	sendPacket(java.lang.Object channel, java.lang.Object packet) Sends the given vanilla packet to a channel
void	sendPacket(org.bukkit.entity.Player player, java.lang.Object packet) Sends the given vanilla packet to a player
void	uninjectChannel(java.lang.Object ch)
void	uninjectPlayer(org.bukkit.entity.Player player)
void	unregisterIncomingListener(org.bukkit.plugin.Plugin pl) Unregisters ALL the incoming packet listeners of a plugin
void	unregisterIncomingListener(Protocol.PacketInListener listener)
void	unregisterOutgoingListener(org.bukkit.plugin.Plugin pl) Unregisters ALL the outgoing packet listeners of a plugin
void	unregisterOutgoingListener(Protocol.PacketOutListener listener)
abstract void	unregisterServerChannelHandler()

Methods inherited from class java.lang.Object

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

Constructor Detail

Protocol

public Protocol()

Method Detail

dispatchPacketInEvent

public static void dispatchPacketInEvent(PacketInEvent event)

Dispatches an incoming packet event

Parameters:

event - - The packet event

dispatchPacketOutEvent

public static void dispatchPacketOutEvent(PacketOutEvent event)

Dispatches an outgoing packet event

Parameters:

event - - The packet event

close

public void close()
           throws java.lang.Throwable

Closes the PacketAPI

Throws:

java.lang.Throwable

getChannel

public abstract java.lang.Object getChannel(org.bukkit.entity.Player plr)

Returns the channel of a Player

Parameters:

plr - - The target Player

Returns:

The channel of the target Player

getPlayer

public abstract org.bukkit.entity.Player getPlayer(java.lang.Object channel)

Returns the Player belonging to the given channel

Parameters:

channel - - The target Player

Returns:

The Player for who is the given channel belongs to, or null if the Channel and the Player object is not yet matched.

init

public abstract void init()
                   throws java.lang.Throwable

Initializes the PacketAPI

Throws:

java.lang.Throwable - if something failed in the initialization

injectPlayer

public abstract void injectPlayer(org.bukkit.entity.Player plr)

printPipeline

public abstract void printPipeline(java.lang.Iterable<java.util.Map.Entry<java.lang.String,?>> pipeline)

receivePacket

public void receivePacket(org.bukkit.entity.Player player,
                          java.lang.Object packet)

Simulates receiving the given vanilla packet from a player

Parameters:

player - - The sender player

packet - - The sendable packet

receivePacket

public abstract void receivePacket(java.lang.Object channel,
                                   java.lang.Object packet)

Simulates receiving the given vanilla packet from a channel

Parameters:

channel - - The sender players channel

packet - - The sendable packet

registerIncomingListener

public void registerIncomingListener(org.bukkit.plugin.Plugin plugin,
                                     Protocol.PacketInListener listener,
                                     PacketInType packetType)

Registers an incoming packet listener

Parameters:

plugin - - The plugin for which the listener belongs to

listener - - The packet listener

packetType - - The listenable packet type

registerOutgoingListener

public void registerOutgoingListener(org.bukkit.plugin.Plugin plugin,
                                     Protocol.PacketOutListener listener,
                                     PacketOutType packetType)

Registers an outgoing packet listener

Parameters:

plugin - - The plugin for which the listener belongs to

listener - - The packet listener

packetType - - The listenable packet type

registerServerChannelHook

public abstract void registerServerChannelHook()
                                        throws java.lang.Throwable

Throws:

java.lang.Throwable

removeHandler

public abstract void removeHandler(java.lang.Object ch,
                                   java.lang.String handler)

sendPacket

public void sendPacket(org.bukkit.entity.Player player,
                       java.lang.Object packet)

Sends the given vanilla packet to a player

Parameters:

player - - The target player

packet - - The sendable packet

sendPacket

public abstract void sendPacket(java.lang.Object channel,
                                java.lang.Object packet)

Sends the given vanilla packet to a channel

Parameters:

channel - - The target players channel

packet - - The sendable packet

uninjectChannel

public void uninjectChannel(java.lang.Object ch)

uninjectPlayer

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

unregisterIncomingListener

public void unregisterIncomingListener(org.bukkit.plugin.Plugin pl)

Unregisters ALL the incoming packet listeners of a plugin

Parameters:

pl - - Target plugin

unregisterIncomingListener

public void unregisterIncomingListener(Protocol.PacketInListener listener)

unregisterOutgoingListener

public void unregisterOutgoingListener(Protocol.PacketOutListener listener)

unregisterOutgoingListener

public void unregisterOutgoingListener(org.bukkit.plugin.Plugin pl)

Unregisters ALL the outgoing packet listeners of a plugin

Parameters:

pl - - Target plugin

unregisterServerChannelHandler

public abstract void unregisterServerChannelHandler()
                                             throws java.lang.IllegalAccessException

Throws:

java.lang.IllegalAccessException