Package yapion.packet

Class YAPIONPacketReceiver

java.lang.Object

yapion.packet.YAPIONPacketReceiver

public class YAPIONPacketReceiver
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
YAPIONPacketReceiver()	Creates an YAPIONPacketReceiver

Method Summary

Modifier and Type	Method	Description
YAPIONPacketReceiver	add(java.lang.Class<? extends YAPIONPacket>[] packetTypes, YAPIONPacketHandler yapionPacketHandler)	Add an YAPIONPacketHandler for the specified packetTypes to handle.
YAPIONPacketReceiver	add(java.lang.Class<? extends YAPIONPacket> packetType, YAPIONPacketHandler yapionPacketHandler)	Add an YAPIONPacketHandler for a specified packetType to handle.
YAPIONPacketReceiver	add(YAPIONPacketHandler yapionPacketHandler, java.lang.Class<? extends YAPIONPacket> packetType)	A wrapper function to add(Class, YAPIONPacketHandler)
YAPIONPacketReceiver	add(YAPIONPacketHandler yapionPacketHandler, java.lang.Class<? extends YAPIONPacket>... packetTypes)	A wrapper function to add(Class[], YAPIONPacketHandler)
void	handle(YAPIONPacket yapionPacket)	Handles an YAPIONPacket by calling the specified yapionPacketHandler for the type of the packet.
YAPIONPacketReceiver	setDropHandler(YAPIONPacketHandler yapionPacketHandler)	Set the Drop YAPIONPacketHandler to do something when an date drop occurred.
YAPIONPacketReceiver	setErrorHandler(YAPIONPacketHandler yapionPacketHandler)	Set the Error YAPIONPacketHandler to do something when an error occurred.
YAPIONPacketReceiver	setExceptionHandler(YAPIONPacketHandler yapionPacketHandler)	Set the Exception YAPIONPacketHandler to do something when an exception gets thrown.
YAPIONPacketReceiver	setUnknownHandler(YAPIONPacketHandler yapionPacketHandler)	Set the Unknown YAPIONPacketHandler to do something when an unknown packet was handled occurred.

Methods inherited from class java.lang.Object

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

Constructor Detail

YAPIONPacketReceiver

public YAPIONPacketReceiver()

Creates an YAPIONPacketReceiver

Method Detail

add

public YAPIONPacketReceiver add(java.lang.Class<? extends YAPIONPacket> packetType,
                                YAPIONPacketHandler yapionPacketHandler)

Add an YAPIONPacketHandler for a specified packetType to handle. If either the packetType or yapionPacketHandler is null this method throws an YAPIONPacketException.

Parameters:

packetType - the packet to handle

yapionPacketHandler - the handler which handles the specified packet

add

public YAPIONPacketReceiver add(java.lang.Class<? extends YAPIONPacket>[] packetTypes,
                                YAPIONPacketHandler yapionPacketHandler)

Add an YAPIONPacketHandler for the specified packetTypes to handle. If either the yapionPacketHandler or the packetTypes itself is null this method throws an YAPIONPacketException. If any value in the packetTypes array is null it will just be skipped over.

Parameters:

packetTypes - the packets to handle

yapionPacketHandler - the handler which handles the specified packets

add

public YAPIONPacketReceiver add(YAPIONPacketHandler yapionPacketHandler,
                                java.lang.Class<? extends YAPIONPacket> packetType)

A wrapper function to add(Class, YAPIONPacketHandler)

add

public YAPIONPacketReceiver add(YAPIONPacketHandler yapionPacketHandler,
                                java.lang.Class<? extends YAPIONPacket>... packetTypes)

A wrapper function to add(Class[], YAPIONPacketHandler)

setExceptionHandler

public YAPIONPacketReceiver setExceptionHandler(YAPIONPacketHandler yapionPacketHandler)

Set the Exception YAPIONPacketHandler to do something when an exception gets thrown.

Parameters:

yapionPacketHandler - the YAPIONPacketHandler to set

setUnknownHandler

public YAPIONPacketReceiver setUnknownHandler(YAPIONPacketHandler yapionPacketHandler)

Set the Unknown YAPIONPacketHandler to do something when an unknown packet was handled occurred.

Parameters:

yapionPacketHandler -

setDropHandler

public YAPIONPacketReceiver setDropHandler(YAPIONPacketHandler yapionPacketHandler)

Set the Drop YAPIONPacketHandler to do something when an date drop occurred.

Parameters:

yapionPacketHandler -

setErrorHandler

public YAPIONPacketReceiver setErrorHandler(YAPIONPacketHandler yapionPacketHandler)

Set the Error YAPIONPacketHandler to do something when an error occurred.

Parameters:

yapionPacketHandler - the YAPIONPacketHandler to set

handle

public void handle(YAPIONPacket yapionPacket)

Handles an YAPIONPacket by calling the specified yapionPacketHandler for the type of the packet. If the packet type is not found the "@error" handler gets called. If any exception gets thrown the special "@exception" handler is called. If this also throws an exception this method will log the exception as a warning.

Parameters:

yapionPacket - to handle