at.chrl.nutils.network.packet

Class BaseClientPacket<T extends AConnection>

java.lang.Object

at.chrl.nutils.network.packet.BasePacket

at.chrl.nutils.network.packet.BaseClientPacket<T>

Type Parameters:

T - AConnection - owner of this client packet.

All Implemented Interfaces:

Runnable

public abstract class BaseClientPacket<T extends AConnection>
extends BasePacket
implements Runnable

Base class for every Client Packet

Author:

-Nemesiss-

Nested Class Summary

Nested classes/interfaces inherited from class at.chrl.nutils.network.packet.BasePacket

BasePacket.PacketType

Field Summary

Fields inherited from class at.chrl.nutils.network.packet.BasePacket

TYPE_PATTERN

Constructor Summary

Constructors

Constructor and Description
BaseClientPacket(ByteBuffer buf, int opcode) Constructs a new client packet with specified id and data buffer.
BaseClientPacket(int opcode) Constructs a new client packet with specified id.

Method Summary

Modifier and Type	Method and Description
T	getConnection()
int	getRemainingBytes()
boolean	read() This method reads data from a packet buffer.
protected byte[]	readB(int length) Read n bytes from this packet buffer, n = length.
protected int	readC() Read byte from this packet buffer.
protected int	readD() Read int from this packet buffer.
protected double	readDF() Read double from this packet buffer.
protected float	readF() Read double from this packet buffer.
protected int	readH() Read short from this packet buffer.
protected abstract void	readImpl() Data reading implementation
protected long	readQ() Read long from this packet buffer.
protected String	readS() Read String from this packet buffer.
protected abstract void	runImpl() Execute this packet action.
void	setBuffer(ByteBuffer buf) Attach ByteBuffer to this packet.
void	setConnection(T client) Attach client connection to this packet.

Methods inherited from class at.chrl.nutils.network.packet.BasePacket

getOpcode, getPacketName, getPacketType, setOpcode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Runnable

run

Constructor Detail

BaseClientPacket

public BaseClientPacket(ByteBuffer buf,
                        int opcode)

Constructs a new client packet with specified id and data buffer.

Parameters:

buf - packet data container.

opcode - packet opcode.

BaseClientPacket

public BaseClientPacket(int opcode)

Constructs a new client packet with specified id. ByteBuffer must be later set with setBuffer method.

Parameters:

opcode - packet opcode.

Method Detail

setBuffer

public void setBuffer(ByteBuffer buf)

Attach ByteBuffer to this packet.

Parameters:

buf -

setConnection

public void setConnection(T client)

Attach client connection to this packet.

Parameters:

client -

read

public final boolean read()

This method reads data from a packet buffer. If the error occurred while reading data, the connection is closed.

Returns:

true if reading was successful, otherwise false

readImpl

protected abstract void readImpl()

Data reading implementation

getRemainingBytes

public final int getRemainingBytes()

Returns:

number of bytes remaining in this packet buffer.

readD

protected final int readD()

Read int from this packet buffer.

Returns:

int

readC

protected final int readC()

Read byte from this packet buffer.

Returns:

int

readH

protected final int readH()

Read short from this packet buffer.

Returns:

int

readDF

protected final double readDF()

Read double from this packet buffer.

Returns:

double

readF

protected final float readF()

Read double from this packet buffer.

Returns:

double

readQ

protected final long readQ()

Read long from this packet buffer.

Returns:

long

readS

protected final String readS()

Read String from this packet buffer.

Returns:

String

readB

protected final byte[] readB(int length)

Read n bytes from this packet buffer, n = length.

Parameters:

length -

Returns:

byte[]

runImpl

protected abstract void runImpl()

Execute this packet action.

getConnection

public final T getConnection()

Returns:

Connection that is owner of this packet.