diff --git a/apps/heartbeat/java/src/net/i2p/heartbeat/ClientConfig.java b/apps/heartbeat/java/src/net/i2p/heartbeat/ClientConfig.java
index 23bb0d9e51d7db82983b68e50f183895e556b2a1..9fadd2d74e62f6356eb6b915c7ae6de7cf7f50db 100644
--- a/apps/heartbeat/java/src/net/i2p/heartbeat/ClientConfig.java
+++ b/apps/heartbeat/java/src/net/i2p/heartbeat/ClientConfig.java
@@ -89,7 +89,7 @@ public class ClientConfig {
/**
* Create a dummy client config to be fetched from the specified location
- *
+ * @param location the location to fetch from
*/
public ClientConfig(String location) {
this(null, null, location, -1, -1, -1, -1, 0, null, null);
diff --git a/apps/heartbeat/java/src/net/i2p/heartbeat/PeerData.java b/apps/heartbeat/java/src/net/i2p/heartbeat/PeerData.java
index dd0faf600008bcfd54a58add7d2d08daf5623fbf..d9b32e776739ed39c7facc55ebeef5de9a23c738 100644
--- a/apps/heartbeat/java/src/net/i2p/heartbeat/PeerData.java
+++ b/apps/heartbeat/java/src/net/i2p/heartbeat/PeerData.java
@@ -103,7 +103,14 @@ public class PeerData {
public long getSessionStart() {
return _sessionStart;
}
- public void setSessionStart(long when) { _sessionStart = when; }
+
+ /**
+ * Sets when the test began
+ * @param when the time the session began
+ */
+ public void setSessionStart(long when) {
+ _sessionStart = when;
+ }
/**
* how many pings have we sent for this test?
diff --git a/apps/heartbeat/java/src/net/i2p/heartbeat/PeerDataWriter.java b/apps/heartbeat/java/src/net/i2p/heartbeat/PeerDataWriter.java
index ed621a5a84f71223c2363c9d853f3678ae18d5dd..4c88925d4ac09e9c3ce90acd43d841b3bb82eaae 100644
--- a/apps/heartbeat/java/src/net/i2p/heartbeat/PeerDataWriter.java
+++ b/apps/heartbeat/java/src/net/i2p/heartbeat/PeerDataWriter.java
@@ -2,8 +2,8 @@ package net.i2p.heartbeat;
import java.io.File;
import java.io.FileOutputStream;
-import java.io.OutputStream;
import java.io.IOException;
+import java.io.OutputStream;
import java.text.DecimalFormat;
import java.text.DecimalFormatSymbols;
import java.text.SimpleDateFormat;
@@ -48,6 +48,13 @@ public class PeerDataWriter {
return true;
}
+ /**
+ * persists the peer state to the output stream
+ * @param data the peer data to persist
+ * @param out where to persist the data
+ * @return true if it was persisted correctly [always (as implemented)], false on error
+ * @throws IOException
+ */
public boolean persist(PeerData data, OutputStream out) throws IOException {
String header = getHeader(data);
diff --git a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatControlPane.java b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatControlPane.java
index 4f2a76c4d5d9f50a4027465becb5f6ebc30faa1e..813f3a151d5e829939d817eaed00b5e1ddedc1c3 100644
--- a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatControlPane.java
+++ b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatControlPane.java
@@ -1,15 +1,13 @@
package net.i2p.heartbeat.gui;
-import javax.swing.JPanel;
-import javax.swing.JLabel;
-import javax.swing.JTabbedPane;
-import javax.swing.JScrollPane;
import java.awt.BorderLayout;
import java.awt.Color;
-import java.awt.Dimension;
-
-import java.util.List;
import java.util.ArrayList;
+import java.util.List;
+
+import javax.swing.JPanel;
+import javax.swing.JScrollPane;
+import javax.swing.JTabbedPane;
import net.i2p.util.Log;
@@ -28,16 +26,29 @@ class HeartbeatControlPane extends JPanel {
private Color _background = WHITE;
private Color _foreground = BLACK;
+ /**
+ * Constructs a control panel onto the gui
+ * @param gui the gui the panel is associated with
+ */
public HeartbeatControlPane(HeartbeatMonitorGUI gui) {
_gui = gui;
initializeComponents();
}
+ /**
+ * Adds a test to the panel
+ * @param config the configuration for the test
+ */
public void addTest(PeerPlotConfig config) {
_configPane.addTab(config.getTitle(), null, new JScrollPane(new PeerPlotConfigPane(config, this)), config.getSummary());
_configPane.setBackgroundAt(_configPane.getTabCount()-1, _background);
_configPane.setForegroundAt(_configPane.getTabCount()-1, _foreground);
}
+
+ /**
+ * Removes a test from the panel
+ * @param config the configuration for the test
+ */
public void removeTest(PeerPlotConfig config) {
_gui.getMonitor().getState().removeTest(config);
int index = _configPane.indexOfTab(config.getTitle());
@@ -45,6 +56,9 @@ class HeartbeatControlPane extends JPanel {
_configPane.removeTabAt(index);
}
+ /**
+ * Callback: when tests have changed
+ */
public void testsUpdated() {
List knownNames = new ArrayList(8);
for (int i = 0; i < _gui.getMonitor().getState().getTestCount(); i++) {
diff --git a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatMonitor.java b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatMonitor.java
index 73bcedfed6b8b304a16237673c1eb76bd37b5aad..a4ac94c4ce9519820651b77ced667724718991f6 100644
--- a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatMonitor.java
+++ b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatMonitor.java
@@ -3,17 +3,39 @@ package net.i2p.heartbeat.gui;
import net.i2p.util.I2PThread;
import net.i2p.util.Log;
+/**
+ * The HeartbeatMonitor, complete with main()! Act now, and it's only 5 easy
+ * payments of $19.95 (plus shipping and handling)! You heard me, only _5_
+ * easy payments of $19.95 (plus shipping and handling)!
+ *
+ * (fine print: something about some states in the US requiring the addition
+ * of sales tax... or something)
+ *
+ * (finer print: Satan owns you. Deal with it.)
+ */
public class HeartbeatMonitor implements PeerPlotStateFetcher.FetchStateReceptor {
private final static Log _log = new Log(HeartbeatMonitor.class);
private HeartbeatMonitorState _state;
private HeartbeatMonitorGUI _gui;
+ /**
+ * Delegating constructor.
+ * @see HeartbeatMonitor#HeartbeatMonitor(String)
+ */
public HeartbeatMonitor() { this(null); }
+
+ /**
+ * Creates a HeartbeatMonitor . . .
+ * @param configFilename the configuration file to read from
+ */
public HeartbeatMonitor(String configFilename) {
_state = new HeartbeatMonitorState(configFilename);
_gui = new HeartbeatMonitorGUI(this);
}
+ /**
+ * Starts the game rollin'
+ */
public void runMonitor() {
loadConfig();
I2PThread t = new I2PThread(new HeartbeatMonitorRunner(this));
@@ -23,8 +45,13 @@ public class HeartbeatMonitor implements PeerPlotStateFetcher.FetchStateReceptor
_log.debug("Monitor started");
}
- /** give us all the data/config available */
- HeartbeatMonitorState getState() { return _state; }
+ /**
+ * give us all the data/config available
+ * @return the current state (data/config)
+ */
+ HeartbeatMonitorState getState() {
+ return _state;
+ }
/** for all of the peer tests being monitored, refetch the data and rerender */
void refetchData() {
@@ -40,12 +67,19 @@ public class HeartbeatMonitor implements PeerPlotStateFetcher.FetchStateReceptor
//}
}
+ /**
+ * Loads config data
+ * @param location the name of the location to load data from
+ */
public void load(String location) {
PeerPlotConfig cfg = new PeerPlotConfig(location);
PeerPlotState state = new PeerPlotState(cfg);
PeerPlotStateFetcher.fetchPeerPlotState(this, state);
}
+ /* (non-Javadoc)
+ * @see PeerPlotStateFetcher.FetchStateReceptor#peerPlotStateFetched
+ */
public synchronized void peerPlotStateFetched(PeerPlotState state) {
_state.addTest(state);
_gui.stateUpdated();
@@ -54,6 +88,10 @@ public class HeartbeatMonitor implements PeerPlotStateFetcher.FetchStateReceptor
/** store the config defining what peer tests we are monitoring (and how to render) */
void storeConfig() {}
+ /**
+ * And now, the main function, the one you've all been waiting for! . . .
+ * @param args da args. Should take 1, which is the location to load config data from
+ */
public static void main(String args[]) {
Thread.currentThread().setName("HeartbeatMonitor.main");
if (args.length == 1)
diff --git a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatMonitorCommandBar.java b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatMonitorCommandBar.java
index c354a803281eca47062ffd249ce2c6e09237b12e..0ca18f174a56dfa3160415dcc4f80bc9b6ca14e6 100644
--- a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatMonitorCommandBar.java
+++ b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatMonitorCommandBar.java
@@ -1,22 +1,27 @@
package net.i2p.heartbeat.gui;
-import javax.swing.JPanel;
-import javax.swing.JLabel;
-import javax.swing.JComboBox;
-import javax.swing.JTextField;
-import javax.swing.JButton;
-import javax.swing.JFileChooser;
-import javax.swing.DefaultComboBoxModel;
-import java.awt.event.ActionListener;
import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
import java.awt.event.ItemEvent;
import java.awt.event.ItemListener;
+import javax.swing.DefaultComboBoxModel;
+import javax.swing.JButton;
+import javax.swing.JComboBox;
+import javax.swing.JFileChooser;
+import javax.swing.JLabel;
+import javax.swing.JPanel;
+import javax.swing.JTextField;
+
class HeartbeatMonitorCommandBar extends JPanel {
private HeartbeatMonitorGUI _gui;
private JComboBox _refreshRate;
private JTextField _location;
+ /**
+ * Constructs a command bar onto the gui
+ * @param gui the gui the command bar is associated with
+ */
public HeartbeatMonitorCommandBar(HeartbeatMonitorGUI gui) {
_gui = gui;
initializeComponents();
diff --git a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatMonitorGUI.java b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatMonitorGUI.java
index d04baea5c7f5595b1a12694d8a20b14b837f0c4e..80025e1dfc4a67a2c5d7a0667e5849db569db159 100644
--- a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatMonitorGUI.java
+++ b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatMonitorGUI.java
@@ -1,16 +1,16 @@
package net.i2p.heartbeat.gui;
+import java.awt.BorderLayout;
+import java.awt.Color;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+
import javax.swing.JFrame;
import javax.swing.JMenu;
-import javax.swing.JMenuItem;
import javax.swing.JMenuBar;
+import javax.swing.JMenuItem;
import javax.swing.JScrollPane;
-import java.awt.BorderLayout;
-import java.awt.Color;
-import java.awt.event.ActionListener;
-import java.awt.event.ActionEvent;
-
class HeartbeatMonitorGUI extends JFrame {
private HeartbeatMonitor _monitor;
private HeartbeatPlotPane _plotPane;
@@ -18,6 +18,10 @@ class HeartbeatMonitorGUI extends JFrame {
private final static Color WHITE = new Color(255, 255, 255);
private Color _background = WHITE;
+ /**
+ * Creates the GUI for all youz who be too shoopid for text based shitz
+ * @param monitor the monitor the gui operates over
+ */
public HeartbeatMonitorGUI(HeartbeatMonitor monitor) {
super("Heartbeat Monitor");
_monitor = monitor;
@@ -49,6 +53,9 @@ class HeartbeatMonitorGUI extends JFrame {
initializeMenus();
}
+ /**
+ * Callback: when the state of the world changes . . .
+ */
public void stateUpdated() {
_controlPane.testsUpdated();
_plotPane.stateUpdated();
diff --git a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatMonitorRunner.java b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatMonitorRunner.java
index 7e95117e583d496ee2b13a9db72d7047fe7a63dc..862fff271d7c38a46cadf666cb067ade27ba35e7 100644
--- a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatMonitorRunner.java
+++ b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatMonitorRunner.java
@@ -6,16 +6,22 @@ import net.i2p.util.Log;
* Periodically fire off necessary events (instructing the heartbeat monitor when
* to refetch the data, etc). This is the only active thread in the heartbeat
* monitor (outside the swing/jvm threads)
- *
*/
class HeartbeatMonitorRunner implements Runnable {
private final static Log _log = new Log(HeartbeatMonitorRunner.class);
private HeartbeatMonitor _monitor;
+ /**
+ * Creates the thread . . .
+ * @param monitor the monitor the thread runs over
+ */
public HeartbeatMonitorRunner(HeartbeatMonitor monitor) {
_monitor = monitor;
}
+ /* (non-Javadoc)
+ * @see java.lang.Runnable#run()
+ */
public void run() {
while (!_monitor.getState().getWasKilled()) {
_monitor.refetchData();
diff --git a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatMonitorState.java b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatMonitorState.java
index 1603a72a807725916739184b4ba6dce2129fb3f2..7de4bc9bb0073c00562171b2addd4cd9fb8ff430 100644
--- a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatMonitorState.java
+++ b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatMonitorState.java
@@ -1,13 +1,12 @@
package net.i2p.heartbeat.gui;
import java.util.ArrayList;
-import java.util.List;
import java.util.Collections;
+import java.util.List;
/**
* manage the current state of the GUI - all data points, as well as any
* rendering or configuration options.
- *
*/
class HeartbeatMonitorState {
private String _configFile;
@@ -21,7 +20,16 @@ class HeartbeatMonitorState {
/** where do we load/store config info from? */
private final static String DEFAULT_CONFIG_FILE = "heartbeatMonitor.config";
+ /**
+ * A delegating constructor.
+ * @see HeartbeatMonitorState#HeartbeatMonitorState(String)
+ */
public HeartbeatMonitorState() { this(DEFAULT_CONFIG_FILE); }
+
+ /**
+ * Constructs the state, loading from the specified location
+ * @param configFile the name of the file to load info from
+ */
public HeartbeatMonitorState(String configFile) {
_peerPlotState = Collections.synchronizedList(new ArrayList());
_refreshRateMs = DEFAULT_REFRESH_RATE;
@@ -30,15 +38,37 @@ class HeartbeatMonitorState {
_currentPeerPlotConfig = 0;
}
- /** how many tests are we monitoring? */
+ /**
+ * how many tests are we monitoring?
+ * @return the number of tests
+ */
public int getTestCount() { return _peerPlotState.size(); }
+
+ /**
+ * Retrieves the current info of a test for a certain peer . . .
+ * @param peer a number associated with a certain peer
+ * @return the test data
+ */
public PeerPlotState getTest(int peer) { return (PeerPlotState)_peerPlotState.get(peer); }
+
+ /**
+ * Adds a test . . .
+ * @param peerState the test (by state) to add . . .
+ */
public void addTest(PeerPlotState peerState) {
if (!_peerPlotState.contains(peerState))
_peerPlotState.add(peerState);
}
+ /**
+ * Removes a test . . .
+ * @param peerState the test (by state) to remove . . .
+ */
public void removeTest(PeerPlotState peerState) { _peerPlotState.remove(peerState); }
+ /**
+ * Removes a test . . .
+ * @param peerConfig the test (by config) to remove . . .
+ */
public void removeTest(PeerPlotConfig peerConfig) {
for (int i = 0; i < getTestCount(); i++) {
PeerPlotState state = getTest(i);
@@ -49,19 +79,51 @@ class HeartbeatMonitorState {
}
}
- /** which of the tests are we currently editing/viewing? */
+ /**
+ * which of the tests are we currently editing/viewing?
+ * @return the number associated with the test
+ */
public int getPeerPlotConfig() { return _currentPeerPlotConfig; }
+
+ /**
+ * Sets the test we are currently editting/viewing
+ * @param whichTest the number associated with the test
+ */
public void setPeerPlotConfig(int whichTest) { _currentPeerPlotConfig = whichTest; }
- /** how frequently should we update the data? */
+ /**
+ * how frequently should we update the data?
+ * @return the current frequency (in milliseconds)
+ */
public int getRefreshRateMs() { return _refreshRateMs; }
+
+ /**
+ * Sets how frequently we should update data
+ * @param ms the frequency (in milliseconds)
+ */
public void setRefreshRateMs(int ms) { _refreshRateMs = ms; }
- /** where is our config stored? */
+ /**
+ * where is our config stored?
+ * @return the name of the config file
+ */
public String getConfigFile() { return _configFile; }
+
+ /**
+ * Sets where our config is stored
+ * @param filename the name of the config file
+ */
public void setConfigFile(String filename) { _configFile = filename; }
- /** have we been shut down? */
+ /**
+ * have we been shut down?
+ * @return true if we have, false otherwise
+ */
public boolean getWasKilled() { return _killed; }
+
+ /**
+ * Sets if we have been shutdown or not
+ * @param killed true if we've been shutdown, false otherwise
+ */
public void setWasKilled(boolean killed) { _killed = killed; }
}
\ No newline at end of file
diff --git a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatPlotPane.java b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatPlotPane.java
index 1f914456c089ed3a10fa9cf5d690f6dbffc94efc..2fb1f64e8e4a10ceb738c07a5b750a7cd95ef652 100644
--- a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatPlotPane.java
+++ b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/HeartbeatPlotPane.java
@@ -1,31 +1,35 @@
package net.i2p.heartbeat.gui;
-import javax.swing.JPanel;
-import javax.swing.JTextArea;
-import javax.swing.JScrollPane;
import java.awt.Color;
-import java.awt.Dimension;
-
import java.io.ByteArrayOutputStream;
import java.io.IOException;
+import javax.swing.JPanel;
+import javax.swing.JTextArea;
+
import net.i2p.heartbeat.PeerDataWriter;
import net.i2p.util.Log;
/**
* Render the graph and legend
- *
*/
class HeartbeatPlotPane extends JPanel {
private final static Log _log = new Log(HeartbeatPlotPane.class);
private HeartbeatMonitorGUI _gui;
private JTextArea _text;
+ /**
+ * Constructs the plot pane
+ * @param gui the gui the pane is attached to
+ */
public HeartbeatPlotPane(HeartbeatMonitorGUI gui) {
_gui = gui;
initializeComponents();
}
+ /**
+ * Callback: when things change . . .
+ */
public void stateUpdated() {
StringBuffer buf = new StringBuffer(32*1024);
PeerDataWriter writer = new PeerDataWriter();
@@ -46,14 +50,14 @@ class HeartbeatPlotPane extends JPanel {
private void initializeComponents() {
setBackground(new Color(255, 255, 255));
- //Dimension size = new Dimension(800, 600);
+ // Dimension size = new Dimension(800, 600);
_text = new JTextArea("",30,80); // 16, 60);
_text.setAutoscrolls(true);
_text.setEditable(false);
-// _text.setLineWrap(true);
-// add(new JScrollPane(_text));
+ // _text.setLineWrap(true);
+ // add(new JScrollPane(_text));
add(_text);
- //add(new JScrollPane(_text, JScrollPane.VERTICAL_SCROLLBAR_ALWAYS, JScrollPane.HORIZONTAL_SCROLLBAR_ALWAYS));
- //setPreferredSize(size);
+ // add(new JScrollPane(_text, JScrollPane.VERTICAL_SCROLLBAR_ALWAYS, JScrollPane.HORIZONTAL_SCROLLBAR_ALWAYS));
+ // setPreferredSize(size);
}
}
\ No newline at end of file
diff --git a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/PeerPlotConfig.java b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/PeerPlotConfig.java
index d7cfc3ee7cff0f9d5ba3ecd0e3e5aa7455e15a7d..dcb4cf4f9482f168aea2fc76de1a1b4e4f395e41 100644
--- a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/PeerPlotConfig.java
+++ b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/PeerPlotConfig.java
@@ -1,22 +1,20 @@
package net.i2p.heartbeat.gui;
-import java.util.List;
+import java.awt.Color;
import java.util.ArrayList;
-import java.util.Set;
-import java.util.HashSet;
-import java.util.Iterator;
import java.util.Arrays;
import java.util.Collections;
+import java.util.HashSet;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Set;
import java.util.TreeMap;
-import java.awt.Color;
-
import net.i2p.data.Destination;
import net.i2p.heartbeat.ClientConfig;
/**
* Configure how we want to render a particular clientConfig in the GUI
- *
*/
class PeerPlotConfig {
/** where can we find the current state/data (either as a filename or a URL)? */
@@ -30,10 +28,21 @@ class PeerPlotConfig {
private Set _listeners;
private boolean _disabled;
+ /**
+ * Delegating constructor . . .
+ * @param location the name of the file/URL to get the data from
+ */
public PeerPlotConfig(String location) {
this(location, null, null, null);
}
+ /**
+ * Constructs a config =)
+ * @param location the location of the file/URL to get the data from
+ * @param config the client's configuration
+ * @param currentSeriesConfig the series config
+ * @param averageSeriesConfigs the average
+ */
public PeerPlotConfig(String location, ClientConfig config, PlotSeriesConfig currentSeriesConfig, List averageSeriesConfigs) {
_location = location;
if (config == null)
@@ -53,6 +62,9 @@ class PeerPlotConfig {
_disabled = false;
}
+ /**
+ * 'Rebuilds' the average series stuff from the client configuration
+ */
public void rebuildAverageSeriesConfigs() {
int periods[] = _config.getAveragePeriods();
if (periods == null) {
@@ -66,6 +78,10 @@ class PeerPlotConfig {
}
}
+ /**
+ * Adds an average period
+ * @param minutes the number of minutes averaged over
+ */
public void addAverage(int minutes) {
_config.addAveragePeriod(minutes);
@@ -86,33 +102,66 @@ class PeerPlotConfig {
/**
* Where is the current state data supposed to be found? This must either be a
* local file path or a URL
- *
+ * @return the current location
*/
public String getLocation() { return _location; }
+
+ /**
+ * The location the current state data is supposed to be found. This must either be
+ * a local file path or a URL
+ * @param location the location
+ */
public void setLocation(String location) {
_location = location;
fireUpdate();
}
- /** What are we configuring? */
+ /**
+ * What are we configuring?
+ * @return the client configuration
+ */
public ClientConfig getClientConfig() { return _config; }
+
+ /**
+ * Sets what we are currently configuring
+ * @param config the new config
+ */
public void setClientConfig(ClientConfig config) {
_config = config;
fireUpdate();
}
- /** How do we want to render the current data set? */
+ /**
+ * How do we want to render the current data set?
+ * @return the way we currently render the data
+ */
public PlotSeriesConfig getCurrentSeriesConfig() { return _currentSeriesConfig; }
+
+ /**
+ * Sets how we want to render the current data set.
+ * @param config the new config
+ */
public void setCurrentSeriesConfig(PlotSeriesConfig config) {
_currentSeriesConfig = config;
fireUpdate();
}
- /** How do we want to render the averages? */
+ /**
+ * How do we want to render the averages?
+ * @return the way we currently render the averages
+ */
public List getAverageSeriesConfigs() { return _averageSeriesConfigs; }
+
+ /**
+ * Sets how we want to render the averages
+ * @param configs the new configs
+ */
public void setAverageSeriesConfigs(List configs) { _averageSeriesConfigs = configs; }
- /** four char description of the peer */
+ /**
+ * four char description of the peer
+ * @return the name
+ */
public String getPeerName() {
Destination peer = getClientConfig().getPeer();
if (peer == null)
@@ -121,7 +170,18 @@ class PeerPlotConfig {
return peer.calculateHash().toBase64().substring(0, 4);
}
- public String getTitle() { return getPeerName() + '.' + getSize() + '.' + getClientConfig().getSendFrequency(); }
+ /**
+ * title: name.packetsize.sendfrequency
+ * @return the title
+ */
+ public String getTitle() {
+ return getPeerName() + '.' + getSize() + '.' + getClientConfig().getSendFrequency();
+ }
+
+ /**
+ * summary. includes:name, size, sendfrequency, and # of hops
+ * @return the summary
+ */
public String getSummary() {
return "Send peer " + getPeerName() + ' ' + getSize() + " every " +
getClientConfig().getSendFrequency() + " seconds through " +
@@ -136,8 +196,16 @@ class PeerPlotConfig {
return bytes/1024 + "kb";
}
- /** we've got someone who wants to be notified of changes to the plot config */
+ /**
+ * we've got someone who wants to be notified of changes to the plot config
+ * @param lsnr the listener to be added
+ */
public void addListener(UpdateListener lsnr) { _listeners.add(lsnr); }
+
+ /**
+ * remove a listener
+ * @param lsnr the listener to remove
+ */
public void removeListener(UpdateListener lsnr) { _listeners.remove(lsnr); }
void fireUpdate() {
@@ -147,7 +215,16 @@ class PeerPlotConfig {
}
}
+ /**
+ * Disables notification of events listeners
+ * @see PeerPlotConfig#fireUpdate()
+ */
public void disableEvents() { _disabled = true; }
+
+ /**
+ * Enables notification of events listeners
+ * @see PeerPlotConfig#fireUpdate()
+ */
public void enableEvents() { _disabled = false; }
/**
@@ -160,9 +237,25 @@ class PeerPlotConfig {
private boolean _plotLostMessages;
private Color _plotLineColor;
+ /**
+ * Delegating constructor . . .
+ * @param period the period for the config
+ * (0 for current, otherwise # of milliseconds being averaged over)
+ */
public PlotSeriesConfig(long period) {
this(period, false, false, false, null);
}
+
+
+ /**
+ * Creates a config for the rendering of a particular dataset)
+ * @param period the period for the config
+ * (0 for current, otherwise # of milliseconds being averaged over)
+ * @param plotSend do we plot send times?
+ * @param plotReceive do we plot receive times?
+ * @param plotLost do we plot lost packets?
+ * @param plotColor in what color?
+ */
public PlotSeriesConfig(long period, boolean plotSend, boolean plotReceive, boolean plotLost, Color plotColor) {
_period = period;
_plotSendTime = plotSend;
@@ -171,45 +264,95 @@ class PeerPlotConfig {
_plotLineColor = plotColor;
}
+ /**
+ * Retrieves the plot config this plot series config is a part of
+ * @return the plot config
+ */
public PeerPlotConfig getPlotConfig() { return PeerPlotConfig.this; }
/**
* What period is this series config describing?
- *
* @return 0 for current, otherwise # milliseconds that are being averaged over
*/
public long getPeriod() { return _period; }
+
+ /**
+ * Sets the period this series config is describing
+ * @param period the period
+ * (0 for current, otherwise # milliseconds that are being averaged over)
+ */
public void setPeriod(long period) {
_period = period;
fireUpdate();
}
- /** Should we render the time to send (ping to peer)? */
+
+ /**
+ * Should we render the time to send (ping to peer)?
+ * @return true or false . . .
+ */
public boolean getPlotSendTime() { return _plotSendTime; }
+
+ /**
+ * Sets whether we render the time to send (ping to peer) or not
+ * @param shouldPlot true or false
+ */
public void setPlotSendTime(boolean shouldPlot) {
_plotSendTime = shouldPlot;
fireUpdate();
}
- /** Should we render the time to receive (peer pong to us)? */
+
+ /**
+ * Should we render the time to receive (peer pong to us)?
+ * @return true or false . . .
+ */
public boolean getPlotReceiveTime() { return _plotReceiveTime; }
+
+ /**
+ * Sets whether we render the time to receive (peer pong to us)
+ * @param shouldPlot true or false
+ */
public void setPlotReceiveTime(boolean shouldPlot) {
_plotReceiveTime = shouldPlot;
fireUpdate();
}
- /** Should we render the number of messages lost (ping sent, no pong received in time)? */
+ /**
+ * Should we render the number of messages lost (ping sent, no pong received in time)?
+ * @return true or false . . .
+ */
public boolean getPlotLostMessages() { return _plotLostMessages; }
+
+ /**
+ * Sets whether we render the number of messages lost (ping sent, no pong received in time) or not
+ * @param shouldPlot true or false
+ */
public void setPlotLostMessages(boolean shouldPlot) {
_plotLostMessages = shouldPlot;
fireUpdate();
}
- /** What color should we plot the data with? */
+ /**
+ * What color should we plot the data with?
+ * @return the color
+ */
public Color getPlotLineColor() { return _plotLineColor; }
+
+ /**
+ * Sets the color we should plot the data with
+ * @param color the color to use
+ */
public void setPlotLineColor(Color color) {
_plotLineColor = color;
fireUpdate();
}
}
+ /**
+ * An interface for listening to updates . . .
+ */
public interface UpdateListener {
+ /**
+ * @param config the peer plot config that changes
+ * @see PeerPlotConfig#fireUpdate()
+ */
void configUpdated(PeerPlotConfig config);
}
}
\ No newline at end of file
diff --git a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/PeerPlotConfigPane.java b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/PeerPlotConfigPane.java
index 91e6a7ea3ed20aec4f0a0691f9529b5033099b7b..8eb81574030f28009b194371ba3244cfb3d86639 100644
--- a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/PeerPlotConfigPane.java
+++ b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/PeerPlotConfigPane.java
@@ -1,31 +1,24 @@
package net.i2p.heartbeat.gui;
-import net.i2p.util.Log;
-
-import javax.swing.JPanel;
-import javax.swing.JCheckBox;
-import javax.swing.JComboBox;
-import javax.swing.JLabel;
-import javax.swing.JButton;
-import javax.swing.JTextField;
-import javax.swing.JTextArea;
-import javax.swing.JScrollPane;
-import javax.swing.DefaultComboBoxModel;
-import javax.swing.ComboBoxModel;
-import javax.swing.JColorChooser;
-import javax.swing.border.LineBorder;
-import javax.swing.border.BevelBorder;
-import java.awt.BorderLayout;
import java.awt.Color;
-import java.awt.Dimension;
-import java.awt.GridBagLayout;
import java.awt.GridBagConstraints;
+import java.awt.GridBagLayout;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
-
import java.util.List;
import java.util.Random;
+import javax.swing.JButton;
+import javax.swing.JCheckBox;
+import javax.swing.JColorChooser;
+import javax.swing.JLabel;
+import javax.swing.JPanel;
+import javax.swing.JScrollPane;
+import javax.swing.JTextArea;
+import javax.swing.JTextField;
+
+import net.i2p.util.Log;
+
class PeerPlotConfigPane extends JPanel implements PeerPlotConfig.UpdateListener {
private final static Log _log = new Log(PeerPlotConfigPane.class);
private PeerPlotConfig _config;
@@ -44,6 +37,11 @@ class PeerPlotConfigPane extends JPanel implements PeerPlotConfig.UpdateListener
private final static Color WHITE = new Color(255, 255, 255);
private Color _background = WHITE;
+ /**
+ * Constructs a pane
+ * @param config the plot config it represents
+ * @param pane the pane this one is attached to
+ */
public PeerPlotConfigPane(PeerPlotConfig config, HeartbeatControlPane pane) {
_config = config;
_parent = pane;
@@ -66,7 +64,10 @@ class PeerPlotConfigPane extends JPanel implements PeerPlotConfig.UpdateListener
setBackground(_background);
}
- /** place all the gui components onto the given panel */
+ /**
+ * place all the gui components onto the given panel
+ * @param body the panel to place the components on
+ */
private void placeComponents(JPanel body) {
body.setLayout(new GridBagLayout());
GridBagConstraints cts = new GridBagConstraints();
@@ -206,7 +207,11 @@ class PeerPlotConfigPane extends JPanel implements PeerPlotConfig.UpdateListener
}
}
- /** find the right config for the given period, or null if none exist */
+ /**
+ * find the right config for the given period
+ * @param minutes the minutes to locate the config by
+ * @return the config for the given period, or null
+ */
private PeerPlotConfig.PlotSeriesConfig getConfig(int minutes) {
if (minutes <= 0)
return _config.getCurrentSeriesConfig();
@@ -220,17 +225,27 @@ class PeerPlotConfigPane extends JPanel implements PeerPlotConfig.UpdateListener
return null;
}
- /** notified that the config has been updated */
+ /**
+ * notified that the config has been updated
+ * @param config the config that was been updated
+ */
public void configUpdated(PeerPlotConfig config) { refreshView(); }
private class ChooseColor implements ActionListener {
private int _minutes;
private JButton _button;
+ /**
+ * @param minutes the minutes (line) to change the color of...
+ * @param button the associated button
+ */
public ChooseColor(int minutes, JButton button) {
_minutes = minutes;
_button = button;
}
+ /* (non-Javadoc)
+ * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
+ */
public void actionPerformed(ActionEvent evt) {
PeerPlotConfig.PlotSeriesConfig cfg = getConfig(_minutes);
Color origColor = null;
@@ -253,6 +268,10 @@ class PeerPlotConfigPane extends JPanel implements PeerPlotConfig.UpdateListener
JCheckBox _all;
JButton _color;
+ /**
+ * Creates an OptionLine.
+ * @param durationMinutes the minutes =)
+ */
public OptionLine(int durationMinutes) {
_durationMinutes = durationMinutes;
_send = new JCheckBox("send time");
@@ -283,10 +302,20 @@ class PeerPlotConfigPane extends JPanel implements PeerPlotConfig.UpdateListener
private class UpdateListener implements ActionListener {
private OptionLine _line;
private int _minutes;
+
+ /**
+ * Update Listener constructor . . .
+ * @param line the line
+ * @param minutes the minutes
+ */
public UpdateListener(OptionLine line, int minutes) {
_line = line;
_minutes = minutes;
}
+
+ /* (non-Javadoc)
+ * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
+ */
public void actionPerformed(ActionEvent evt) {
PeerPlotConfig.PlotSeriesConfig cfg = getConfig(_minutes);
if (cfg == null) {
@@ -315,12 +344,19 @@ class PeerPlotConfigPane extends JPanel implements PeerPlotConfig.UpdateListener
}
}
+ /**
+ * Unit test stuff
+ * @param args da arsg
+ */
public final static void main(String args[]) {
Test t = new Test();
t.runTest();
}
private final static class Test implements PeerPlotStateFetcher.FetchStateReceptor {
+ /**
+ * Runs da test
+ */
public void runTest() {
PeerPlotConfig cfg = new PeerPlotConfig("C:\\testnet\\r2\\heartbeatStat_10s_30kb.txt");
PeerPlotState state = new PeerPlotState(cfg);
@@ -329,6 +365,9 @@ class PeerPlotConfigPane extends JPanel implements PeerPlotConfig.UpdateListener
System.exit(-1);
}
+ /* (non-Javadoc)
+ * @see net.i2p.heartbeat.gui.PeerPlotStateFetcher.FetchStateReceptor#peerPlotStateFetched(net.i2p.heartbeat.gui.PeerPlotState)
+ */
public void peerPlotStateFetched(PeerPlotState state) {
javax.swing.JFrame f = new javax.swing.JFrame("Test");
f.getContentPane().add(new JScrollPane(new PeerPlotConfigPane(state.getPlotConfig(), null)));
diff --git a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/PeerPlotState.java b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/PeerPlotState.java
index f0c3f600622c70f314d25f5d1d60b0e4167d7b0a..d658081a39f61b1f4dc7837f9c774fd5d05b69d1 100644
--- a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/PeerPlotState.java
+++ b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/PeerPlotState.java
@@ -1,6 +1,5 @@
package net.i2p.heartbeat.gui;
-import net.i2p.heartbeat.PeerData;
/**
* Current data + plot config for a particular test
@@ -10,17 +9,39 @@ class PeerPlotState {
private StaticPeerData _currentData;
private PeerPlotConfig _plotConfig;
+ /**
+ * Delegating constructor . . .
+ * @see PeerPlotState#PeerPlotState(PeerPlotConfig, StaticPeerData)
+ */
public PeerPlotState() {
this(null, null);
}
+
+ /**
+ * Delegating constructor . . .
+ * @param config plot config
+ * @see PeerPlotState#PeerPlotState(PeerPlotConfig, StaticPeerData)
+ */
public PeerPlotState(PeerPlotConfig config) {
this(config, new StaticPeerData(config.getClientConfig()));
}
+ /**
+ * Creates a PeerPlotState
+ * @param config plot config
+ * @param data peer data
+ */
public PeerPlotState(PeerPlotConfig config, StaticPeerData data) {
_plotConfig = config;
_currentData = data;
}
+ /**
+ * Add an average
+ * @param minutes mins averaged over
+ * @param sendMs how much later did the peer receieve
+ * @param recvMs how much later did we receieve
+ * @param lost how many were lost
+ */
public void addAverage(int minutes, int sendMs, int recvMs, int lost) {
// make sure we've got the config entry for the average
_plotConfig.addAverage(minutes);
@@ -48,11 +69,27 @@ class PeerPlotState {
_currentData.addData(sendTime);
}
- /** data set to render */
+ /**
+ * data set to render
+ * @return the data set
+ */
public StaticPeerData getCurrentData() { return _currentData; }
+
+ /**
+ * Sets the data set to render
+ * @param data the data set
+ */
public void setCurrentData(StaticPeerData data) { _currentData = data; }
- /** configuration options on how to render the data set */
+ /**
+ * configuration options on how to render the data set
+ * @return the config options
+ */
public PeerPlotConfig getPlotConfig() { return _plotConfig; }
+
+ /**
+ * Sets the configuration options on how to render the data
+ * @param config the config options
+ */
public void setPlotConfig(PeerPlotConfig config) { _plotConfig = config; }
}
\ No newline at end of file
diff --git a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/PeerPlotStateFetcher.java b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/PeerPlotStateFetcher.java
index 5fa598f6ac6cc5fa40eb8c0ff54d80c8fd70831f..770883bcc06854501aaa7932401844f00133c357 100644
--- a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/PeerPlotStateFetcher.java
+++ b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/PeerPlotStateFetcher.java
@@ -1,35 +1,29 @@
package net.i2p.heartbeat.gui;
-import net.i2p.util.Log;
-import net.i2p.util.I2PThread;
-
-import net.i2p.data.Destination;
-import net.i2p.data.DataFormatException;
-
-import net.i2p.heartbeat.ClientConfig;
-import net.i2p.heartbeat.PeerData;
-
import java.io.BufferedReader;
+import java.io.FileInputStream;
+import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
-import java.io.IOException;
-import java.io.FileInputStream;
-import java.net.URL;
import java.net.MalformedURLException;
-
-import java.text.SimpleDateFormat;
+import java.net.URL;
import java.text.ParseException;
+import java.text.SimpleDateFormat;
import java.util.Locale;
-import java.util.List;
-import java.util.ArrayList;
import java.util.StringTokenizer;
+import net.i2p.data.DataFormatException;
+import net.i2p.data.Destination;
+import net.i2p.util.I2PThread;
+import net.i2p.util.Log;
+
class PeerPlotStateFetcher {
private final static Log _log = new Log(PeerPlotStateFetcher.class);
/**
* Fetch and fill the specified state structure
- *
+ * @param receptor the 'receptor' (callbacks)
+ * @param state the state
*/
public static void fetchPeerPlotState(FetchStateReceptor receptor, PeerPlotState state) {
I2PThread t = new I2PThread(new Fetcher(receptor, state));
@@ -38,17 +32,34 @@ class PeerPlotStateFetcher {
t.start();
}
+ /**
+ * Callback stuff . . .
+ */
public interface FetchStateReceptor {
+ /**
+ * Called when a peer plot state is fetched
+ * @param state state that was fetched
+ */
void peerPlotStateFetched(PeerPlotState state);
}
private static class Fetcher implements Runnable {
private PeerPlotState _state;
private FetchStateReceptor _receptor;
+
+ /**
+ * Creates a Fetcher thread
+ * @param receptor the 'receptor' (callbacks)
+ * @param state the state
+ */
public Fetcher(FetchStateReceptor receptor, PeerPlotState state) {
_state = state;
_receptor = receptor;
}
+
+ /* (non-Javadoc)
+ * @see java.lang.Runnable#run()
+ */
public void run() {
String loc = _state.getPlotConfig().getLocation();
_log.debug("Load called [" + loc + "]");
@@ -82,7 +93,7 @@ class PeerPlotStateFetcher {
/**
* check to make sure we've got everything we need
- *
+ * @return true [always]
*/
boolean valid() {
return true;
@@ -139,6 +150,8 @@ class PeerPlotStateFetcher {
* EVENT LOST 20040409.23:30:22.656
* EVENT OK 20040409.23:31:24.305 1843 771
* </pre>
+ *
+ * @param line (see above)
*/
private void handleLine(String line) {
if (line.startsWith("peerDest"))
diff --git a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/StaticPeerData.java b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/StaticPeerData.java
index 784debc8b79c615cd700b65a39c9c2d19bc7939b..9b1289578c51966542fd552dca75f7f87dfbee63 100644
--- a/apps/heartbeat/java/src/net/i2p/heartbeat/gui/StaticPeerData.java
+++ b/apps/heartbeat/java/src/net/i2p/heartbeat/gui/StaticPeerData.java
@@ -1,14 +1,13 @@
package net.i2p.heartbeat.gui;
-import net.i2p.heartbeat.PeerData;
-import net.i2p.heartbeat.ClientConfig;
-
-import java.util.Map;
import java.util.HashMap;
+import java.util.Map;
+
+import net.i2p.heartbeat.ClientConfig;
+import net.i2p.heartbeat.PeerData;
/**
* Raw data points for a test
- *
*/
class StaticPeerData extends PeerData {
private int _pending;
@@ -19,6 +18,10 @@ class StaticPeerData extends PeerData {
/** Integer (period, in minutes) to Integer (num messages) of how many messages were lost on average */
private Map _lostMessages;
+ /**
+ * Creates a static peer data with a specified client config ... duh
+ * @param config the client config
+ */
public StaticPeerData(ClientConfig config) {
super(config);
_averageSendTimes = new HashMap(4);
@@ -26,16 +29,36 @@ class StaticPeerData extends PeerData {
_lostMessages = new HashMap(4);
}
-
+ /**
+ * Adds averaged data
+ * @param minutes the minutes (averaged over)
+ * @param sendMs the send time (ping) in milliseconds
+ * @param recvMs the receive time (pong) in milliseconds
+ * @param lost the number lost
+ */
public void addAverage(int minutes, int sendMs, int recvMs, int lost) {
_averageSendTimes.put(new Integer(minutes), new Integer(sendMs));
_averageReceiveTimes.put(new Integer(minutes), new Integer(recvMs));
_lostMessages.put(new Integer(minutes), new Integer(lost));
}
+ /**
+ * Sets the number pending
+ * @param numPending the number pending
+ */
public void setPendingCount(int numPending) { _pending = numPending; }
+
+ /* (non-Javadoc)
+ * @see net.i2p.heartbeat.PeerData#setSessionStart(long)
+ */
public void setSessionStart(long when) { super.setSessionStart(when); }
+ /**
+ * Adds data
+ * @param sendTime the time it was sent
+ * @param sendMs the send time (ping) in milliseconds
+ * @param recvMs the receive time (pong) in milliseconds
+ */
public void addData(long sendTime, int sendMs, int recvMs) {
PeerData.EventDataPoint dataPoint = new PeerData.EventDataPoint(sendTime);
dataPoint.setPongSent(sendTime + sendMs);
@@ -44,14 +67,16 @@ class StaticPeerData extends PeerData {
addDataPoint(dataPoint);
}
+ /**
+ * Adds data
+ * @param sendTime the time it was sent
+ */
public void addData(long sendTime) {
PeerData.EventDataPoint dataPoint = new PeerData.EventDataPoint(sendTime);
dataPoint.setWasPonged(false);
addDataPoint(dataPoint);
}
-
-
-
+
/**
* how many pings are still outstanding?
* @return the number of pings outstanding
@@ -79,8 +104,7 @@ class StaticPeerData extends PeerData {
public double getAverageReceiveTime(int period) {
return ((Integer)_averageReceiveTimes.get(new Integer(period))).doubleValue();
}
-
-
+
/**
* number of lost messages over the given period.
*
@@ -91,5 +115,8 @@ class StaticPeerData extends PeerData {
return ((Integer)_lostMessages.get(new Integer(period))).doubleValue();
}
+ /* (non-Javadoc)
+ * @see net.i2p.heartbeat.PeerData#cleanup()
+ */
public void cleanup() {}
}
\ No newline at end of file