info.pppc.base.system.plugin

Interface IPacketConnector

All Superinterfaces:

IConnector

All Known Implementing Classes:

FloodConnector, FragmentConnector, GroupConnector, IPPacketConnector

public interface IPacketConnector
extends IConnector

A packet connector is a connector that broadcasts packets. It supports a generic create method that enables the creation of packet that are used to send and receive data. Transmission of data to remote systems is supported via the send method. The reception is done via events in order to minimize the number of threads that are needed for reception. However, since some underlying thread will be used to signal the event, the code that handles it must be fast.

Author:

Marcus Handte

Field Summary

Fields

Modifier and Type	Field and Description
static int	EVENT_PACKET_CLOSED Event constant to signal that the packet connector has been closed.
static int	EVENT_PACKET_RECEIVED Event constant to signal that a packet has been received.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPacketListener(int type, IListener listener) Adds a packet listener to receive a particular event.
IPacket	createPacket() Creates a packet that can be used to receive and transfer data.
int	getPacketLength() Returns the maximum length of the packet.
boolean	removePacketListener(int type, IListener listener) Called to remove a listener for a specified set of events.
void	sendPacket(IPacket packet) Transfers a packet.

Methods inherited from interface info.pppc.base.system.plugin.IConnector

getPlugin, release

Field Detail

EVENT_PACKET_CLOSED

static final int EVENT_PACKET_CLOSED

Event constant to signal that the packet connector has been closed. The source of the event will be the connector and the data object will be null.

See Also:

Constant Field Values

EVENT_PACKET_RECEIVED

static final int EVENT_PACKET_RECEIVED

Event constant to signal that a packet has been received. The source of the event will be the connector and the data object will be the packet.

See Also:

Constant Field Values

Method Detail

addPacketListener

void addPacketListener(int type,
                     IListener listener)

Adds a packet listener to receive a particular event. The supported events are packet closed to signal that the connector has been closed and packet received to signal an incoming packet.

Parameters:

type - The type of the event.

listener - The listener to add.

removePacketListener

boolean removePacketListener(int type,
                           IListener listener)

Called to remove a listener for a specified set of events.

Parameters:

type - The type of the events.

listener - The listener to remove.

Returns:

True if successful, false otherwise.

createPacket

IPacket createPacket()
                     throws java.io.IOException

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

Returns:

The new packet that can receive or send the specified length.

Throws:

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

sendPacket

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

Transfers a packet. Note that the packet must have been created by the same connector. Otherwise the result is undefined.

Parameters:

packet - The packet that contains the payload that is transfered by the call.

Throws:

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

java.io.IOException - Thrown if the transmission failed. This can also be a result of a previously released connector.

getPacketLength

int getPacketLength()

Returns the maximum length of the packet.

Returns:

The maximum length of the packet.