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
FieldsModifier and TypeFieldDescriptionstatic final int3static final int2static final int1static final int0static final intMode option 5.static final intMode option 3.static final intMode option 6.static final intMode option 7.static final intMode option 0.static final intMode option 4.static final intMode option 1.static final intMode option 2.static final int10static final int14static final int1static final int4static final intStandard NTP UDP portstatic final String"DAYTIME"static final String"ICMP"static final String"NTP"static final String"TIME"static final int3static final int4 -
Method Summary
Modifier and TypeMethodDescriptionintintgetMode()intgetPoll()intintintdoubleintlongdoubleintgetType()Return type of time packet.intvoidSets the contents of this object from the datagram packetvoidsetLeapIndicator(int li) Sets leap indicator.voidsetMode(int mode) Sets mode as defined in RFC-1305voidSets originate timestamp given NTP TimeStamp object.voidsetPoll(int poll) Sets poll interval as defined in RFC-1305.voidsetPrecision(int precision) Sets precision as defined in RFC-1305voidSets receive timestamp given NTP TimeStamp object.voidsetReferenceId(int refId) Sets reference clock identifier field.voidSets the reference timestamp given NTP TimeStamp object.voidsetRootDelay(int delay) Sets root delay as defined in RFC-1305voidsetRootDispersion(int dispersion) voidsetStratum(int stratum) Sets stratum as defined in RFC-1305voidSets thetransmittimestamp given NTP TimeStamp object.voidsetVersion(int version) Sets version as defined in RFC-1305
-
Field Details
-
NTP_PORT
Standard NTP UDP port- See Also:
-
LI_NO_WARNING
0- See Also:
-
LI_LAST_MINUTE_HAS_61_SECONDS
1- See Also:
-
LI_LAST_MINUTE_HAS_59_SECONDS
2- See Also:
-
LI_ALARM_CONDITION
3- 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
4- See Also:
-
NTP_MAXPOLL
14- See Also:
-
NTP_MINCLOCK
1- See Also:
-
NTP_MAXCLOCK
10- See Also:
-
VERSION_3
3- See Also:
-
VERSION_4
4- See Also:
-
TYPE_NTP
"NTP"- See Also:
-
TYPE_ICMP
"ICMP"- See Also:
-
TYPE_TIME
"TIME"- See Also:
-
TYPE_DAYTIME
"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
originatetime 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
receivetime 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
transmittimestamp 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
Sets the contents of this object from the datagram packet- Parameters:
dp- the packet
-
setLeapIndicator
Sets leap indicator.- Parameters:
li- - leap indicator code
-
setMode
Sets mode as defined in RFC-1305- Parameters:
mode- the mode to set
-
setOriginateTimeStamp
Sets originate timestamp given NTP TimeStamp object.- Parameters:
ts- - timestamp
-
setPoll
Sets poll interval as defined in RFC-1305. Field range between NTP_MINPOLL and NTP_MAXPOLL.- Parameters:
poll- the interval to set
-
setPrecision
Sets precision as defined in RFC-1305- Parameters:
precision- Precision- Since:
- 3.4
-
setReceiveTimeStamp
Sets receive timestamp given NTP TimeStamp object.- Parameters:
ts- - timestamp
-
setReferenceId
Sets reference clock identifier field.- Parameters:
refId- the clock id field to set
-
setReferenceTime
Sets the reference timestamp given NTP TimeStamp object.- Parameters:
ts- - timestamp
-
setRootDelay
Sets 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
Sets stratum as defined in RFC-1305- Parameters:
stratum- the stratum to set
-
setTransmitTime
Sets thetransmittimestamp given NTP TimeStamp object.- Parameters:
ts- - timestamp
-
setVersion
Sets version as defined in RFC-1305- Parameters:
version- the version to set
-