Package org.apache.commons.net.ntp
Interface NtpV3Packet
- All Known Implementing Classes:
NtpV3Impl
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
Modifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
Mode option 5.static final int
Mode option 3.static final int
Mode option 6.static final int
Mode option 7.static final int
Mode option 0.static final int
Mode option 4.static final int
Mode option 1.static final int
Mode option 2.static final int
static final int
static final int
static final int
static final int
Standard NTP UDP portstatic final String
static final String
static final String
static final String
static final int
static final int
-
Method Summary
Modifier and TypeMethodDescriptionint
int
getMode()
int
getPoll()
int
int
int
double
int
long
double
int
getType()
Return type of time packet.int
void
Set the contents of this object from the datagram packetvoid
setLeapIndicator
(int li) Set leap indicator.void
setMode
(int mode) Set mode as defined in RFC-1305void
Set originate timestamp given NTP TimeStamp object.void
setPoll
(int poll) Set poll interval as defined in RFC-1305.void
setPrecision
(int precision) Set precision as defined in RFC-1305void
Set receive timestamp given NTP TimeStamp object.void
setReferenceId
(int refId) Set reference clock identifier field.void
Set the reference timestamp given NTP TimeStamp object.void
setRootDelay
(int delay) Set root delay as defined in RFC-1305void
setRootDispersion
(int dispersion) void
setStratum
(int stratum) Set stratum as defined in RFC-1305void
Set thetransmit
timestamp given NTP TimeStamp object.void
setVersion
(int version) Set version as defined in RFC-1305
-
Field Details
-
NTP_PORT
Standard NTP UDP port- See Also:
-
LI_NO_WARNING
- See Also:
-
LI_LAST_MINUTE_HAS_61_SECONDS
- See Also:
-
LI_LAST_MINUTE_HAS_59_SECONDS
- See Also:
-
LI_ALARM_CONDITION
- See Also:
-
MODE_RESERVED
Mode option 0.- See Also:
-
MODE_SYMMETRIC_ACTIVE
Mode option 1.- See Also:
-
MODE_SYMMETRIC_PASSIVE
Mode option 2.- See Also:
-
MODE_CLIENT
Mode option 3.- See Also:
-
MODE_SERVER
Mode option 4.- See Also:
-
MODE_BROADCAST
Mode option 5.- See Also:
-
MODE_CONTROL_MESSAGE
Mode option 6.- See Also:
-
MODE_PRIVATE
Mode option 7.- See Also:
-
NTP_MINPOLL
- See Also:
-
NTP_MAXPOLL
- See Also:
-
NTP_MINCLOCK
- See Also:
-
NTP_MAXCLOCK
- See Also:
-
VERSION_3
- See Also:
-
VERSION_4
- See Also:
-
TYPE_NTP
- See Also:
-
TYPE_ICMP
- See Also:
-
TYPE_TIME
- See Also:
-
TYPE_DAYTIME
- See Also:
-
-
Method Details
-
getDatagramPacket
- Returns:
- a datagram packet with the NTP parts already filled in
-
getLeapIndicator
int getLeapIndicator()- Returns:
- leap indicator as defined in RFC-1305
-
getMode
int getMode()- Returns:
- mode as defined in RFC-1305
-
getModeName
- Returns:
- mode as human readable string; e.g. 3=Client
-
getOriginateTimeStamp
- Returns:
- the
originate
time as defined in RFC-1305
-
getPoll
int getPoll()- Returns:
- poll interval as defined in RFC-1305. Field range between NTP_MINPOLL and NTP_MAXPOLL.
-
getPrecision
int getPrecision()- Returns:
- precision as defined in RFC-1305
-
getReceiveTimeStamp
- Returns:
- the
receive
time as defined in RFC-1305
-
getReferenceId
int getReferenceId()- Returns:
- the reference id (32-bit code) as defined in RFC-1305
-
getReferenceIdString
- Returns:
- the reference id string
-
getReferenceTimeStamp
- Returns:
- the reference time as defined in RFC-1305
-
getRootDelay
int getRootDelay()- Returns:
- root delay as defined in RFC-1305
-
getRootDelayInMillisDouble
double getRootDelayInMillisDouble()- Returns:
- root delay in milliseconds
-
getRootDispersion
int getRootDispersion()- Returns:
- root dispersion as defined in RFC-1305
-
getRootDispersionInMillis
long getRootDispersionInMillis()- Returns:
- root dispersion in milliseconds
-
getRootDispersionInMillisDouble
double getRootDispersionInMillisDouble()- Returns:
- root dispersion in milliseconds
-
getStratum
int getStratum()- Returns:
- stratum as defined in RFC-1305
-
getTransmitTimeStamp
- Returns:
- the
transmit
timestamp as defined in RFC-1305
-
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
int getVersion()- Returns:
- version as defined in RFC-1305
-
setDatagramPacket
Set the contents of this object from the datagram packet- Parameters:
dp
- the packet
-
setLeapIndicator
Set leap indicator.- Parameters:
li
- - leap indicator code
-
setMode
Set mode as defined in RFC-1305- Parameters:
mode
- the mode to set
-
setOriginateTimeStamp
Set originate timestamp given NTP TimeStamp object.- Parameters:
ts
- - timestamp
-
setPoll
Set poll interval as defined in RFC-1305. Field range between NTP_MINPOLL and NTP_MAXPOLL.- Parameters:
poll
- the interval to set
-
setPrecision
Set precision as defined in RFC-1305- Parameters:
precision
- Precision- Since:
- 3.4
-
setReceiveTimeStamp
Set receive timestamp given NTP TimeStamp object.- Parameters:
ts
- - timestamp
-
setReferenceId
Set reference clock identifier field.- Parameters:
refId
- the clock id field to set
-
setReferenceTime
Set the reference timestamp given NTP TimeStamp object.- Parameters:
ts
- - timestamp
-
setRootDelay
Set root delay as defined in RFC-1305- Parameters:
delay
- the delay to set- Since:
- 3.4
-
setRootDispersion
- Parameters:
dispersion
- the value to set- Since:
- 3.4
-
setStratum
Set stratum as defined in RFC-1305- Parameters:
stratum
- the stratum to set
-
setTransmitTime
Set thetransmit
timestamp given NTP TimeStamp object.- Parameters:
ts
- - timestamp
-
setVersion
Set version as defined in RFC-1305- Parameters:
version
- the version to set
-