info.pppc.base.plugin.common.util

Class FloodConnector

java.lang.Object

info.pppc.base.plugin.common.util.FloodConnector

All Implemented Interfaces:

IListener, IConnector, IPacketConnector

public class FloodConnector
extends java.lang.Object
implements IPacketConnector, IListener

The flood connector performs a scoped flooding for all packets that it receives. To eliminate broadcast storms it assigns packet ids and it maintains a buffer of a number of packets that have been received lately. To scope the flooding, a hop count is assigned to each packet.

Author:

Marcus Handte

Field Summary

Fields inherited from interface info.pppc.base.system.plugin.IPacketConnector

EVENT_PACKET_CLOSED, EVENT_PACKET_RECEIVED

Constructor Summary

Constructors

Constructor and Description
FloodConnector(IOperator operator, IPacketConnector connector) Creates a new flood connector that uses the specified connector as underlying implementation.
FloodConnector(IOperator operator, IPacketConnector connector, short scope) Creates a flood connector that uses the specified connector as underlying implementation.
FloodConnector(IOperator operator, IPacketConnector connector, short scope, int limit) Creates a flood connector that uses the specified connector as underlying implementation.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPacketListener(int type, IListener listener) Adds a packet listener for the specified set of events.
IPacket	createPacket() Creates a packet that can be used to send and receive data.
int	getPacketLength() Returns the maximum packet length.
IPlugin	getPlugin() Returns the plug-in that is associated with the underlying connector.
void	handleEvent(Event event) Called whenever the underlying connector creates an event.
void	release() Releases this connector as well as the underlying connector.
boolean	removePacketListener(int type, IListener listener) Removes a packet listener for the specified events.
void	sendPacket(IPacket packet) Sends the specified packet if possible.

Methods inherited from class java.lang.Object

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

Constructor Detail

FloodConnector

public FloodConnector(IOperator operator,
              IPacketConnector connector)

Creates a new flood connector that uses the specified connector as underlying implementation. The scope and the buffer limit will be set to default values.

Parameters:

operator - The operator to schedule new transmissions.

connector - The underlying connector used to transmit and receive packets.

Throws:

java.lang.NullPointerException - Thrown if the connector is null.

FloodConnector

public FloodConnector(IOperator operator,
              IPacketConnector connector,
              short scope)

Creates a flood connector that uses the specified connector as underlying implementation. The scope will be set to the specified value and the buffer limit will be set to the default value.

Parameters:

operator - The operator to schedule new transmissions.

connector - The connector used to receive and transmit packets.

scope - The flooding scope (i.e., the maximum hop count).

Throws:

java.lang.NullPointerException - Thrown if the connector is null.

java.lang.IllegalArgumentException - Thrown if the scope is not a positive value (excluding 0).

FloodConnector

public FloodConnector(IOperator operator,
              IPacketConnector connector,
              short scope,
              int limit)

Creates a flood connector that uses the specified connector as underlying implementation. The scope and the buffer limit will be set to the specified values.

Parameters:

operator - The operator to schedule new transmissions.

connector - The connector used to receive and transmit packets.

scope - The flooding scope (i.e., the maximum hop count).

limit - The maximum buffer size for packet ids.

Throws:

java.lang.NullPointerException - Thrown if the connector is null.

java.lang.IllegalArgumentException - Thrown if the scope or the buffer limit are not positive values (excluding 0).

Method Detail

addPacketListener

public void addPacketListener(int type,
                     IListener listener)

Adds a packet listener for the specified set of events.

Specified by:

addPacketListener in interface IPacketConnector

Parameters:

type - The type of events.

listener - The listener to add.

removePacketListener

public boolean removePacketListener(int type,
                           IListener listener)

Removes a packet listener for the specified events.

Specified by:

removePacketListener in interface IPacketConnector

Parameters:

type - The type of events to unregister.

listener - The listener to remove.

Returns:

True if removed, false otherwise.

createPacket

public IPacket createPacket()
                     throws java.io.IOException

Creates a packet that can be used to send and receive data.

Specified by:

createPacket in interface IPacketConnector

Returns:

A packet that can be used to send and receive data.

Throws:

java.io.IOException - Thrown if the packet cannot be created.

getPlugin

public IPlugin getPlugin()

Returns the plug-in that is associated with the underlying connector.

Specified by:

getPlugin in interface IConnector

Returns:

The plug-in of the underlying connector.

handleEvent

public void handleEvent(Event event)

Called whenever the underlying connector creates an event. Upon close event, the event is simply forwarded. Upon receive event, the packet is matched against the buffer and if it is not contained in the buffer, it will be delivered. In addition, if it needs to be broadcasted again, this will be done as well.

Specified by:

handleEvent in interface IListener

Parameters:

event - The event received from the underlying connector.

release

public void release()

Releases this connector as well as the underlying connector.

Specified by:

release in interface IConnector

sendPacket

public void sendPacket(IPacket packet)
                throws java.io.IOException

Sends the specified packet if possible. This method creates a header and adds it to the set of local headers before it transmits the method using the private send method.

Specified by:

sendPacket in interface IPacketConnector

Parameters:

packet - The packet that should be transfered.

Throws:

java.io.IOException - Thrown by the underlying connector.

getPacketLength

public int getPacketLength()

Returns the maximum packet length. The length is defined by the underlying connector - the length of the header that is needed for scoping and duplicate detection.

Specified by:

getPacketLength in interface IPacketConnector

Returns:

The packet length.