info.pppc.base.system.plugin

Class GroupConnector

java.lang.Object

info.pppc.base.system.plugin.GroupConnector

All Implemented Interfaces:

IListener, IConnector, IPacketConnector

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

The group packet connector is used to multiplex packet connectors. It adds a group identifier as prefix to the packet to multiplex the individual channels.

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
GroupConnector(int length, short group) Creates a new packet connector that transfers and receives data.
GroupConnector(int length, short group, java.lang.Short ability) Creates a new packet connector that transfers and receives data.

Method Summary

Methods

Modifier and Type	Method and Description
void	addConnector(IPacketConnector c) Adds the specified packet connector to the set of connectors used by this connector.
void	addPacketListener(int type, IListener listener) Adds a packet listener for the specified type of events.
IPacket	createPacket() Creates a new packet that can be used to receive and transfer data from this packet connector.
java.lang.Short	getAbility() Returns the ability or null.
short	getGroup() Returns the group of the packet connector.
int	getPacketLength() Returns the maximum packet length.
IPlugin	getPlugin() Returns the plug-in that created the connector.
void	handleEvent(Event event) Called by the underlying connectors to signal an incoming packet or a closed connector.
void	release() Releases the specified packet connector and removes all references.
void	removeConnector(IPacketConnector c) Adds the specified packet connector to the set of connectors used by this connector.
boolean	removePacketListener(int type, IListener listener) Removes a listener for the specified type of events.
void	sendPacket(IPacket packet) Transfers a packet through this packet connector.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupConnector

public GroupConnector(int length,
              short group)

Creates a new packet connector that transfers and receives data.

Parameters:

group - The group of the connector.

length - The maximum packet length that shall be supported. If a connector does not support this length, this connector will start fragmenting the connector.

GroupConnector

public GroupConnector(int length,
              short group,
              java.lang.Short ability)

Creates a new packet connector that transfers and receives data.

Parameters:

group - The group of the connector.

ability - The ability of the connector.

length - The maximum packet length that shall be supported. If a connector does not support this length, this connector will start fragmenting the connector.

Method Detail

getPacketLength

public int getPacketLength()

Returns the maximum packet length.

Specified by:

getPacketLength in interface IPacketConnector

Returns:

The maximum packet length.

addPacketListener

public void addPacketListener(int type,
                     IListener listener)

Adds a packet listener for the specified type of events.

Specified by:

addPacketListener in interface IPacketConnector

Parameters:

type - The event types.

listener - The listener to register.

removePacketListener

public boolean removePacketListener(int type,
                           IListener listener)

Removes a listener for the specified type of events.

Specified by:

removePacketListener in interface IPacketConnector

Parameters:

type - The type of events.

listener - The listener to remove.

Returns:

True if removed, false otherwise.

handleEvent

public void handleEvent(Event event)

Called by the underlying connectors to signal an incoming packet or a closed connector.

Specified by:

handleEvent in interface IListener

Parameters:

event - The event created by one of the underlying connectors.

addConnector

public void addConnector(IPacketConnector c)

Adds the specified packet connector to the set of connectors used by this connector.

Parameters:

c - The packet connector to add.

removeConnector

public void removeConnector(IPacketConnector c)

Adds the specified packet connector to the set of connectors used by this connector.

Parameters:

c - The packet connector to add.

createPacket

public IPacket createPacket()
                     throws java.io.IOException

Creates a new packet that can be used to receive and transfer data from this packet connector.

Specified by:

createPacket in interface IPacketConnector

Returns:

A new packet used to receive and transfer data.

Throws:

java.io.IOException - Thrown if the connector is closed already.

sendPacket

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

Transfers a packet through this packet connector. If the packet connector has been closed already this method will throw an exception.

Specified by:

sendPacket in interface IPacketConnector

Parameters:

packet - The packet that should be transfered.

Throws:

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

release

public void release()

Releases the specified packet connector and removes all references.

Specified by:

release in interface IConnector

getGroup

public short getGroup()

Returns the group of the packet connector.

Returns:

The group of the connector.

getAbility

public java.lang.Short getAbility()

Returns the ability or null.

Returns:

The ability of the connector.

getPlugin

public IPlugin getPlugin()

Returns the plug-in that created the connector. This will be null since the connector has not been created by a plug-in.

Specified by:

getPlugin in interface IConnector

Returns:

This connector will return null.