stella.net.vatt

Class VattHandler

java.lang.Object

util.PropertyContainer

io.AbstractDriver

io.AbstractSocketDriver

stella.net.vatt.VattHandler

All Implemented Interfaces:

Driver, StreamIODriver, Cloneable, ExitCleaning, Initializable, PropertySupplying

Direct Known Subclasses:

VattDriver

public class VattHandler
extends AbstractSocketDriver

This class handles the low-level communication for VATT in providing a method to send a command to the command server. In the moment, the impression prevails that no asynchronous error messages can be relayed, thus the communication is very simple in the sense that a command is written and a response is received. A response comes in the format of an acknowledge message and thus is the final result of a message exchange.

It is currently unknown if it is advisable to close the communication after each transmission, the behaviour is governed by {} which is default set to false.

Field Summary

Fields

Modifier and Type	Field and Description
private static boolean	DEFALWAYSCLOSE Default port for the DCP.
private static int	DEFSOCKETPORT Default port for the DCP.
static String	KEY_ALWAYSCLOSE The wait period for a sender to check its queue.
private VattInputStream	vin Input stream ready after open.
private VattOutputStream	vout Output stream ready after open.

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
VattHandler(Map<String,String> prop) Low-level Communication is deferred to the parental class that provides access to an input and an output stream.

Method Summary

Modifier and Type	Method and Description
boolean	open() Connect to remote host.
VattAcknowledgeMessage	sendCommand(VattCommandMessage cmd)

Methods inherited from class io.AbstractSocketDriver

authenticate, close, exit, getInputStream, getOutputStream, getSocket, init, isOpen, 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, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.Driver

getDriverName

Field Detail

KEY_ALWAYSCLOSE

public static final String KEY_ALWAYSCLOSE

The wait period for a sender to check its queue. Can be long.

See Also:

Constant Field Values

DEFSOCKETPORT

private static final int DEFSOCKETPORT

Default port for the DCP.

See Also:

Constant Field Values

DEFALWAYSCLOSE

private static final boolean DEFALWAYSCLOSE

Default port for the DCP.

See Also:

Constant Field Values

vout

private VattOutputStream vout

Output stream ready after open.

vin

private VattInputStream vin

Input stream ready after open.

Constructor Detail

VattHandler

public VattHandler(Map<String,String> prop)

Low-level Communication is deferred to the parental class that provides access to an input and an output stream.

Method Detail

open

public boolean open()
             throws IOException

Connect to remote host. If we have already connected in persistent mode, reconnection is

Specified by:

open in interface Driver

Overrides:

open in class AbstractSocketDriver

Returns:

True if initialization was successful.

Throws:

IOException - Exception to throw on connection error

sendCommand

public VattAcknowledgeMessage sendCommand(VattCommandMessage cmd)
                                   throws IOException

Throws:

IOException