This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-net.git
The following commit(s) were added to refs/heads/master by this push:
new 1be0b60 Use the scale in the var name.
1be0b60 is described below
commit 1be0b609518e6d1f1308810c95c373e3feec7e27
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue Feb 2 14:08:06 2021 -0500
Use the scale in the var name.
We use milliseconds everywhere except in one API where we use seconds.
---
.../commons/net/examples/ftp/FTPClientExample.java | 20 ++---
.../apache/commons/net/examples/ntp/NTPClient.java | 12 +--
.../java/org/apache/commons/net/ftp/FTPClient.java | 85 +++++++++++-----------
.../org/apache/commons/net/ntp/NTPUDPClient.java | 6 +-
.../java/org/apache/commons/net/ntp/TimeInfo.java | 79 ++++++++++----------
.../java/org/apache/commons/net/ntp/TimeStamp.java | 43 ++++++-----
.../org/apache/commons/net/ntp/TestNtpClient.java | 8 +-
.../org/apache/commons/net/ntp/TestTimeInfo.java | 8 +-
8 files changed, 129 insertions(+), 132 deletions(-)
diff --git
a/src/main/java/org/apache/commons/net/examples/ftp/FTPClientExample.java
b/src/main/java/org/apache/commons/net/examples/ftp/FTPClientExample.java
index ee049fd..3dfada9 100644
--- a/src/main/java/org/apache/commons/net/examples/ftp/FTPClientExample.java
+++ b/src/main/java/org/apache/commons/net/examples/ftp/FTPClientExample.java
@@ -94,8 +94,8 @@ public final class FTPClientExample
boolean mlst = false, mlsd = false, mdtm = false, saveUnparseable =
false;
boolean size = false;
boolean lenient = false;
- long keepAliveTimeout = -1;
- int controlKeepAliveReplyTimeout = -1;
+ long keepAliveTimeoutSeconds = -1;
+ int controlKeepAliveReplyTimeoutMillis = -1;
int minParams = 5; // listings require 3 params
String protocol = null; // SSL protocol
String doCommand = null;
@@ -156,7 +156,7 @@ public final class FTPClientExample
minParams = 3;
}
else if (args[base].equals("-k")) {
- keepAliveTimeout = Long.parseLong(args[++base]);
+ keepAliveTimeoutSeconds = Long.parseLong(args[++base]);
}
else if (args[base].equals("-l")) {
listFiles = true;
@@ -187,7 +187,7 @@ public final class FTPClientExample
saveUnparseable = true;
}
else if (args[base].equals("-w")) {
- controlKeepAliveReplyTimeout = Integer.parseInt(args[++base]);
+ controlKeepAliveReplyTimeoutMillis =
Integer.parseInt(args[++base]);
}
else if (args[base].equals("-T")) {
trustmgr = args[++base];
@@ -297,11 +297,11 @@ public final class FTPClientExample
if (printHash) {
ftp.setCopyStreamListener(createListener());
}
- if (keepAliveTimeout >= 0) {
- ftp.setControlKeepAliveTimeout(keepAliveTimeout);
+ if (keepAliveTimeoutSeconds >= 0) {
+ ftp.setControlKeepAliveTimeout(keepAliveTimeoutSeconds);
}
- if (controlKeepAliveReplyTimeout >= 0) {
- ftp.setControlKeepAliveReplyTimeout(controlKeepAliveReplyTimeout);
+ if (controlKeepAliveReplyTimeoutMillis >= 0) {
+
ftp.setControlKeepAliveReplyTimeout(controlKeepAliveReplyTimeoutMillis);
}
if (encoding != null) {
ftp.setControlEncoding(encoding);
@@ -401,7 +401,7 @@ __main:
ftp.storeFile(remote, input);
}
- if (keepAliveTimeout > 0) {
+ if (keepAliveTimeoutSeconds > 0) {
showCslStats(ftp);
}
}
@@ -505,7 +505,7 @@ __main:
ftp.retrieveFile(remote, output);
}
- if (keepAliveTimeout > 0) {
+ if (keepAliveTimeoutSeconds > 0) {
showCslStats(ftp);
}
}
diff --git a/src/main/java/org/apache/commons/net/examples/ntp/NTPClient.java
b/src/main/java/org/apache/commons/net/examples/ntp/NTPClient.java
index 3152c51..7e18a06 100644
--- a/src/main/java/org/apache/commons/net/examples/ntp/NTPClient.java
+++ b/src/main/java/org/apache/commons/net/examples/ntp/NTPClient.java
@@ -123,7 +123,7 @@ public final class NTPClient
final TimeStamp origNtpTime = message.getOriginateTimeStamp();
System.out.println(" Originate Timestamp:\t" + origNtpTime + " " +
origNtpTime.toDateString());
- final long destTime = info.getReturnTime();
+ final long destTimeMillis = info.getReturnTime();
// Receive Time is time request received by server (t2)
final TimeStamp rcvNtpTime = message.getReceiveTimeStamp();
System.out.println(" Receive Timestamp:\t" + rcvNtpTime + " " +
rcvNtpTime.toDateString());
@@ -133,14 +133,14 @@ public final class NTPClient
System.out.println(" Transmit Timestamp:\t" + xmitNtpTime + " " +
xmitNtpTime.toDateString());
// Destination time is time reply received by client (t4)
- final TimeStamp destNtpTime = TimeStamp.getNtpTime(destTime);
+ final TimeStamp destNtpTime = TimeStamp.getNtpTime(destTimeMillis);
System.out.println(" Destination Timestamp:\t" + destNtpTime + " " +
destNtpTime.toDateString());
info.computeDetails(); // compute offset/delay if not already done
- final Long offsetValue = info.getOffset();
- final Long delayValue = info.getDelay();
- final String delay = delayValue == null ? "N/A" :
delayValue.toString();
- final String offset = offsetValue == null ? "N/A" :
offsetValue.toString();
+ final Long offsetMillis = info.getOffset();
+ final Long delayMillis = info.getDelay();
+ final String delay = delayMillis == null ? "N/A" :
delayMillis.toString();
+ final String offset = offsetMillis == null ? "N/A" :
offsetMillis.toString();
System.out.println(" Roundtrip delay(ms)=" + delay
+ ", clock offset(ms)=" + offset); // offset in ms
diff --git a/src/main/java/org/apache/commons/net/ftp/FTPClient.java
b/src/main/java/org/apache/commons/net/ftp/FTPClient.java
index 9126684..b688f29 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPClient.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPClient.java
@@ -357,7 +357,7 @@ implements Configurable
public static final int PASSIVE_REMOTE_DATA_CONNECTION_MODE = 3;
private int dataConnectionMode;
- private int dataTimeout;
+ private int dataTimeoutMillis;
private int passivePort;
private String passiveHost;
private final Random random;
@@ -401,11 +401,11 @@ implements Configurable
private CopyStreamListener copyStreamListener;
// How long to wait before sending another control keep-alive message
- private long controlKeepAliveTimeout;
+ private long controlKeepAliveTimeoutMillis;
- // How long to wait (ms) for keepalive message replies before continuing
+ // How long to wait (millis) for keepalive message replies before
continuing
// Most FTP servers don't seem to support concurrent control and data
connection usage
- private int controlKeepAliveReplyTimeout = 1000;
+ private int controlKeepAliveReplyTimeoutMillis = 1000;
// Debug counts for NOOP acks
private int[] cslDebug;
@@ -480,7 +480,7 @@ implements Configurable
public FTPClient()
{
initDefaults();
- dataTimeout = -1;
+ dataTimeoutMillis = -1;
remoteVerificationEnabled = true;
parserFactory = new DefaultFTPFileEntryParserFactory();
configuration = null;
@@ -674,8 +674,8 @@ implements Configurable
}
CSL csl = null;
- if (controlKeepAliveTimeout > 0) {
- csl = new CSL(this, controlKeepAliveTimeout,
controlKeepAliveReplyTimeout);
+ if (controlKeepAliveTimeoutMillis > 0) {
+ csl = new CSL(this, controlKeepAliveTimeoutMillis,
controlKeepAliveReplyTimeoutMillis);
}
// Treat everything else as binary for now
@@ -857,14 +857,14 @@ implements Configurable
// the data connection. It may be desirable to let this be a
// separately configurable value. In any case, we really want
// to allow preventing the accept from blocking indefinitely.
- if (dataTimeout >= 0) {
- server.setSoTimeout(dataTimeout);
+ if (dataTimeoutMillis >= 0) {
+ server.setSoTimeout(dataTimeoutMillis);
}
socket = server.accept();
// Ensure the timeout is set before any commands are issued on
the new socket
- if (dataTimeout >= 0) {
- socket.setSoTimeout(dataTimeout);
+ if (dataTimeoutMillis >= 0) {
+ socket.setSoTimeout(dataTimeoutMillis);
}
if (receiveDataSocketBufferSize > 0) {
socket.setReceiveBufferSize(receiveDataSocketBufferSize);
@@ -916,8 +916,8 @@ implements Configurable
// the data connection. It may be desirable to let this be a
// separately configurable value. In any case, we really want
// to allow preventing the accept from blocking indefinitely.
- if (dataTimeout >= 0) {
- socket.setSoTimeout(dataTimeout);
+ if (dataTimeoutMillis >= 0) {
+ socket.setSoTimeout(dataTimeoutMillis);
}
socket.connect(new InetSocketAddress(passiveHost, passivePort),
connectTimeout);
@@ -997,12 +997,12 @@ implements Configurable
* <p>
* <b>Note:</b> the timeout will also be applied when calling accept()
* whilst establishing an active local data connection.
- * @param timeout The default timeout in milliseconds that is used when
+ * @param timeoutMillis The default timeout in milliseconds that is used
when
* opening a data connection socket. The value 0 means an infinite
timeout.
*/
- public void setDataTimeout(final int timeout)
+ public void setDataTimeout(final int timeoutMillis)
{
- dataTimeout = timeout;
+ dataTimeoutMillis = timeoutMillis;
}
/**
@@ -1911,8 +1911,8 @@ implements Configurable
input = getBufferedInputStream(socket.getInputStream());
}
- if (controlKeepAliveTimeout > 0) {
- csl = new CSL(this, controlKeepAliveTimeout,
controlKeepAliveReplyTimeout);
+ if (controlKeepAliveTimeoutMillis > 0) {
+ csl = new CSL(this, controlKeepAliveTimeoutMillis,
controlKeepAliveReplyTimeoutMillis);
}
// Treat everything else as binary for now
@@ -3802,16 +3802,16 @@ implements Configurable
* <p>
* See the class Javadoc section "Control channel keep-alive feature:"
*
- * @param controlIdle the wait (in seconds) between keepalive messages.
Zero (or less) disables.
+ * @param controlIdleSeconds the wait (in seconds) between keepalive
messages. Zero (or less) disables.
* @since 3.0
* @see #setControlKeepAliveReplyTimeout(int)
*/
- public void setControlKeepAliveTimeout(final long controlIdle){
- controlKeepAliveTimeout = controlIdle * 1000;
+ public void setControlKeepAliveTimeout(final long controlIdleSeconds){
+ controlKeepAliveTimeoutMillis = controlIdleSeconds * 1000;
}
/**
- * Get the time to wait between sending control connection keepalive
messages
+ * Gets the time to wait between sending control connection keepalive
messages
* when processing file upload or download.
* <p>
* See the class Javadoc section "Control channel keep-alive feature:"
@@ -3820,7 +3820,7 @@ implements Configurable
* @since 3.0
*/
public long getControlKeepAliveTimeout() {
- return controlKeepAliveTimeout / 1000;
+ return controlKeepAliveTimeoutMillis / 1000;
}
/**
@@ -3842,28 +3842,29 @@ implements Configurable
public int[] getCslDebug() {
return cslDebug;
}
+
/**
- * Set how long to wait for control keep-alive message replies.
+ * Sets how long to wait for control keep-alive message replies.
*
- * @param timeout number of milliseconds to wait (defaults to 1000)
+ * @param timeoutMillis number of milliseconds to wait (defaults to 1000)
* @since 3.0
* @see #setControlKeepAliveTimeout(long)
*/
- public void setControlKeepAliveReplyTimeout(final int timeout) {
- controlKeepAliveReplyTimeout = timeout;
+ public void setControlKeepAliveReplyTimeout(final int timeoutMillis) {
+ controlKeepAliveReplyTimeoutMillis = timeoutMillis;
}
/**
- * Get how long to wait for control keep-alive message replies.
- * @return wait time in msec
+ * Gets how long to wait for control keep-alive message replies.
+ * @return wait time in milliseconds.
* @since 3.0
*/
public int getControlKeepAliveReplyTimeout() {
- return controlKeepAliveReplyTimeout;
+ return controlKeepAliveReplyTimeoutMillis;
}
/**
- * Enable or disable passive mode NAT workaround.
+ * Enables or disables passive mode NAT workaround.
* If enabled, a site-local PASV mode reply address will be replaced with
the
* remote host address to which the PASV mode request was sent
* (unless that is also a site local address).
@@ -3953,19 +3954,19 @@ implements Configurable
private static class CSL implements CopyStreamListener {
private final FTPClient parent;
- private final long idle;
- private final int currentSoTimeout;
+ private final long idleMillis;
+ private final int currentSoTimeoutMillis;
- private long time = System.currentTimeMillis();
+ private long timeMillis = System.currentTimeMillis();
private int notAcked;
private int acksAcked;
private int ioErrors;
- CSL(final FTPClient parent, final long idleTime, final int maxWait)
throws SocketException {
- this.idle = idleTime;
+ CSL(final FTPClient parent, final long idleTimeMillis, final int
maxWaitMillis) throws SocketException {
+ this.idleMillis = idleTimeMillis;
this.parent = parent;
- this.currentSoTimeout = parent.getSoTimeout();
- parent.setSoTimeout(maxWait);
+ this.currentSoTimeoutMillis = parent.getSoTimeout();
+ parent.setSoTimeout(maxWaitMillis);
}
@Override
@@ -3976,8 +3977,8 @@ implements Configurable
@Override
public void bytesTransferred(final long totalBytesTransferred,
final int bytesTransferred, final long streamSize) {
- final long now = System.currentTimeMillis();
- if (now - time > idle) {
+ final long nowMillis = System.currentTimeMillis();
+ if (nowMillis - timeMillis > idleMillis) {
try {
parent.__noop();
acksAcked++;
@@ -3987,7 +3988,7 @@ implements Configurable
ioErrors++;
// Ignored
}
- time = now;
+ timeMillis = nowMillis;
}
}
@@ -4001,7 +4002,7 @@ implements Configurable
} catch (final SocketTimeoutException e) { // NET-584
// ignored
} finally {
- parent.setSoTimeout(currentSoTimeout);
+ parent.setSoTimeout(currentSoTimeoutMillis);
}
return new int [] {acksAcked, remain, notAcked, ioErrors}; //
debug counts
}
diff --git a/src/main/java/org/apache/commons/net/ntp/NTPUDPClient.java
b/src/main/java/org/apache/commons/net/ntp/NTPUDPClient.java
index 9df32ac..490e907 100644
--- a/src/main/java/org/apache/commons/net/ntp/NTPUDPClient.java
+++ b/src/main/java/org/apache/commons/net/ntp/NTPUDPClient.java
@@ -89,11 +89,9 @@ public final class NTPUDPClient extends DatagramSocketClient
_socket_.send(sendPacket);
_socket_.receive(receivePacket);
- final long returnTime = System.currentTimeMillis();
+ final long returnTimeMillis = System.currentTimeMillis();
// create TimeInfo message container but don't pre-compute the details
yet
- final TimeInfo info = new TimeInfo(recMessage, returnTime, false);
-
- return info;
+ return new TimeInfo(recMessage, returnTimeMillis, false);
}
/**
diff --git a/src/main/java/org/apache/commons/net/ntp/TimeInfo.java
b/src/main/java/org/apache/commons/net/ntp/TimeInfo.java
index d1d5966..1fb55a1 100644
--- a/src/main/java/org/apache/commons/net/ntp/TimeInfo.java
+++ b/src/main/java/org/apache/commons/net/ntp/TimeInfo.java
@@ -25,19 +25,18 @@ import java.util.List;
/**
* Wrapper class to network time packet messages (NTP, etc) that computes
* related timing info and stats.
- *
*/
public class TimeInfo {
private final NtpV3Packet message;
private List<String> comments;
- private Long delay;
- private Long offset;
+ private Long delayMillis;
+ private Long offsetMillis;
/**
* time at which time message packet was received by local machine
*/
- private final long returnTime;
+ private final long returnTimeMillis;
/**
* flag indicating that the TimeInfo details was processed and
delay/offset were computed
@@ -48,24 +47,24 @@ public class TimeInfo {
* Create TimeInfo object with raw packet message and destination time
received.
*
* @param message NTP message packet
- * @param returnTime destination receive time
+ * @param returnTimeMillis destination receive time
* @throws IllegalArgumentException if message is null
*/
- public TimeInfo(final NtpV3Packet message, final long returnTime) {
- this(message, returnTime, null, true);
+ public TimeInfo(final NtpV3Packet message, final long returnTimeMillis) {
+ this(message, returnTimeMillis, null, true);
}
/**
* Create TimeInfo object with raw packet message and destination time
received.
*
* @param message NTP message packet
- * @param returnTime destination receive time
+ * @param returnTimeMillis destination receive time
* @param comments List of errors/warnings identified during processing
* @throws IllegalArgumentException if message is null
*/
- public TimeInfo(final NtpV3Packet message, final long returnTime, final
List<String> comments)
+ public TimeInfo(final NtpV3Packet message, final long returnTimeMillis,
final List<String> comments)
{
- this(message, returnTime, comments, true);
+ this(message, returnTimeMillis, comments, true);
}
/**
@@ -75,13 +74,13 @@ public class TimeInfo {
* intialization when sub-millisecond timing is needed.
*
* @param msgPacket NTP message packet
- * @param returnTime destination receive time
+ * @param returnTimeMillis destination receive time
* @param doComputeDetails flag to pre-compute delay/offset values
* @throws IllegalArgumentException if message is null
*/
- public TimeInfo(final NtpV3Packet msgPacket, final long returnTime, final
boolean doComputeDetails)
+ public TimeInfo(final NtpV3Packet msgPacket, final long returnTimeMillis,
final boolean doComputeDetails)
{
- this(msgPacket, returnTime, null, doComputeDetails);
+ this(msgPacket, returnTimeMillis, null, doComputeDetails);
}
/**
@@ -91,18 +90,18 @@ public class TimeInfo {
* intialization when sub-millisecond timing is needed.
*
* @param message NTP message packet
- * @param returnTime destination receive time
+ * @param returnTimeMillis destination receive time
* @param comments list of comments used to store errors/warnings with
message
* @param doComputeDetails flag to pre-compute delay/offset values
* @throws IllegalArgumentException if message is null
*/
- public TimeInfo(final NtpV3Packet message, final long returnTime, final
List<String> comments,
+ public TimeInfo(final NtpV3Packet message, final long returnTimeMillis,
final List<String> comments,
final boolean doComputeDetails)
{
if (message == null) {
throw new IllegalArgumentException("message cannot be null");
}
- this.returnTime = returnTime;
+ this.returnTimeMillis = returnTimeMillis;
this.message = message;
this.comments = comments;
if (doComputeDetails) {
@@ -140,15 +139,15 @@ public class TimeInfo {
}
final TimeStamp origNtpTime = message.getOriginateTimeStamp();
- final long origTime = origNtpTime.getTime();
+ final long origTimeMillis = origNtpTime.getTime();
// Receive Time is time request received by server (t2)
final TimeStamp rcvNtpTime = message.getReceiveTimeStamp();
- final long rcvTime = rcvNtpTime.getTime();
+ final long rcvTimeMillis = rcvNtpTime.getTime();
// Transmit time is time reply sent by server (t3)
final TimeStamp xmitNtpTime = message.getTransmitTimeStamp();
- final long xmitTime = xmitNtpTime.getTime();
+ final long xmitTimeMillis = xmitNtpTime.getTime();
/*
* Round-trip network delay and local clock offset (or time drift) is
calculated
@@ -172,7 +171,7 @@ public class TimeInfo {
// might be via a broadcast NTP packet...
if (xmitNtpTime.ntpValue() != 0)
{
- offset = Long.valueOf(xmitTime - returnTime);
+ offsetMillis = Long.valueOf(xmitTimeMillis - returnTimeMillis);
comments.add("Error: zero orig time -- cannot compute delay");
} else {
comments.add("Error: zero orig time -- cannot compute
delay/offset");
@@ -180,12 +179,12 @@ public class TimeInfo {
} else if (rcvNtpTime.ntpValue() == 0 || xmitNtpTime.ntpValue() == 0) {
comments.add("Warning: zero rcvNtpTime or xmitNtpTime");
// assert destTime >= origTime since network delay cannot be
negative
- if (origTime > returnTime) {
+ if (origTimeMillis > returnTimeMillis) {
comments.add("Error: OrigTime > DestRcvTime");
} else {
// without receive or xmit time cannot figure out processing
time
// so delay is simply the network travel time
- delay = Long.valueOf(returnTime - origTime);
+ delayMillis = Long.valueOf(returnTimeMillis - origTimeMillis);
}
// TODO: is offset still valid if rcvNtpTime=0 || xmitNtpTime=0 ???
// Could always hash origNtpTime (sendTime) but if host doesn't
set it
@@ -194,52 +193,52 @@ public class TimeInfo {
if (rcvNtpTime.ntpValue() != 0)
{
// xmitTime is 0 just use rcv time
- offset = Long.valueOf(rcvTime - origTime);
+ offsetMillis = Long.valueOf(rcvTimeMillis - origTimeMillis);
} else if (xmitNtpTime.ntpValue() != 0)
{
// rcvTime is 0 just use xmitTime time
- offset = Long.valueOf(xmitTime - returnTime);
+ offsetMillis = Long.valueOf(xmitTimeMillis - returnTimeMillis);
}
} else
{
- long delayValue = returnTime - origTime;
+ long delayValueMillis = returnTimeMillis - origTimeMillis;
// assert xmitTime >= rcvTime: difference typically < 1ms
- if (xmitTime < rcvTime)
+ if (xmitTimeMillis < rcvTimeMillis)
{
// server cannot send out a packet before receiving it...
comments.add("Error: xmitTime < rcvTime"); // time-travel not
allowed
} else
{
// subtract processing time from round-trip network delay
- final long delta = xmitTime - rcvTime;
+ final long deltaMillis = xmitTimeMillis - rcvTimeMillis;
// in normal cases the processing delta is less than
// the total roundtrip network travel time.
- if (delta <= delayValue)
+ if (deltaMillis <= delayValueMillis)
{
- delayValue -= delta; // delay = (t4 - t1) - (t3 - t2)
+ delayValueMillis -= deltaMillis; // delay = (t4 - t1) -
(t3 - t2)
} else
{
// if delta - delayValue == 1 ms then it's a round-off
error
// e.g. delay=3ms, processing=4ms
- if (delta - delayValue == 1)
+ if (deltaMillis - delayValueMillis == 1)
{
// delayValue == 0 -> local clock saw no tick change
but destination clock did
- if (delayValue != 0)
+ if (delayValueMillis != 0)
{
comments.add("Info: processing time > total
network time by 1 ms -> assume zero delay");
- delayValue = 0;
+ delayValueMillis = 0;
}
} else {
comments.add("Warning: processing time > total network
time");
}
}
}
- delay = Long.valueOf(delayValue);
- if (origTime > returnTime) {
+ delayMillis = Long.valueOf(delayValueMillis);
+ if (origTimeMillis > returnTimeMillis) {
comments.add("Error: OrigTime > DestRcvTime");
}
- offset = Long.valueOf(((rcvTime - origTime) + (xmitTime -
returnTime)) / 2);
+ offsetMillis = Long.valueOf(((rcvTimeMillis - origTimeMillis) +
(xmitTimeMillis - returnTimeMillis)) / 2);
}
}
@@ -260,7 +259,7 @@ public class TimeInfo {
*/
public Long getDelay()
{
- return delay;
+ return delayMillis;
}
/**
@@ -271,7 +270,7 @@ public class TimeInfo {
*/
public Long getOffset()
{
- return offset;
+ return offsetMillis;
}
/**
@@ -301,7 +300,7 @@ public class TimeInfo {
*/
public long getReturnTime()
{
- return returnTime;
+ return returnTimeMillis;
}
/**
@@ -325,7 +324,7 @@ public class TimeInfo {
return false;
}
final TimeInfo other = (TimeInfo) obj;
- return returnTime == other.returnTime && message.equals(other.message);
+ return returnTimeMillis == other.returnTimeMillis &&
message.equals(other.message);
}
/**
@@ -339,7 +338,7 @@ public class TimeInfo {
public int hashCode()
{
final int prime = 31;
- int result = (int)returnTime;
+ int result = (int)returnTimeMillis;
result = prime * result + message.hashCode();
return result;
}
diff --git a/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
b/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
index 3472b16..4b25144 100644
--- a/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
+++ b/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
@@ -45,12 +45,12 @@ public class TimeStamp implements java.io.Serializable,
Comparable<TimeStamp>
private static final long serialVersionUID = 8139806907588338737L;
/**
- * baseline NTP time if bit-0=0 is 7-Feb-2036 @ 06:28:16 UTC
+ * Baseline NTP time if bit-0=0 is 7-Feb-2036 @ 06:28:16 UTC
*/
protected static final long msb0baseTime = 2085978496000L;
/**
- * baseline NTP time if bit-0=1 is 1-Jan-1900 @ 01:00:00 UTC
+ * Baseline NTP time if bit-0=1 is 1-Jan-1900 @ 01:00:00 UTC
*/
protected static final long msb1baseTime = -2208988800000L;
@@ -115,7 +115,7 @@ public class TimeStamp implements java.io.Serializable,
Comparable<TimeStamp>
*/
public TimeStamp(final Date d)
{
- ntpTime = (d == null) ? 0 : toNtpTime(d.getTime());
+ ntpTime = d == null ? 0 : toNtpTime(d.getTime());
}
/**
@@ -149,9 +149,10 @@ public class TimeStamp implements java.io.Serializable,
Comparable<TimeStamp>
}
/**
- * Convert NTP timestamp to Java standard time.
+ * Converts NTP timestamp to Java standard time.
*
- * @return NTP Timestamp in Java time
+ * @return the number of milliseconds since January 1, 1970, 00:00:00 GMT
+ * represented by this NTP timestamp value.
*/
public long getTime()
{
@@ -159,18 +160,17 @@ public class TimeStamp implements java.io.Serializable,
Comparable<TimeStamp>
}
/**
- * Convert NTP timestamp to Java Date object.
+ * Converts NTP timestamp to Java Date object.
*
* @return NTP Timestamp in Java Date
*/
public Date getDate()
{
- final long time = getTime(ntpTime);
- return new Date(time);
+ return new Date(getTime(ntpTime));
}
/**
- * Convert 64-bit NTP timestamp to Java standard time.
+ * Converts 64-bit NTP timestamp to Java standard time.
*
* Note that java time (milliseconds) by definition has less precision
* then NTP time (picoseconds) so converting NTP timestamp to java time
and back
@@ -215,12 +215,12 @@ public class TimeStamp implements java.io.Serializable,
Comparable<TimeStamp>
* to Ntptime loses precision. For example, Tue, Dec 17 2002 09:07:24.810
* is represented by a single Java-based time value of f22cd1fc8a, but its
* NTP equivalent are all values from c1a9ae1c.cf5c28f5 to
c1a9ae1c.cf9db22c.
- * @param date the milliseconds since January 1, 1970, 00:00:00 GMT.
+ * @param dateMillis the milliseconds since January 1, 1970, 00:00:00
GMT.
* @return NTP timestamp object at the specified date.
*/
- public static TimeStamp getNtpTime(final long date)
+ public static TimeStamp getNtpTime(final long dateMillis)
{
- return new TimeStamp(toNtpTime(date));
+ return new TimeStamp(toNtpTime(dateMillis));
}
/**
@@ -278,29 +278,28 @@ public class TimeStamp implements java.io.Serializable,
Comparable<TimeStamp>
/**
* Converts Java time to 64-bit NTP time representation.
*
- * @param t Java time
+ * @param millis Java time
* @return NTP timestamp representation of Java time value.
*/
- protected static long toNtpTime(final long t)
+ protected static long toNtpTime(final long millis)
{
- final boolean useBase1 = t < msb0baseTime; // time < Feb-2036
- final long baseTime;
+ final boolean useBase1 = millis < msb0baseTime; // time < Feb-2036
+ final long baseTimeMillis;
if (useBase1) {
- baseTime = t - msb1baseTime; // dates <= Feb-2036
+ baseTimeMillis = millis - msb1baseTime; // dates <= Feb-2036
} else {
// if base0 needed for dates >= Feb-2036
- baseTime = t - msb0baseTime;
+ baseTimeMillis = millis - msb0baseTime;
}
- long seconds = baseTime / 1000;
- final long fraction = ((baseTime % 1000) * 0x100000000L) / 1000;
+ long seconds = baseTimeMillis / 1000;
+ final long fraction = ((baseTimeMillis % 1000) * 0x100000000L) / 1000;
if (useBase1) {
seconds |= 0x80000000L; // set high-order bit if msb1baseTime 1900
used
}
- final long time = seconds << 32 | fraction;
- return time;
+ return seconds << 32 | fraction;
}
/**
diff --git a/src/test/java/org/apache/commons/net/ntp/TestNtpClient.java
b/src/test/java/org/apache/commons/net/ntp/TestNtpClient.java
index 1fffed3..4d5e388 100644
--- a/src/test/java/org/apache/commons/net/ntp/TestNtpClient.java
+++ b/src/test/java/org/apache/commons/net/ntp/TestNtpClient.java
@@ -74,7 +74,7 @@ public class TestNtpClient {
@Test
public void testGetTime() throws IOException {
- final long currentTime = System.currentTimeMillis();
+ final long currentTimeMillis = System.currentTimeMillis();
final NTPUDPClient client = new NTPUDPClient();
// timeout if response takes longer than 2 seconds
client.setDefaultTimeout(2000);
@@ -83,7 +83,7 @@ public class TestNtpClient {
final InetAddress addr = InetAddress.getByAddress("loopback", new
byte[]{127, 0, 0, 1});
final TimeInfo timeInfo = client.getTime(addr, server.getPort());
Assert.assertNotNull(timeInfo);
- Assert.assertTrue(timeInfo.getReturnTime() >= currentTime);
+ Assert.assertTrue(timeInfo.getReturnTime() >= currentTimeMillis);
final NtpV3Packet message = timeInfo.getMessage();
Assert.assertNotNull(message);
@@ -93,7 +93,7 @@ public class TestNtpClient {
final TimeStamp originateTimeStamp =
message.getOriginateTimeStamp();
Assert.assertNotNull(originateTimeStamp);
- Assert.assertTrue(originateTimeStamp.getTime() >= currentTime);
+ Assert.assertTrue(originateTimeStamp.getTime() >=
currentTimeMillis);
Assert.assertEquals(NtpV3Packet.MODE_SERVER, message.getMode());
@@ -101,7 +101,7 @@ public class TestNtpClient {
final TimeStamp referenceTimeStamp =
message.getReferenceTimeStamp();
Assert.assertNotNull(referenceTimeStamp);
- Assert.assertTrue(referenceTimeStamp.getTime() >= currentTime);
+ Assert.assertTrue(referenceTimeStamp.getTime() >=
currentTimeMillis);
Assert.assertEquals(NtpV3Packet.VERSION_3, message.getVersion());
Assert.assertEquals(1, message.getStratum());
diff --git a/src/test/java/org/apache/commons/net/ntp/TestTimeInfo.java
b/src/test/java/org/apache/commons/net/ntp/TestTimeInfo.java
index 29ae104..fc780d5 100644
--- a/src/test/java/org/apache/commons/net/ntp/TestTimeInfo.java
+++ b/src/test/java/org/apache/commons/net/ntp/TestTimeInfo.java
@@ -47,14 +47,14 @@ public class TestTimeInfo {
public void testComputeDetails() {
// if (origTime > returnTime) // assert destTime >= origTime
final NtpV3Packet packet = new NtpV3Impl();
- final long returnTime = System.currentTimeMillis();
+ final long returnTimeMillis = System.currentTimeMillis();
// example
// returntime=1370571658178
// origTime= 1370571659178
// originate time as defined in RFC-1305 (t1)
- packet.setOriginateTimeStamp(TimeStamp.getNtpTime(returnTime + 1000));
+ packet.setOriginateTimeStamp(TimeStamp.getNtpTime(returnTimeMillis +
1000));
// Receive Time is time request received by server (t2)
packet.setReceiveTimeStamp(packet.getOriginateTimeStamp());
// Transmit time is time reply sent by server (t3)
@@ -65,11 +65,11 @@ public class TestTimeInfo {
//System.out.println("returntime=" + returnTime);
//System.out.println("origTime= " + origTime);
- final TimeInfo info = new TimeInfo(packet, returnTime);
+ final TimeInfo info = new TimeInfo(packet, returnTimeMillis);
info.computeDetails();
Assert.assertSame(packet, info.getMessage());
- Assert.assertEquals(returnTime, info.getReturnTime());
+ Assert.assertEquals(returnTimeMillis, info.getReturnTime());
Assert.assertEquals(Long.valueOf(500), info.getOffset());
Assert.assertEquals(Long.valueOf(-1000), info.getDelay());
