ch.dermitza.securenio.packet.worker

Class AbstractPacketWorker

java.lang.Object

ch.dermitza.securenio.packet.worker.AbstractPacketWorker

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

SimplePacketWorker, VariableLengthPacketWorker

public abstract class AbstractPacketWorker
extends java.lang.Object
implements java.lang.Runnable

An abstract, extensible implementation of a Packet Worker. This thread waits for raw data arriving from remote peers through SocketIFs, adds them to respective queues and then reassembles packets based on the data in these queues. Each socket maintains a queue of data, for there is a possibility that the packets received are fragmented and cannot be reassembled during processing. In this case, processing should be delegated until additional data on that socket arrives.

Since:

0.18

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<SocketIF,java.nio.ByteBuffer>	pendingData Maps a SocketChannel to a list of ByteBuffer instances
protected java.util.ArrayDeque<SocketIF>	pendingSockets Sockets that need to be operated upon (i.e.

Constructor Summary

Constructors

Constructor and Description
AbstractPacketWorker()

Method Summary

Methods

Modifier and Type	Method and Description
void	addData(SocketIF socket, java.nio.ByteBuffer data, int count) Queue data received from a SocketIF for processing and reconstruction.
void	addListener(PacketListener listener) Allows registration of multiple PacketListeners to this AbstractPacketWorker.
protected void	fireListeners(SocketIF socket, PacketIF packet) Once a PacketIF has been completely reconstructed, registered listeners are notified via this method.
boolean	isRunning() Check whether the AbstractPacketWorker is running.
protected abstract void	processData() This is the main entry point of received data processing and reassembly.
void	removeListener(PacketListener listener) Allows de-registration of multiple PacketListeners from this AbstractPacketWorker.
void	run() The run() method of the AbstractPacketWorker.
void	setRunning(boolean running) Set the running status of the AbstractPacketWorker.

Methods inherited from class java.lang.Object

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

Field Detail

pendingData

protected final java.util.HashMap<SocketIF,java.nio.ByteBuffer> pendingData

Maps a SocketChannel to a list of ByteBuffer instances

pendingSockets

protected final java.util.ArrayDeque<SocketIF> pendingSockets

Sockets that need to be operated upon (i.e. have pending operations)

Constructor Detail

AbstractPacketWorker

public AbstractPacketWorker()

Method Detail

addData

public void addData(SocketIF socket,
           java.nio.ByteBuffer data,
           int count)

Queue data received from a SocketIF for processing and reconstruction. A deep copy of the passed ByteBuffer is made locally. Following, a data queue for that SocketIF is created if it does not exist, and the current piece of data received is added to that queue for later processing and reconstruction.

Parameters:

socket - The SocketIF data was received from

data - The ByteBuffer containing the data (bytes) received

count - The number of bytes received

See Also:

processData()

processData

protected abstract void processData()

This is the main entry point of received data processing and reassembly. This is left for the application layer to decide how to process raw incoming data

run

public void run()

The run() method of the AbstractPacketWorker. Here, sequential processing of data that need to be reconstructed and processed should be done in a FIFO fashion. The AbstractPacketWorker is otherwise waiting for incoming tasks via the addData(SocketIF, ByteBuffer, int) method.

Specified by:

run in interface java.lang.Runnable

isRunning

public boolean isRunning()

Check whether the AbstractPacketWorker is running.

Returns:

true if it is running, false otherwise

setRunning

public void setRunning(boolean running)

Set the running status of the AbstractPacketWorker. If the running status of the worker is set to false, the AbstractPacketWorker is interrupted (if waiting for a task) in order to cleanly shutdown.

Parameters:

running - Whether the PacketWorker should run or not

addListener

public void addListener(PacketListener listener)

Allows registration of multiple PacketListeners to this AbstractPacketWorker.

Parameters:

listener - The listener to register to this PacketWorker

removeListener

public void removeListener(PacketListener listener)

Allows de-registration of multiple PacketListeners from this AbstractPacketWorker.

Parameters:

listener - The listener to unregister from this PacketWorker

fireListeners

protected void fireListeners(SocketIF socket,
                 PacketIF packet)

Once a PacketIF has been completely reconstructed, registered listeners are notified via this method. This method creates a local copy of the already registered listeners when firing events, to avoid potential concurrent modification exceptions.

Parameters:

socket - The SocketIF a complete PacketIF is reconstructed

packet - The completely reconstructed AbstractPacket

See Also:

PacketListener.paketArrived(SocketIF, PacketIF)