Package org.apache.commons.net.ntp
Class TimeInfo
java.lang.Object
org.apache.commons.net.ntp.TimeInfo
Wrapper class to network time packet messages (NTP, etc.) that computes related timing info and stats.
- 
Constructor SummaryConstructorsConstructorDescriptionTimeInfo(NtpV3Packet message, long returnTimeMillis) Create TimeInfo object with raw packet message and destination time received.TimeInfo(NtpV3Packet msgPacket, long returnTimeMillis, boolean doComputeDetails) Create TimeInfo object with raw packet message and destination time received.TimeInfo(NtpV3Packet message, long returnTimeMillis, List<String> comments) Create TimeInfo object with raw packet message and destination time received.TimeInfo(NtpV3Packet message, long returnTimeMillis, List<String> comments, boolean doComputeDetails) Create TimeInfo object with raw packet message and destination time received.
- 
Method SummaryModifier and TypeMethodDescriptionvoidaddComment(String comment) Add comment (error/warning) to list of comments associated with processing of NTP parameters.voidCompute and validate details of the NTP message packet.booleanCompares this object against the specified object.Gets host address from message datagram if availableReturn list of comments (if any) during processing of NTP packet.getDelay()Gets round-trip network delay.Returns NTP message packet.Gets clock offset needed to adjust local clock to match remote clock.longReturns time at which time message packet was received by local machine.inthashCode()Computes a hash code for this object.
- 
Constructor Details- 
TimeInfoCreate TimeInfo object with raw packet message and destination time received.- Parameters:
- message- NTP message packet
- returnTimeMillis- destination receive time
- Throws:
- IllegalArgumentException- if message is null
 
- 
TimeInfoCreate TimeInfo object with raw packet message and destination time received. Auto-computes details if computeDetails flag set otherwise this is delayed until computeDetails() is called. Delayed computation is for fast initialization when sub-millisecond timing is needed.- Parameters:
- msgPacket- NTP message packet
- returnTimeMillis- destination receive time
- doComputeDetails- flag to pre-compute delay/offset values
- Throws:
- IllegalArgumentException- if message is null
 
- 
TimeInfoCreate TimeInfo object with raw packet message and destination time received.- Parameters:
- message- NTP message packet
- returnTimeMillis- destination receive time
- comments- List of errors/warnings identified during processing
- Throws:
- IllegalArgumentException- if message is null
 
- 
TimeInfopublic TimeInfo(NtpV3Packet message, long returnTimeMillis, List<String> comments, boolean doComputeDetails) Create TimeInfo object with raw packet message and destination time received. Auto-computes details if computeDetails flag set otherwise this is delayed until computeDetails() is called. Delayed computation is for fast initialization when sub-millisecond timing is needed.- Parameters:
- message- NTP message packet
- returnTimeMillis- destination receive time
- comments- list of comments used to store errors/warnings with message
- doComputeDetails- flag to pre-compute delay/offset values
- Throws:
- IllegalArgumentException- if message is null
 
 
- 
- 
Method Details- 
addCommentAdd comment (error/warning) to list of comments associated with processing of NTP parameters. If comment list not create then one will be created.- Parameters:
- comment- the comment
 
- 
computeDetailsCompute and validate details of the NTP message packet. Computed fields include the offset and delay.
- 
equalsCompares this object against the specified object. The result istrueif and only if the argument is notnulland is aTimeStampobject that contains the same values as this object.
- 
getAddressGets host address from message datagram if available- Returns:
- host address of available otherwise null
- Since:
- 3.4
 
- 
getCommentsReturn list of comments (if any) during processing of NTP packet.- Returns:
- List or null if not yet computed
 
- 
getDelayGets round-trip network delay. If null then could not compute the delay.- Returns:
- Long or null if delay not available.
 
- 
getMessageReturns NTP message packet.- Returns:
- NTP message packet.
 
- 
getOffsetGets clock offset needed to adjust local clock to match remote clock. If null then could not compute the offset.- Returns:
- Long or null if offset not available.
 
- 
getReturnTimeReturns time at which time message packet was received by local machine.- Returns:
- packet return time.
 
- 
hashCodeComputes a hash code for this object. The result is the exclusive OR of the return time and the message hash code.
 
-