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 int
3static final int
2static final int
1static final int
0static 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
10static final int
14static final int
1static final int
4static final int
Standard NTP UDP portstatic final String
"DAYTIME"static final String
"ICMP"static final String
"NTP"static final String
"TIME"static final int
3static final int
4 -
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
Sets the contents of this object from the datagram packetvoid
setLeapIndicator
(int li) Sets leap indicator.void
setMode
(int mode) Sets mode as defined in RFC-1305void
Sets originate timestamp given NTP TimeStamp object.void
setPoll
(int poll) Sets poll interval as defined in RFC-1305.void
setPrecision
(int precision) Sets precision as defined in RFC-1305void
Sets receive timestamp given NTP TimeStamp object.void
setReferenceId
(int refId) Sets reference clock identifier field.void
Sets the reference timestamp given NTP TimeStamp object.void
setRootDelay
(int delay) Sets root delay as defined in RFC-1305void
setRootDispersion
(int dispersion) void
setStratum
(int stratum) Sets stratum as defined in RFC-1305void
Sets thetransmit
timestamp given NTP TimeStamp object.void
setVersion
(int version) Sets version as defined in RFC-1305
-
Field Details
-
NTP_PORT
static final int NTP_PORTStandard NTP UDP port- See Also:
-
LI_NO_WARNING
static final int LI_NO_WARNING0- See Also:
-
LI_LAST_MINUTE_HAS_61_SECONDS
static final int LI_LAST_MINUTE_HAS_61_SECONDS1- See Also:
-
LI_LAST_MINUTE_HAS_59_SECONDS
static final int LI_LAST_MINUTE_HAS_59_SECONDS2- See Also:
-
LI_ALARM_CONDITION
static final int LI_ALARM_CONDITION3- See Also:
-
MODE_RESERVED
static final int MODE_RESERVEDMode option 0.- See Also:
-
MODE_SYMMETRIC_ACTIVE
static final int MODE_SYMMETRIC_ACTIVEMode option 1.- See Also:
-
MODE_SYMMETRIC_PASSIVE
static final int MODE_SYMMETRIC_PASSIVEMode option 2.- See Also:
-
MODE_CLIENT
static final int MODE_CLIENTMode option 3.- See Also:
-
MODE_SERVER
static final int MODE_SERVERMode option 4.- See Also:
-
MODE_BROADCAST
static final int MODE_BROADCASTMode option 5.- See Also:
-
MODE_CONTROL_MESSAGE
static final int MODE_CONTROL_MESSAGEMode option 6.- See Also:
-
MODE_PRIVATE
static final int MODE_PRIVATEMode option 7.- See Also:
-
NTP_MINPOLL
static final int NTP_MINPOLL4- See Also:
-
NTP_MAXPOLL
static final int NTP_MAXPOLL14- See Also:
-
NTP_MINCLOCK
static final int NTP_MINCLOCK1- See Also:
-
NTP_MAXCLOCK
static final int NTP_MAXCLOCK10- See Also:
-
VERSION_3
static final int VERSION_33- See Also:
-
VERSION_4
static final int VERSION_44- 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
DatagramPacket 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
String getModeName()- Returns:
- mode as human readable string; e.g. 3=Client
-
getOriginateTimeStamp
TimeStamp 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
TimeStamp 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
String getReferenceIdString()- Returns:
- the reference id string
-
getReferenceTimeStamp
TimeStamp 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
TimeStamp getTransmitTimeStamp()- Returns:
- the
transmit
timestamp as defined in RFC-1305
-
getType
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
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
void setLeapIndicator(int li) Sets leap indicator.- Parameters:
li
- - leap indicator code
-
setMode
void setMode(int mode) 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
void setPoll(int poll) Sets poll interval as defined in RFC-1305. Field range between NTP_MINPOLL and NTP_MAXPOLL.- Parameters:
poll
- the interval to set
-
setPrecision
void setPrecision(int precision) 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
void setReferenceId(int refId) 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
void setRootDelay(int delay) Sets root delay as defined in RFC-1305- Parameters:
delay
- the delay to set- Since:
- 3.4
-
setRootDispersion
void setRootDispersion(int dispersion) - Parameters:
dispersion
- the value to set- Since:
- 3.4
-
setStratum
void setStratum(int stratum) Sets stratum as defined in RFC-1305- Parameters:
stratum
- the stratum to set
-
setTransmitTime
Sets thetransmit
timestamp given NTP TimeStamp object.- Parameters:
ts
- - timestamp
-
setVersion
void setVersion(int version) Sets version as defined in RFC-1305- Parameters:
version
- the version to set
-