Package org.yamcs.tse

Class TcpIpDriver

java.lang.Object

org.yamcs.tse.InstrumentDriver

org.yamcs.tse.TcpIpDriver

public class TcpIpDriver
extends InstrumentDriver

Connect and command a device over TCP/IP. Typical use case is an instrument with LXI support. Not thread safe.

Field Summary

Fields inherited from class org.yamcs.tse.InstrumentDriver

commandSeparation, encoding, instrument, interceptors, responseTermination, responseTimeout

Constructor Summary

Constructors

Constructor	Description
TcpIpDriver()

Method Summary

Modifier and Type	Method	Description
void	connect()
void	disconnect()
String	getDefaultRequestTermination()	Returns the driver-specific default pattern for terminating requests.
void	init(String name, YConfiguration config)
boolean	isFragmented()	Returns whether this driver may require reassembly of multiple received fragments in order to obtain a full response.
void	readAvailable(ResponseBuffer responseBuffer, int timeout)
void	write(byte[] cmd)

Methods inherited from class org.yamcs.tse.InstrumentDriver

command, getCommandSeparation, getName, getResponseTermination, getResponseTimeout

Methods inherited from class java.lang.Object

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

Constructor Details

TcpIpDriver

public TcpIpDriver()

Method Details

init

public void init(String name,
 YConfiguration config)

Overrides:

init in class InstrumentDriver

connect

public void connect()
             throws IOException

Specified by:

connect in class InstrumentDriver

Throws:

IOException

disconnect

public void disconnect()
                throws IOException

Specified by:

disconnect in class InstrumentDriver

Throws:

IOException

getDefaultRequestTermination

public String getDefaultRequestTermination()

Description copied from class: InstrumentDriver

Returns the driver-specific default pattern for terminating requests. This is the termination that gets used if the user does not explicitly configure anything.

Return null to do no request termination.

Specified by:

getDefaultRequestTermination in class InstrumentDriver

write

public void write(byte[] cmd)
           throws IOException

Specified by:

write in class InstrumentDriver

Throws:

IOException

readAvailable

public void readAvailable(ResponseBuffer responseBuffer,
 int timeout)
                   throws IOException

Specified by:

readAvailable in class InstrumentDriver

Throws:

IOException

isFragmented

public boolean isFragmented()

Description copied from class: InstrumentDriver

Returns whether this driver may require reassembly of multiple received fragments in order to obtain a full response.

Setting this to false, will allow to have a quick response, even if there is no response termination characters. That is, without needing to wait on timeouts.

Specified by:

isFragmented in class InstrumentDriver