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.

Version: $Revision: 489397 $ $Date: 2006-12-21 16:28:51 +0000 (Thu, 21 Dec 2006) $

Author: Naz Irizarry, MITRE Corp Jason Mathews, MITRE Corp

Field Summary
static intLI_ALARM_CONDITION
static intLI_LAST_MINUTE_HAS_59_SECONDS
static intLI_LAST_MINUTE_HAS_61_SECONDS
static intLI_NO_WARNING
static intMODE_BROADCAST
static intMODE_CLIENT
static intMODE_CONTROL_MESSAGE
static intMODE_PRIVATE
static intMODE_RESERVED
static intMODE_SERVER
static intMODE_SYMMETRIC_ACTIVE
static intMODE_SYMMETRIC_PASSIVE
static intNTP_MAXCLOCK
static intNTP_MAXPOLL
static intNTP_MINCLOCK
static intNTP_MINPOLL
static intNTP_PORT
Standard NTP UDP port
static StringTYPE_DAYTIME
static StringTYPE_ICMP
static StringTYPE_NTP
static StringTYPE_TIME
static intVERSION_3
static intVERSION_4
Method Summary
DatagramPacketgetDatagramPacket()
intgetLeapIndicator()
intgetMode()
StringgetModeName()
TimeStampgetOriginateTimeStamp()
intgetPoll()
intgetPrecision()
TimeStampgetReceiveTimeStamp()
intgetReferenceId()
StringgetReferenceIdString()
TimeStampgetReferenceTimeStamp()
intgetRootDelay()
doublegetRootDelayInMillisDouble()
intgetRootDispersion()
longgetRootDispersionInMillis()
doublegetRootDispersionInMillisDouble()
intgetStratum()
TimeStampgetTransmitTimeStamp()
StringgetType()
Return type of time packet.
intgetVersion()
voidsetDatagramPacket(DatagramPacket dp)
Set the contents of this object from the datagram packet
voidsetLeapIndicator(int li)
Set leap indicator.
voidsetMode(int mode)
Set mode as defined in RFC-1305
voidsetOriginateTimeStamp(TimeStamp ts)
Set originate timestamp given NTP TimeStamp object.
voidsetPoll(int poll)
Set poll interval as defined in RFC-1305.
voidsetReceiveTimeStamp(TimeStamp ts)
Set receive timestamp given NTP TimeStamp object.
voidsetReferenceId(int refId)
Set reference clock identifier field.
voidsetReferenceTime(TimeStamp ts)
Set the reference timestamp given NTP TimeStamp object.
voidsetStratum(int stratum)
Set stratum as defined in RFC-1305
voidsetTransmitTime(TimeStamp ts)
Set the transmit timestamp given NTP TimeStamp object.
voidsetVersion(int mode)
Set version as defined in RFC-1305

Field Detail

LI_ALARM_CONDITION

public static final int LI_ALARM_CONDITION

LI_LAST_MINUTE_HAS_59_SECONDS

public static final int LI_LAST_MINUTE_HAS_59_SECONDS

LI_LAST_MINUTE_HAS_61_SECONDS

public static final int LI_LAST_MINUTE_HAS_61_SECONDS

LI_NO_WARNING

public static final int LI_NO_WARNING

MODE_BROADCAST

public static final int MODE_BROADCAST

MODE_CLIENT

public static final int MODE_CLIENT

MODE_CONTROL_MESSAGE

public static final int MODE_CONTROL_MESSAGE

MODE_PRIVATE

public static final int MODE_PRIVATE

MODE_RESERVED

public static final int MODE_RESERVED

MODE_SERVER

public static final int MODE_SERVER

MODE_SYMMETRIC_ACTIVE

public static final int MODE_SYMMETRIC_ACTIVE

MODE_SYMMETRIC_PASSIVE

public static final int MODE_SYMMETRIC_PASSIVE

NTP_MAXCLOCK

public static final int NTP_MAXCLOCK

NTP_MAXPOLL

public static final int NTP_MAXPOLL

NTP_MINCLOCK

public static final int NTP_MINCLOCK

NTP_MINPOLL

public static final int NTP_MINPOLL

NTP_PORT

public static final int NTP_PORT
Standard NTP UDP port

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

VERSION_4

public static final int VERSION_4

Method Detail

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