org.apache.commons.net.ntp

Interface NtpV3Packet

public interface NtpV3Packet

Interface for a NtpV3Packet with get/set methods corresponding to the fields in the NTP Data Message Header described in RFC 1305.

Field Summary

static int
LI_ALARM_CONDITION
static int
LI_LAST_MINUTE_HAS_59_SECONDS
static int
LI_LAST_MINUTE_HAS_61_SECONDS
static int
LI_NO_WARNING
static int
MODE_BROADCAST
static int
MODE_CLIENT
static int
MODE_CONTROL_MESSAGE
static int
MODE_PRIVATE
static int
MODE_RESERVED
static int
MODE_SERVER
static int
MODE_SYMMETRIC_ACTIVE
static int
MODE_SYMMETRIC_PASSIVE
static int
NTP_MAXCLOCK
static int
NTP_MAXPOLL
static int
NTP_MINCLOCK
static int
NTP_MINPOLL
static int
NTP_PORT
Standard NTP UDP port
static String
TYPE_DAYTIME
static String
TYPE_ICMP
static String
TYPE_NTP
static String
TYPE_TIME
static int
VERSION_3
static int
VERSION_4

Method Summary

DatagramPacket
getDatagramPacket()
int
getLeapIndicator()
int
getMode()
String
getModeName()
TimeStamp
getOriginateTimeStamp()
int
getPoll()
int
getPrecision()
TimeStamp
getReceiveTimeStamp()
int
getReferenceId()
String
getReferenceIdString()
TimeStamp
getReferenceTimeStamp()
int
getRootDelay()
double
getRootDelayInMillisDouble()
int
getRootDispersion()
long
getRootDispersionInMillis()
double
getRootDispersionInMillisDouble()
int
getStratum()
TimeStamp
getTransmitTimeStamp()
String
getType()
Return type of time packet.
int
getVersion()
void
setDatagramPacket(DatagramPacket dp)
Set the contents of this object from the datagram packet
void
setLeapIndicator(int li)
Set leap indicator.
void
setMode(int mode)
Set mode as defined in RFC-1305
void
setOriginateTimeStamp(TimeStamp ts)
Set originate timestamp given NTP TimeStamp object.
void
setPoll(int poll)
Set poll interval as defined in RFC-1305.
void
setReceiveTimeStamp(TimeStamp ts)
Set receive timestamp given NTP TimeStamp object.
void
setReferenceId(int refId)
Set reference clock identifier field.
void
setReferenceTime(TimeStamp ts)
Set the reference timestamp given NTP TimeStamp object.
void
setStratum(int stratum)
Set stratum as defined in RFC-1305
void
setTransmitTime(TimeStamp ts)
Set the transmit timestamp given NTP TimeStamp object.
void
setVersion(int mode)
Set version as defined in RFC-1305

Field Details

LI_ALARM_CONDITION

public static final int LI_ALARM_CONDITION
Field Value:
3

LI_LAST_MINUTE_HAS_59_SECONDS

public static final int LI_LAST_MINUTE_HAS_59_SECONDS
Field Value:
2

LI_LAST_MINUTE_HAS_61_SECONDS

public static final int LI_LAST_MINUTE_HAS_61_SECONDS
Field Value:
1

LI_NO_WARNING

public static final int LI_NO_WARNING
Field Value:
0

MODE_BROADCAST

public static final int MODE_BROADCAST
Field Value:
5

MODE_CLIENT

public static final int MODE_CLIENT
Field Value:
3

MODE_CONTROL_MESSAGE

public static final int MODE_CONTROL_MESSAGE
Field Value:
6

MODE_PRIVATE

public static final int MODE_PRIVATE
Field Value:
7

MODE_RESERVED

public static final int MODE_RESERVED
Field Value:
0

MODE_SERVER

public static final int MODE_SERVER
Field Value:
4

MODE_SYMMETRIC_ACTIVE

public static final int MODE_SYMMETRIC_ACTIVE
Field Value:
1

MODE_SYMMETRIC_PASSIVE

public static final int MODE_SYMMETRIC_PASSIVE
Field Value:
2

NTP_MAXCLOCK

public static final int NTP_MAXCLOCK
Field Value:
10

NTP_MAXPOLL

public static final int NTP_MAXPOLL
Field Value:
14

NTP_MINCLOCK

public static final int NTP_MINCLOCK
Field Value:
1

NTP_MINPOLL

public static final int NTP_MINPOLL
Field Value:
4

NTP_PORT

public static final int NTP_PORT
Standard NTP UDP port
Field Value:
123

TYPE_DAYTIME

public static final String TYPE_DAYTIME

TYPE_ICMP

public static final String TYPE_ICMP

TYPE_NTP

public static final String TYPE_NTP

TYPE_TIME

public static final String TYPE_TIME

VERSION_3

public static final int VERSION_3
Field Value:
3

VERSION_4

public static final int VERSION_4
Field Value:
4

Method Details

getDatagramPacket

public DatagramPacket getDatagramPacket()
Returns:
a datagram packet with the NTP parts already filled in

getLeapIndicator

public int getLeapIndicator()
Returns:
leap indicator as defined in RFC-1305

getMode

public int getMode()
Returns:
mode as defined in RFC-1305

getModeName

public String getModeName()
Returns:
mode as human readable string; e.g. 3=Client

getOriginateTimeStamp

public TimeStamp getOriginateTimeStamp()
Returns:
the originate time as defined in RFC-1305

getPoll

public int getPoll()
Returns:
poll interval as defined in RFC-1305. Field range between NTP_MINPOLL and NTP_MAXPOLL.

getPrecision

public int getPrecision()
Returns:
precision as defined in RFC-1305

getReceiveTimeStamp

public TimeStamp getReceiveTimeStamp()
Returns:
the receive time as defined in RFC-1305

getReferenceId

public int getReferenceId()
Returns:
the reference id (32-bit code) as defined in RFC-1305

getReferenceIdString

public String getReferenceIdString()
Returns:
the reference id string

getReferenceTimeStamp

public TimeStamp getReferenceTimeStamp()
Returns:
the reference time as defined in RFC-1305

getRootDelay

public int getRootDelay()
Returns:
root delay as defined in RFC-1305

getRootDelayInMillisDouble

public double getRootDelayInMillisDouble()
Returns:
root delay in milliseconds

getRootDispersion

public int getRootDispersion()
Returns:
root dispersion as defined in RFC-1305

getRootDispersionInMillis

public long getRootDispersionInMillis()
Returns:
root dispersion in milliseconds

getRootDispersionInMillisDouble

public double getRootDispersionInMillisDouble()
Returns:
root dispersion in milliseconds

getStratum

public int getStratum()
Returns:
stratum as defined in RFC-1305

getTransmitTimeStamp

public TimeStamp getTransmitTimeStamp()
Returns:
the transmit timestamp as defined in RFC-1305

getType

public String getType()
Return type of time packet. The values (e.g. NTP, TIME, ICMP, ...) correspond to the protocol used to obtain the timing information.
Returns:
packet type string identifier

getVersion

public int getVersion()
Returns:
version as defined in RFC-1305

setDatagramPacket

public void setDatagramPacket(DatagramPacket dp)
Set the contents of this object from the datagram packet

setLeapIndicator

public void setLeapIndicator(int li)
Set leap indicator.
Parameters:
li - - leap indicator code

setMode

public void setMode(int mode)
Set mode as defined in RFC-1305

setOriginateTimeStamp

public void setOriginateTimeStamp(TimeStamp ts)
Set originate timestamp given NTP TimeStamp object.
Parameters:
ts - - timestamp

setPoll

public void setPoll(int poll)
Set poll interval as defined in RFC-1305. Field range between NTP_MINPOLL and NTP_MAXPOLL.

setReceiveTimeStamp

public void setReceiveTimeStamp(TimeStamp ts)
Set receive timestamp given NTP TimeStamp object.
Parameters:
ts - - timestamp

setReferenceId

public void setReferenceId(int refId)
Set reference clock identifier field.
Parameters:
refId -

setReferenceTime

public void setReferenceTime(TimeStamp ts)
Set the reference timestamp given NTP TimeStamp object.
Parameters:
ts - - timestamp

setStratum

public void setStratum(int stratum)
Set stratum as defined in RFC-1305

setTransmitTime

public void setTransmitTime(TimeStamp ts)
Set the transmit timestamp given NTP TimeStamp object.
Parameters:
ts - - timestamp

setVersion

public void setVersion(int mode)
Set version as defined in RFC-1305