mirror of
https://github.com/nasa/trick.git
synced 2025-01-07 05:38:46 +00:00
Add option to validate pointer addresses in variable server clients
Added an option on the settings panel in TV to toggle validating addresses. Removed the now deprecated resolve_bad_refs button. refs #193 Conflicts: trick_source/java/src/trick/common/utils/VariableServerConnection.java
This commit is contained in:
Alex Lin
parent
6ef4517335
commit
38b5c2092f
@ -10,207 +10,204 @@ import java.net.Socket;
|
||||
import java.net.UnknownHostException;
|
||||
|
||||
/**
|
||||
* a generic variable server client that provides for sending commands and
|
||||
* receiving responses. Currently only handles a subset of Trick types in binary
|
||||
* mode.
|
||||
*
|
||||
* @author Derek Bankieris
|
||||
*/
|
||||
* a generic variable server client that provides for sending commands and
|
||||
* receiving responses. Currently only handles a subset of Trick types in binary
|
||||
* mode.
|
||||
*
|
||||
* @author Derek Bankieris
|
||||
*/
|
||||
public class VariableServerConnection implements AutoCloseable {
|
||||
|
||||
/** maximum binary packet size sent by the Variable Server */
|
||||
public static final int maximumPacketSize = 8192;
|
||||
/** maximum binary packet size sent by the Variable Server */
|
||||
public static final int maximumPacketSize = 8192;
|
||||
|
||||
/** Variable Server data mode */
|
||||
public enum DataMode {ASCII, BINARY, BINARY_NO_NAMES};
|
||||
/** Variable Server data mode */
|
||||
public enum DataMode {ASCII, BINARY, BINARY_NO_NAMES};
|
||||
|
||||
/** This really shouldn't be necessary. MTV needs to retrieve Variable Server data better. */
|
||||
public String results;
|
||||
/** This really shouldn't be necessary. MTV needs to retrieve Variable Server data better. */
|
||||
public String results;
|
||||
|
||||
/** connection to the Variable Server */
|
||||
protected Socket socket;
|
||||
/** connection to the Variable Server */
|
||||
protected Socket socket;
|
||||
|
||||
/** Variable Server data mode */
|
||||
protected DataMode dataMode = DataMode.ASCII;
|
||||
/** Variable Server data mode */
|
||||
protected DataMode dataMode = DataMode.ASCII;
|
||||
|
||||
/** Variable Server synchronized mode */
|
||||
protected boolean sync = false;
|
||||
/** Variable Server synchronized mode */
|
||||
protected boolean sync = false;
|
||||
|
||||
/** tracks the paused status of the Variable Server */
|
||||
protected boolean isPaused = false;
|
||||
/** tracks the paused status of the Variable Server */
|
||||
protected boolean isPaused = false;
|
||||
|
||||
/** receives commands from the Variable Server */
|
||||
protected BufferedReader inputStream;
|
||||
/** receives commands from the Variable Server */
|
||||
protected BufferedReader inputStream;
|
||||
|
||||
/** sends commands to the Variable Server */
|
||||
protected DataOutputStream outputStream;
|
||||
/** sends commands to the Variable Server */
|
||||
protected DataOutputStream outputStream;
|
||||
|
||||
/**
|
||||
* attempts to connect to the Variable Server on the given host and port
|
||||
*
|
||||
* @param host Variable Server machine name
|
||||
* @param port Variable Server port number
|
||||
*/
|
||||
public VariableServerConnection(String host, int port) throws UnknownHostException, IOException, SecurityException {
|
||||
socket = new Socket(host, port);
|
||||
inputStream = new BufferedReader(new InputStreamReader(socket.getInputStream()));
|
||||
outputStream = new DataOutputStream(new BufferedOutputStream(socket.getOutputStream()));
|
||||
}
|
||||
/**
|
||||
* attempts to connect to the Variable Server on the given host and port
|
||||
*
|
||||
* @param host Variable Server machine name
|
||||
* @param port Variable Server port number
|
||||
*/
|
||||
public VariableServerConnection(String host, int port) throws UnknownHostException, IOException, SecurityException {
|
||||
socket = new Socket(host, port);
|
||||
inputStream = new BufferedReader(new InputStreamReader(socket.getInputStream()));
|
||||
outputStream = new DataOutputStream(new BufferedOutputStream(socket.getOutputStream()));
|
||||
}
|
||||
|
||||
/**
|
||||
* sends the given command and any commands in the output stream's buffer
|
||||
* to the Variable Server. The command is written to the output stream,
|
||||
* and the buffer is flushed. A newline is automatically appended to the
|
||||
* given command.
|
||||
*
|
||||
* @param command the Variable Server command to be sent
|
||||
*/
|
||||
public void put(String command) throws IOException {
|
||||
outputStream.writeBytes(command + "\n");
|
||||
outputStream.flush();
|
||||
}
|
||||
/**
|
||||
* sends the given command and any commands in the output stream's buffer
|
||||
* to the Variable Server. The command is written to the output stream,
|
||||
* and the buffer is flushed. A newline is automatically appended to the
|
||||
* given command.
|
||||
*
|
||||
* @param command the Variable Server command to be sent
|
||||
*/
|
||||
public void put(String command) throws IOException {
|
||||
outputStream.writeBytes(command + "\n");
|
||||
outputStream.flush();
|
||||
}
|
||||
|
||||
/**
|
||||
* writes the command to the output stream. A newline is
|
||||
* automatically appended. The buffer is not flushed.
|
||||
*
|
||||
* @param command the Variable Server command to be written
|
||||
*/
|
||||
public void write(String command) throws IOException {
|
||||
outputStream.writeBytes(command + "\n");
|
||||
}
|
||||
/**
|
||||
* writes the command to the output stream. A newline is
|
||||
* automatically appended. The buffer is not flushed.
|
||||
*
|
||||
* @param command the Variable Server command to be written
|
||||
*/
|
||||
public void write(String command) throws IOException {
|
||||
outputStream.writeBytes(command + "\n");
|
||||
}
|
||||
|
||||
/**
|
||||
* flushes the buffer, sending any pending commands to the Variable
|
||||
* Server
|
||||
*/
|
||||
public void flush() throws IOException {
|
||||
outputStream.flush();
|
||||
}
|
||||
/**
|
||||
* flushes the buffer, sending any pending commands to the Variable
|
||||
* Server
|
||||
*/
|
||||
public void flush() throws IOException {
|
||||
outputStream.flush();
|
||||
}
|
||||
|
||||
/**
|
||||
* commands the Variable Server to send variable data in ASCII
|
||||
*/
|
||||
public void setAscii() throws IOException {
|
||||
if (dataMode != DataMode.ASCII) {
|
||||
put("trick.var_ascii()");
|
||||
dataMode = DataMode.ASCII;
|
||||
}
|
||||
}
|
||||
/**
|
||||
* commands the Variable Server to send variable data in ASCII
|
||||
*/
|
||||
public void setAscii() throws IOException {
|
||||
if (dataMode != DataMode.ASCII) {
|
||||
put("trick.var_ascii()");
|
||||
dataMode = DataMode.ASCII;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* commands the Variable Server to send variable data in binary
|
||||
*/
|
||||
public void setBinary() throws IOException {
|
||||
if (dataMode != DataMode.BINARY) {
|
||||
put("trick.var_binary()");
|
||||
dataMode = DataMode.BINARY;
|
||||
}
|
||||
}
|
||||
/**
|
||||
* commands the Variable Server to send variable data in binary
|
||||
*/
|
||||
public void setBinary() throws IOException {
|
||||
if (dataMode != DataMode.BINARY) {
|
||||
put("trick.var_binary()");
|
||||
dataMode = DataMode.BINARY;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* commands the Variable Server to send variable data in binary and to
|
||||
* omit names
|
||||
*/
|
||||
public void setBinaryNoNames() throws IOException {
|
||||
if (dataMode != DataMode.BINARY_NO_NAMES) {
|
||||
put("trick.var_binary_nonames()");
|
||||
dataMode = DataMode.BINARY_NO_NAMES;
|
||||
}
|
||||
}
|
||||
/**
|
||||
* commands the Variable Server to send variable data in binary and to
|
||||
* omit names
|
||||
*/
|
||||
public void setBinaryNoNames() throws IOException {
|
||||
if (dataMode != DataMode.BINARY_NO_NAMES) {
|
||||
put("trick.var_binary_nonames()");
|
||||
dataMode = DataMode.BINARY_NO_NAMES;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* sets the Variable Server to synchronized mode
|
||||
*/
|
||||
public void setSync() throws IOException {
|
||||
if (!sync) {
|
||||
put("trick.var_sync(1)");
|
||||
sync = true;
|
||||
}
|
||||
}
|
||||
/**
|
||||
* sets the Variable Server to synchronized mode
|
||||
*/
|
||||
public void setSync() throws IOException {
|
||||
if (!sync) {
|
||||
put("trick.var_sync(1)");
|
||||
sync = true;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* commands the Variable Server to stop sending data
|
||||
*/
|
||||
public void pause() throws IOException {
|
||||
put("trick.var_pause()");
|
||||
isPaused = true;
|
||||
}
|
||||
/**
|
||||
* commands the Variable Server to stop sending data
|
||||
*/
|
||||
public void pause() throws IOException {
|
||||
put("trick.var_pause()");
|
||||
isPaused = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* commands the Variable Server to resume sending data
|
||||
*/
|
||||
public void unpause() throws IOException {
|
||||
put("trick.var_unpause()");
|
||||
isPaused = false;
|
||||
}
|
||||
/**
|
||||
* commands the Variable Server to resume sending data
|
||||
*/
|
||||
public void unpause() throws IOException {
|
||||
put("trick.var_unpause()");
|
||||
isPaused = false;
|
||||
}
|
||||
|
||||
/**
|
||||
* returns the paused state of the Variable Server
|
||||
*
|
||||
* return whether or not the Variable Server is paused
|
||||
*/
|
||||
public boolean isPaused() {
|
||||
return isPaused;
|
||||
}
|
||||
/**
|
||||
* returns the paused state of the Variable Server
|
||||
*
|
||||
* return whether or not the Variable Server is paused
|
||||
*/
|
||||
public boolean isPaused() {
|
||||
return isPaused;
|
||||
}
|
||||
|
||||
/**
|
||||
* adds the named variable to the Variable Server
|
||||
*
|
||||
* @param name the name of the variable to be added
|
||||
*/
|
||||
public void add(String name) throws IOException {
|
||||
put("trick.var_add(\"" + name + "\")");
|
||||
}
|
||||
/**
|
||||
* adds the named variable to the Variable Server
|
||||
*
|
||||
* @param name the name of the variable to be added
|
||||
*/
|
||||
public void add(String name) throws IOException {
|
||||
put("trick.var_add(\"" + name + "\")");
|
||||
}
|
||||
|
||||
/**
|
||||
* adds the named variable to the Variable Server
|
||||
*
|
||||
* @param name the name of the variable to be added
|
||||
* @param units the units to use
|
||||
*/
|
||||
public void add(String name, String units) throws IOException {
|
||||
boolean invalidUnits = units == null || units.isEmpty();
|
||||
put("trick.var_add(\"" + name + (invalidUnits ? "" : "\", \"" + units) + "\")");
|
||||
}
|
||||
/**
|
||||
* adds the named variable to the Variable Server
|
||||
*
|
||||
* @param name the name of the variable to be added
|
||||
* @param units the units to use
|
||||
*/
|
||||
public void add(String name, String units) throws IOException {
|
||||
boolean invalidUnits = units == null || units.isEmpty();
|
||||
put("trick.var_add(\"" + name + (invalidUnits ? "" : "\", \"" + units) + "\")");
|
||||
}
|
||||
|
||||
/**
|
||||
* removes the named variable from the Variable Server
|
||||
*
|
||||
* @param name the name of the variable to be removeed
|
||||
*/
|
||||
public void remove(String name) throws IOException {
|
||||
put("trick.var_remove(\"" + name + "\")");
|
||||
}
|
||||
/**
|
||||
* removes the named variable from the Variable Server
|
||||
*
|
||||
* @param name the name of the variable to be removeed
|
||||
*/
|
||||
public void remove(String name) throws IOException {
|
||||
put("trick.var_remove(\"" + name + "\")");
|
||||
}
|
||||
|
||||
/**
|
||||
* clears all variables from the Variable Server
|
||||
*/
|
||||
public void clear() throws IOException {
|
||||
put("trick.var_clear()");
|
||||
}
|
||||
/**
|
||||
* clears all variables from the Variable Server
|
||||
*/
|
||||
public void clear() throws IOException {
|
||||
put("trick.var_clear()");
|
||||
}
|
||||
|
||||
/**
|
||||
* sets the period at which the Variable Server sends updates
|
||||
*
|
||||
* @param period the update period
|
||||
*/
|
||||
public void setCycle(double period) throws IOException {
|
||||
put("trick.var_cycle(" + period + ")");
|
||||
}
|
||||
/**
|
||||
* sets the period at which the Variable Server sends updates
|
||||
*
|
||||
* @param period the update period
|
||||
*/
|
||||
public void setCycle(double period) throws IOException {
|
||||
put("trick.var_cycle(" + period + ")");
|
||||
}
|
||||
|
||||
/**
|
||||
* requests a single update from the Variable Server
|
||||
*/
|
||||
public void poll() throws IOException {
|
||||
put("trick.var_send()");
|
||||
}
|
||||
/**
|
||||
* requests a single update from the Variable Server
|
||||
*/
|
||||
public void poll() throws IOException {
|
||||
put("trick.var_send()");
|
||||
}
|
||||
|
||||
/**
|
||||
* attempts to resolve all invalid variables
|
||||
*/
|
||||
public void resolveInvalidReferences() throws IOException {
|
||||
put("trick.var_retry_bad_ref()");
|
||||
public void setValidateAddresses(boolean validate) throws IOException {
|
||||
put("trick.var_validate_address(" + (validate ? "True" : "False") + ")");
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@ -582,7 +582,6 @@ public class MonteMonitorApplication extends RunTimeTrickApplication {
|
||||
slave.name = data[dataIndex++];
|
||||
if (data[dataIndex++].equals("BAD_REF")) {
|
||||
slave.currentRun = new Integer(-1);
|
||||
variableServerConnection.resolveInvalidReferences();
|
||||
}
|
||||
else {
|
||||
slave.currentRun = new Integer(data[dataIndex - 1]);
|
||||
|
||||
@ -183,6 +183,9 @@ public class TVApplication extends RunTimeTrickApplication implements VariableLi
|
||||
/** whether or not to treat character arrays as strings */
|
||||
boolean characterArraysAsStrings = false;
|
||||
|
||||
/** validate pointer addresses */
|
||||
boolean validateAddresses = false;
|
||||
|
||||
/** strip chart manager */
|
||||
protected StripChartManager stripChartManager = new StripChartManager();
|
||||
|
||||
@ -205,6 +208,7 @@ public class TVApplication extends RunTimeTrickApplication implements VariableLi
|
||||
final String fontSizeKey = "fontSize";
|
||||
final String defaultUnitsKey = "defaultUnits";
|
||||
final String characterArraysAsStringsKey = "characterArraysAsStrings";
|
||||
final String validateAddressesKey = "validateAddresses";
|
||||
|
||||
/** new action */
|
||||
protected AbstractAction newAction = new AbstractAction("New",
|
||||
@ -515,6 +519,9 @@ public class TVApplication extends RunTimeTrickApplication implements VariableLi
|
||||
characterArraysAsStrings = Boolean.parseBoolean(trickProperties.getProperty(
|
||||
characterArraysAsStringsKey, Boolean.toString(characterArraysAsStrings)));
|
||||
|
||||
validateAddresses = Boolean.parseBoolean(trickProperties.getProperty(
|
||||
validateAddressesKey, Boolean.toString(validateAddresses)));
|
||||
|
||||
for (UnitType type : UnitType.values()) {
|
||||
String units = trickProperties.getProperty(type.toString());
|
||||
if (units != null && !units.equals(Unit.DEFAULT_UNITS.toString())) {
|
||||
@ -744,8 +751,16 @@ public class TVApplication extends RunTimeTrickApplication implements VariableLi
|
||||
);
|
||||
}};
|
||||
|
||||
JCheckBox validateAddressCheckBox = new JCheckBox("validate addresses") {{
|
||||
setToolTipText(
|
||||
"<html>" +
|
||||
"Validate pointer addresses<br>" +
|
||||
"</html>"
|
||||
);
|
||||
}};
|
||||
|
||||
{
|
||||
setBorder(new TitledBorder("Variable Addition") {{
|
||||
setBorder(new TitledBorder("Variable Properties") {{
|
||||
setTitleJustification(CENTER);
|
||||
}});
|
||||
|
||||
@ -762,11 +777,15 @@ public class TVApplication extends RunTimeTrickApplication implements VariableLi
|
||||
|
||||
add(asStringsCheckBox, constraints);
|
||||
|
||||
constraints.gridy = 2;
|
||||
add(validateAddressCheckBox, constraints);
|
||||
|
||||
settingsDialog.addBecomingVisibleListener(new BecomingVisibleListener() {
|
||||
@Override
|
||||
public void becomingVisible() {
|
||||
comboBox.setSelectedItem(position);
|
||||
asStringsCheckBox.setSelected(characterArraysAsStrings);
|
||||
validateAddressCheckBox.setSelected(validateAddresses);
|
||||
}
|
||||
});
|
||||
|
||||
@ -780,6 +799,14 @@ public class TVApplication extends RunTimeTrickApplication implements VariableLi
|
||||
public void commitChanges() {
|
||||
position = (Position)comboBox.getSelectedItem();
|
||||
characterArraysAsStrings = asStringsCheckBox.isSelected();
|
||||
validateAddresses = validateAddressCheckBox.isSelected();
|
||||
if (getConnectionState()) {
|
||||
try {
|
||||
variableServerConnection.setValidateAddresses(validateAddresses);
|
||||
}
|
||||
catch (IOException ignoreMe) {
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
@ -1077,6 +1104,7 @@ public class TVApplication extends RunTimeTrickApplication implements VariableLi
|
||||
}
|
||||
|
||||
sendCyclePeriod();
|
||||
variableServerConnection.setValidateAddresses(validateAddresses);
|
||||
}
|
||||
|
||||
/**
|
||||
@ -1627,22 +1655,6 @@ public class TVApplication extends RunTimeTrickApplication implements VariableLi
|
||||
add(manualField, constraints);
|
||||
constraints.weightx = 0;
|
||||
|
||||
add(new JXButton(new AbstractAction() {
|
||||
{
|
||||
putValue(NAME, "Resolve");
|
||||
putValue(SHORT_DESCRIPTION, "Attempt to resolve all invalid references.");
|
||||
putValue(MNEMONIC_KEY, KeyEvent.VK_V);
|
||||
}
|
||||
public void actionPerformed(ActionEvent actionEvent) {
|
||||
try {
|
||||
variableServerConnection.resolveInvalidReferences();
|
||||
}
|
||||
catch (IOException ioException) {
|
||||
disconnect(ioException);
|
||||
}
|
||||
}
|
||||
}), constraints);
|
||||
|
||||
add(new JXButton(new AbstractAction() {
|
||||
{
|
||||
putValue(NAME, "Purge");
|
||||
@ -1861,6 +1873,7 @@ public class TVApplication extends RunTimeTrickApplication implements VariableLi
|
||||
trickProperties.setProperty(fontSizeKey, Integer.toString(variableTree.getFont().getSize()));
|
||||
trickProperties.setProperty(defaultUnitsKey, Boolean.toString(defaultAllUnits));
|
||||
trickProperties.setProperty(characterArraysAsStringsKey, Boolean.toString(characterArraysAsStrings));
|
||||
trickProperties.setProperty(validateAddressesKey, Boolean.toString(validateAddresses));
|
||||
for (UnitType type : UnitType.values()) {
|
||||
trickProperties.setProperty(type.toString(),
|
||||
defaultUnits.get(type.ordinal()).toString());
|
||||
|
||||
Loading…
Reference in New Issue
Block a user