Package yapion.packet

Class YAPIONPacket

java.lang.Object

yapion.packet.YAPIONPacket

Direct Known Subclasses:

DeserializationExceptionPacket, DropPacket, HandleFailedPacket, HeartBeatPacket, LostHeartBeatPacket

public abstract class YAPIONPacket
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
YAPIONPacket()

Method Summary

Modifier and Type	Method	Description
java.lang.Exception	getException()	The exception that was thrown by the YAPIONPacketHandler.handlePacket(YAPIONPacket) method.
java.lang.String	getType()	The type name returned by Class.getTypeName().
YAPIONPacketStream	getYAPIONPacketStream()	Returns the YAPIONOutputStream set by YAPIONSocket and is the OutputStream to the InputStream.
void	setYAPIONPacketStream(YAPIONPacketStream yapionPacketStream)	Set the YAPIONOutputStream that corresponds to the InputStream.
YAPIONObject	toYAPION()	Serialize this YAPIONPacket to a YAPIONObject.

Methods inherited from class java.lang.Object

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

Constructor Detail

YAPIONPacket

public YAPIONPacket()

Method Detail

toYAPION

public final YAPIONObject toYAPION()

Serialize this YAPIONPacket to a YAPIONObject.

Returns:

a YAPIONObject

getType

public final java.lang.String getType()

The type name returned by Class.getTypeName().

Returns:

result of Class.getTypeName()

getException

public final java.lang.Exception getException()

The exception that was thrown by the YAPIONPacketHandler.handlePacket(YAPIONPacket) method. You could for example log this Exception in the YAPIONPacketHandler set with YAPIONPacketReceiver.setHandler(YAPIONPacketReceiver.Handler, YAPIONPacketHandler), with YAPIONPacketReceiver.Handler.EXCEPTION.

Returns:

the Exception that was thrown

getYAPIONPacketStream

public final YAPIONPacketStream getYAPIONPacketStream()

Returns the YAPIONOutputStream set by YAPIONSocket and is the OutputStream to the InputStream.

Returns:

the YAPIONOutputStream set by YAPIONSocket

setYAPIONPacketStream

public final void setYAPIONPacketStream(YAPIONPacketStream yapionPacketStream)

Set the YAPIONOutputStream that corresponds to the InputStream. This normally gets called by YAPIONPacketStream and will be set to the YAPIONOutputStream by the YAPIONSocket corresponding to this.

Parameters:

yapionPacketStream - the YAPIONOutputStream to set