info.pppc.base.system.plugin

Class FragmentConnector

java.lang.Object

info.pppc.base.system.plugin.FragmentConnector

All Implemented Interfaces:

IListener, IConnector, IPacketConnector

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

The fragment connector is a wrapper for packet connectors that performs an automatic packet fragmentation and defragmentation. Thus, the size of the packets supported by this connector exceeds the packet size provided by the underlying connector. Note that the fragment connector is completely unreliable. Thus sending longer packets will result in less successful transmissions.

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
FragmentConnector(IPacketConnector connector) Creates a new fragment connector that uses the specified connector to send packets.
FragmentConnector(IPacketConnector connector, long timeout) Creates a new fragmenting packet connector that is capable of sending larger packets than the underlying connector.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPacketListener(int type, IListener listener) Adds a packet listener for the specified events.
IPacket	createPacket() Creates and returns a new packet for this connector.
int	getPacketLength() Returns the packet length that is supported by the connector.
IPlugin	getPlugin() Returns the plug-in of the underlying connector.
void	handleEvent(Event event) Called whenever the underlying connector is signaling a change.
void	release() Releases the underlying packet connector.
boolean	removePacketListener(int type, IListener listener) Removes a packet listener for the specified events.
void	sendPacket(IPacket packet) Sends a packet and throws an exception if the packet cannot be sent or if the connector has been closed already.

Methods inherited from class java.lang.Object

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

Constructor Detail

FragmentConnector

public FragmentConnector(IPacketConnector connector)

Creates a new fragment connector that uses the specified connector to send packets. The fragment timeout of the connector will be set to the default timeout value.

Parameters:

connector - The connector used to send packets.

Throws:

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

FragmentConnector

public FragmentConnector(IPacketConnector connector,
                 long timeout)

Creates a new fragmenting packet connector that is capable of sending larger packets than the underlying connector. The timeout value indicates the time after which the connector will drop incomplete fragments that have not been completed. If the timeout value is smaller or equal to zero an illegal argument exception will be thrown.

Parameters:

connector - The packet connector that is used to send and receive data.

timeout - The maximum interval that lies between two fragments. This value can be used to cleanup the buffer of the fragment connector.

Throws:

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

Method Detail

addPacketListener

public void addPacketListener(int type,
                     IListener listener)

Adds a packet listener for the specified 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.

listener - The listener to remove.

Returns:

True if removed, false otherwise.

createPacket

public IPacket createPacket()
                     throws java.io.IOException

Creates and returns a new packet for this connector.

Specified by:

createPacket in interface IPacketConnector

Returns:

A new packet for this connector.

Throws:

java.io.IOException - Thrown if the connector has been closed.

getPacketLength

public int getPacketLength()

Returns the packet length that is supported by the connector. The packet length of this connector depends on the underlying packet size - the length of the fragment header.

Specified by:

getPacketLength in interface IPacketConnector

Returns:

The packet length of the connector.

getPlugin

public IPlugin getPlugin()

Returns the plug-in of 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 is signaling a change.

Specified by:

handleEvent in interface IListener

Parameters:

event - The event to deal with.

release

public void release()

Releases the underlying packet connector.

Specified by:

release in interface IConnector

sendPacket

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

Sends a packet and throws an exception if the packet cannot be sent or if the connector has been closed already.

Specified by:

sendPacket in interface IPacketConnector

Parameters:

packet - The packet to send.

Throws:

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