Skip to content
Snippets Groups Projects
Commit 23ba9dca authored by Brutzman, Don's avatar Brutzman, Don
Browse files

add javadoc linking SelfTestLog.txt files

parent e36f4993
No related branches found
No related tags found
No related merge requests found
......@@ -19,8 +19,12 @@ import java.util.logging.Level;
import java.util.logging.Logger;
/**
* This is a thread-safe, multicast DIS network interface class.
* This is a thread-safe, multicast DIS network interface class which greatly simplifies reading and writing of PDUs for applications.
*
* Example <code>main()</code> self-test response shown in log file.
* @see <a href="https://github.com/open-dis/open-dis7-java/blob/master/src/edu/nps/moves/dis7/utilities/DisThreadedNetworkInterfaceSelfTestLog.txt">https://github.com/open-dis/open-dis7-java/blob/master/src/edu/nps/moves/dis7/utilities/DisThreadedNetworkInterfaceSelfTestLog.txt</a>
*
* @author Don Brutzman, brutzman@nps.edu
* @author Mike Bailey, jmbailey@nps.edu
* @since Jul 29, 2019
*/
......@@ -538,7 +542,7 @@ public class DisThreadedNetworkInterface
}
/** Tell sendingThread and receiveThread to stop. */
public void setKillSentinelAndInterrupts() // TODO rename AndInterrupts
public void setKillSentinelAndInterrupts()
{
killed = true; // set loop sentinel for threads to finish
......
......@@ -19,9 +19,13 @@ import java.util.Base64;
import java.util.List;
import java.util.regex.Pattern;
/** Utility to play back log files of recorded PDUs. These PDUs can then be resent
/** Utility to play back log files of recorded PDUs, found in ancestor <code>pduLogs</code> subdirectory. These PDUs can then be resent
* over a multicast group address, or processed locally.
*
* Example <code>main()</code> self-test response shown in log file.
* @see <a href="https://github.com/open-dis/open-dis7-java/blob/master/src/edu/nps/moves/dis7/utilities/stream/PduPlayerSelfTestLog.txt">https://github.com/open-dis/open-dis7-java/blob/master/src/edu/nps/moves/dis7/utilities/stream/PduPlayerSelfTestLog.txt</a>
*
* @author Don Brutzman, brutzman@nps.edu
* @author Mike Bailey, jmbailey@nps.edu
*/
public class PduPlayer {
......
/**
* Copyright (c) 2008-2021, MOVES Institute, Naval Postgraduate School (NPS). All rights reserved.
* This work is provided under a BSD open-source license, see project license.html and license.txt
*/
package edu.nps.moves.dis7.utilities.stream;
/** An interface for capturing PDU raw data for file logging
*
* @author Mike Bailey, jmbailey@nps.edu
*/
public interface PduReceiver
{
/** Receives a PDU and writes its raw contents to an output file for later
* playback and inspection.
*
* @param bufferByteArray the array containing raw PDU data
* @param len the length of the buffer
*/
void receivePdu(byte[] bufferByteArray, int len);
}
......@@ -25,8 +25,12 @@ import java.util.logging.Level;
import java.util.logging.Logger;
import org.apache.commons.io.FilenameUtils;
/** Utility to save PDUs received over the network to disk
/** Utility to save PDUs received over the network to disk, greatly simplifying the capture of DIS streams by applications.
*
* Example <code>main()</code> self-test response shown in log file.
* @see <a href="https://github.com/open-dis/open-dis7-java/blob/master/src/edu/nps/moves/dis7/utilities/stream/PduRecorderSelfTest.log.txt">https://github.com/open-dis/open-dis7-java/blob/master/src/edu/nps/moves/dis7/utilities/stream/PduRecorderSelfTest.log.txt</a>
*
* @author Don Brutzman, brutzman@nps.edu
* @author Mike Bailey, jmbailey@nps.edu
*/
public class PduRecorder // implements PduReceiver
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment