Package org.jcsp.net

Class LinkServer

java.lang.Object

org.jcsp.net.LinkServer

Direct Known Subclasses:

TCPIPLinkServer

public abstract class LinkServer
extends Object

An abstract class that must be implemented by communication protocol implementations. LinkServer objects are processes which listen on a certain address for connection requests. When a request is received, a Link should be spawned in server mode.

Field Summary

Fields

Modifier and Type	Field	Description
private final NodeAddressID	linkServerAddressID
private final ProtocolID	protocolID

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LinkServer(ProtocolID protocolID, NodeAddressID linkServerAddressID)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected static LinkServer	create(NodeAddressID addressID)	Create a server on a specifiedNodeAddressID, and start it.
protected final NodeAddressID	getLinkServerAddressID()	Protected accessor for obtaining the NodeAddressID on which this server is listening.
protected final ProtocolID	getProtocolID()	Gets the protocol that this LinkServer supports.
protected boolean	stop()	Stops the LinkServer.

Methods inherited from class java.lang.Object

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

Field Details

protocolID

private final ProtocolID protocolID

linkServerAddressID

private final NodeAddressID linkServerAddressID

Constructor Details

LinkServer

protected LinkServer(ProtocolID protocolID,
 NodeAddressID linkServerAddressID)

Constructor. A LinkServer must have an associated protocolID.

Parameters:

protocolID - The ProtocolID for the protocol that the concrete implementation of LinkServer supports.

linkServerAddressID - the NodeAddressID for this LinkServer to listen on.

Method Details

create

protected static LinkServer create(NodeAddressID addressID)

Create a server on a specifiedNodeAddressID, and start it. The server is spawned off in parallel, so this call returns immediately. This needs to be implemented by the concrete implementation of this class. This is not enforced by the compiler due to this being a static method. This NEEDS to be overridden.

Parameters:

addressID - The NodeAddressID to accept from

Returns:

the instance of LinkServer.

stop

protected boolean stop()

Stops the LinkServer. This NEEDS to be overridden.

Returns:

true iff the LinkServer has stopped.

getProtocolID

protected final ProtocolID getProtocolID()

Gets the protocol that this LinkServer supports.

Returns:

the ProtocolID representing this LinkServers protocol.

getLinkServerAddressID

protected final NodeAddressID getLinkServerAddressID()

Protected accessor for obtaining the NodeAddressID on which this server is listening.

Returns:

the NodeAddressID on which this server is listening.