Package nts

Interface NtpV3Packet

All Known Subinterfaces:
NtpV4Packet, NtsPacket
All Known Implementing Classes:
NtpV3Impl, NtpV4Impl, NtsImpl
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 Details

  • Method Details

    • buildRequest

      void buildRequest()
      Build a request packet

    • getDatagramPacket

      DatagramPacket getDatagramPacket()
      Returns:
      a datagram packet with the NTP parts already filled in

    • getDatagramPacket

      DatagramPacket getDatagramPacket(int sz)
      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

      void setDatagramPacket(DatagramPacket dp)
      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

      void setOriginateTimeStamp(TimeStamp ts)
      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

      void setReceiveTimeStamp(TimeStamp ts)
      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

      void setReferenceTime(TimeStamp ts)
      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

      void setTransmitTime(TimeStamp ts)
      Sets the transmit 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

    • validate

      void validate(NtpV3Packet req) throws IOException
      Validate a response packet given a request packet
      Parameters:
      req - - The request packet
      Throws:
      IOException - - On failure