info.pppc.base.plugin.ip.util

Class IPPacketConnector

java.lang.Object

info.pppc.base.plugin.ip.util.IPPacketConnector

All Implemented Interfaces:

IOperation, IConnector, IPacketConnector

public class IPPacketConnector
extends java.lang.Object
implements IPacketConnector, IOperation

A connector that encapsulates a datagram socket. The ip transceiver plug-ins use datagram sockets to provide packet-based communication groups.

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
IPPacketConnector(IIPPlugin plugin, java.net.DatagramSocket socket, java.net.InetAddress group, int length) Creates a new packet connector that broadcasts messages using the specified datagram socket.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPacketListener(int type, IListener listener) Adds a listener for the specified events.
IPacket	createPacket() Creates a packet that can be used to transfer and receive data from the connector.
int	getPacketLength() Returns the packet length.
IPlugin	getPlugin() Returns the ip transceiver plug-in as parent of this plug-in.
void	perform(IMonitor monitor) Called to run the receiving thread.
void	release() Releases the socket and removes the connector from the list of connectors.
boolean	removePacketListener(int type, IListener listener) Removes the specified listener for the specified events.
void	sendPacket(IPacket packet) Transfers a packet using the underlying socket.

Methods inherited from class java.lang.Object

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

Constructor Detail

IPPacketConnector

public IPPacketConnector(IIPPlugin plugin,
                 java.net.DatagramSocket socket,
                 java.net.InetAddress group,
                 int length)

Creates a new packet connector that broadcasts messages using the specified datagram socket.

Parameters:

socket - The socket used to broadcast messages.

length - The maximum packet length.

plugin - The creating plug-in.

group - The group id.

Method Detail

createPacket

public IPacket createPacket()
                     throws java.io.IOException

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

Specified by:

createPacket in interface IPacketConnector

Returns:

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

Throws:

java.io.IOException - Thrown if the connector is released.

getPlugin

public IPlugin getPlugin()

Returns the ip transceiver plug-in as parent of this plug-in.

Specified by:

getPlugin in interface IConnector

Returns:

The ip transceiver plug-in

sendPacket

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

Transfers a packet using the underlying socket. If the operation fails, an exception will be thrown.

Specified by:

sendPacket in interface IPacketConnector

Parameters:

packet - The packet to transfer.

Throws:

java.io.IOException - Thrown if the operation failed.

addPacketListener

public void addPacketListener(int type,
                     IListener listener)

Adds a listener for the specified events.

Specified by:

addPacketListener in interface IPacketConnector

Parameters:

type - The events to listen for.

listener - The listener to add.

removePacketListener

public boolean removePacketListener(int type,
                           IListener listener)

Removes the specified listener for the specified events.

Specified by:

removePacketListener in interface IPacketConnector

Parameters:

type - The types of events.

listener - The listener to remove.

Returns:

True if removed, false otherwise.

getPacketLength

public int getPacketLength()

Returns the packet length.

Specified by:

getPacketLength in interface IPacketConnector

Returns:

The maximum packet length.

perform

public void perform(IMonitor monitor)

Called to run the receiving thread.

Specified by:

perform in interface IOperation

Parameters:

monitor - The monitor to abort the operation.

release

public void release()

Releases the socket and removes the connector from the list of connectors.

Specified by:

release in interface IConnector