stella.net.gregor

Class GetterSetter

java.lang.Object

util.PropertyContainer

io.AbstractDriver

io.AbstractSocketDriver

stella.net.gregor.CommunicationHandler

stella.net.gregor.GetterSetter

All Implemented Interfaces:

Driver, StreamIODriver, Cloneable, EventListener, MessageListener, ExitCleaning, Initializable, PropertySupplying

Direct Known Subclasses:

GregorDriver

public class GetterSetter
extends CommunicationHandler
implements MessageListener

This class now narrows the GREGOR communication down to two command, a get and a set command. In the versions sendSet and sendGet they are blocking until the entire command cycle has been completed.

Nested Class Summary

Nested classes/interfaces inherited from class stella.net.gregor.CommunicationHandler

CommunicationHandler.Test

Field Summary

Fields

Modifier and Type	Field and Description
private Map<Integer,CommunicationCycle>	active This is the lookup table of active commands.
private static long	DEFACKTIMEOUT Default value.
private static long	DEFGETTIMEOUT Default value.
private static boolean	DEFSTRICTGET Default value.
private static boolean	DEFSTRICTSET Default value.
static String	KEY_ACKTIMEOUT This key specifies the default acknowledge time out.
static String	KEY_GETTIMEOUT This key is the second reply timeout on getter commands.
static String	KEY_STRICTGET If this is true, only non-warning results are accepted for get.
static String	KEY_STRICTSET If this is true, only non-warning results are accepted for set.

Fields inherited from class stella.net.gregor.CommunicationHandler

KEY_RECEIVERWAIT, KEY_SENDERWAIT

Fields inherited from class io.AbstractSocketDriver

KEY_CLOSETIMEOUT, KEY_SOCKETPORT, KEY_SOCKETSERVER, KEY_SOCKETTIMEOUT

Fields inherited from class io.AbstractDriver

KEY_DRIVERNAME

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Constructor Summary

Constructors

Constructor and Description
GetterSetter(Map<String,String> prop) Constructs a new getter-setter communicator.

Method Summary

Modifier and Type	Method and Description
private CommunicationCycle	complete(CommandMessage cm) We initiate and wait.
CommandMessage	createGet(Object dest, String toget) We create a get command using the property acknowledge and completion time.
CommandMessage	createSet(Object dest, String toset, long donetime) We create a set command using the property acknowledge time.
protected List<String>	executeGet(CommandMessage cm) We issue a prepared getter function and wait for the result, which is returned as the cycle outcome.
List<String>	executeGet(Object dest, String toget) We issue a getter function and wait for the result, which is returned as the cycle outcome.
protected boolean	executeSet(CommandMessage cm) We issue a preparedsetter function and wait for the result, which is then interpret as a boolean.
boolean	executeSet(Object dest, String toset, long donetime) We issue a setter function and wait for the result, which is then interpret as a boolean.
void	init() On init, we create a new map of communication cycles.
protected CommunicationCycle	initiate(CommandMessage cm) We initiate sending a command.
void	messageReceived(Message m) If we receive a reply, we check if it belongs to one of the active command cycles.
protected boolean	removeCycle(CommandMessage cm) Removes the command cycle to this command if still in active list.
String	toString() We are lazy and just override the toString method.
protected void	waitForComplete(CommandMessage cm, CommunicationCycle cc) We wait for a command cycle to complete by synchronizing on the cycle object and issuing maximum two wait states on it.

Methods inherited from class stella.net.gregor.CommunicationHandler

close, putMessage, setMessageListener, startTransmission, stopTransmission

Methods inherited from class io.AbstractSocketDriver

authenticate, exit, getInputStream, getOutputStream, getSocket, isOpen, open, setTimeout

Methods inherited from class io.AbstractDriver

createDriver, equals, getDriverName, hashCode

Methods inherited from class util.PropertyContainer

augment, augment, augment, augment, augment, clone, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, initProperties, isNew, parseObject, parseObject, reload, reload, removeProperty, requires, rescanned, setObject, setProperties, setProperty, stringProperties

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.Driver

getDriverName

Field Detail

KEY_ACKTIMEOUT

public static final String KEY_ACKTIMEOUT

This key specifies the default acknowledge time out.

See Also:

Constant Field Values

KEY_GETTIMEOUT

public static final String KEY_GETTIMEOUT

This key is the second reply timeout on getter commands.

See Also:

Constant Field Values

KEY_STRICTSET

public static final String KEY_STRICTSET

If this is true, only non-warning results are accepted for set.

See Also:

Constant Field Values

KEY_STRICTGET

public static final String KEY_STRICTGET

If this is true, only non-warning results are accepted for get.

See Also:

Constant Field Values

DEFACKTIMEOUT

private static final long DEFACKTIMEOUT

Default value.

See Also:

Constant Field Values

DEFGETTIMEOUT

private static final long DEFGETTIMEOUT

Default value.

See Also:

Constant Field Values

DEFSTRICTGET

private static final boolean DEFSTRICTGET

Default value.

See Also:

Constant Field Values

DEFSTRICTSET

private static final boolean DEFSTRICTSET

Default value.

See Also:

Constant Field Values

active

private Map<Integer,CommunicationCycle> active

This is the lookup table of active commands.

Constructor Detail

GetterSetter

public GetterSetter(Map<String,String> prop)

Constructs a new getter-setter communicator.

Method Detail

init

public void init()

On init, we create a new map of communication cycles.

Specified by:

init in interface Initializable

Overrides:

init in class CommunicationHandler

createSet

public CommandMessage createSet(Object dest,
                                String toset,
                                long donetime)

We create a set command using the property acknowledge time.

createGet

public CommandMessage createGet(Object dest,
                                String toget)

We create a get command using the property acknowledge and completion time.

messageReceived

public void messageReceived(Message m)

If we receive a reply, we check if it belongs to one of the active command cycles.

Specified by:

messageReceived in interface MessageListener

executeSet

public boolean executeSet(Object dest,
                          String toset,
                          long donetime)
                   throws AcknowledgeException,
                          TimeoutException,
                          IOException

We issue a setter function and wait for the result, which is then interpret as a boolean.

Throws:

AcknowledgeException

TimeoutException

IOException

executeSet

protected boolean executeSet(CommandMessage cm)
                      throws AcknowledgeException,
                             TimeoutException,
                             IOException

We issue a preparedsetter function and wait for the result, which is then interpret as a boolean.

Throws:

AcknowledgeException

TimeoutException

IOException

executeGet

public List<String> executeGet(Object dest,
                               String toget)
                        throws AcknowledgeException,
                               TimeoutException,
                               IOException

We issue a getter function and wait for the result, which is returned as the cycle outcome.

Throws:

AcknowledgeException

TimeoutException

IOException

executeGet

protected List<String> executeGet(CommandMessage cm)
                           throws AcknowledgeException,
                                  TimeoutException,
                                  IOException

We issue a prepared getter function and wait for the result, which is returned as the cycle outcome.

Throws:

AcknowledgeException

TimeoutException

IOException

initiate

protected CommunicationCycle initiate(CommandMessage cm)
                               throws IOException

We initiate sending a command. This method is intended for composed commands, where more than a single setter/getter method can run in parallel. The caller can then use the returned cycle handle to wait for completion of one of the parallel cycles with waitForComplete(stella.net.gregor.CommandMessage, stella.net.gregor.CommunicationCycle).

Throws:

IOException

waitForComplete

protected void waitForComplete(CommandMessage cm,
                               CommunicationCycle cc)
                        throws AcknowledgeException,
                               TimeoutException

We wait for a command cycle to complete by synchronizing on the cycle object and issuing maximum two wait states on it.

Throws:

AcknowledgeException

TimeoutException

removeCycle

protected boolean removeCycle(CommandMessage cm)

Removes the command cycle to this command if still in active list.

complete

private CommunicationCycle complete(CommandMessage cm)
                             throws AcknowledgeException,
                                    TimeoutException,
                                    IOException

We initiate and wait.

Throws:

AcknowledgeException

TimeoutException

IOException

toString

public String toString()

We are lazy and just override the toString method.

Overrides:

toString in class PropertyContainer