/*
    * Licensed to the Apache Software Foundation (ASF) under one or more
    * contributor license agreements.  See the NOTICE file distributed with
    * this work for additional information regarding copyright ownership.
    * The ASF licenses this file to You under the Apache License, Version 2.0
    * (the "License"); you may not use this file except in compliance with
    * the License.  You may obtain a copy of the License at
    *
    *      http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  
  package org.apache.commons.net.ntp;
  
  import java.net.DatagramPacket;
  
  /**
   * Interface for a NtpV3Packet with get/set methods corresponding to the fields in the NTP Data Message Header described in RFC 1305.
   */
  public interface NtpV3Packet {
  
      /**
       * Standard NTP UDP port
       */
      int NTP_PORT = 123;
  
      int LI_NO_WARNING = 0;
      int LI_LAST_MINUTE_HAS_61_SECONDS = 1;
      int LI_LAST_MINUTE_HAS_59_SECONDS = 2;
      int LI_ALARM_CONDITION = 3;
  
      // mode options
      /** Mode option {@value}. */
      int MODE_RESERVED = 0;
  
      /** Mode option {@value}. */
      int MODE_SYMMETRIC_ACTIVE = 1;
  
      /** Mode option {@value}. */
      int MODE_SYMMETRIC_PASSIVE = 2;
  
      /** Mode option {@value}. */
      int MODE_CLIENT = 3;
  
      /** Mode option {@value}. */
      int MODE_SERVER = 4;
  
      /** Mode option {@value}. */
      int MODE_BROADCAST = 5;
  
      /** Mode option {@value}. */
      int MODE_CONTROL_MESSAGE = 6;
  
      /** Mode option {@value}. */
      int MODE_PRIVATE = 7;
  
      int NTP_MINPOLL = 4; // 16 seconds
      int NTP_MAXPOLL = 14; // 16284 seconds
  
      int NTP_MINCLOCK = 1;
      int NTP_MAXCLOCK = 10;
  
      int VERSION_3 = 3;
      int VERSION_4 = 4;
  
      /*
       * possible getType values such that other time-related protocols can have its information represented as NTP packets
       */
      String TYPE_NTP = "NTP"; // RFC-1305/2030
      String TYPE_ICMP = "ICMP"; // RFC-792
      String TYPE_TIME = "TIME"; // RFC-868
      String TYPE_DAYTIME = "DAYTIME"; // RFC-867
  
      /**
       * @return a datagram packet with the NTP parts already filled in
       */
      DatagramPacket getDatagramPacket();
  
      /**
       * @return leap indicator as defined in RFC-1305
       */
      int getLeapIndicator();
  
      /**
       * @return mode as defined in RFC-1305
       */
      int getMode();
  
      /**
       * @return mode as human readable string; e.g. 3=Client
       */
      String getModeName();
  
      /**
      * @return the {@code originate} time as defined in RFC-1305
      */
     TimeStamp getOriginateTimeStamp();
 
     /**
      * @return poll interval as defined in RFC-1305. Field range between NTP_MINPOLL and NTP_MAXPOLL.
      */
     int getPoll();
 
     /**
      * @return precision as defined in RFC-1305
      */
     int getPrecision();
 
     /**
      * @return the {@code receive} time as defined in RFC-1305
      */
     TimeStamp getReceiveTimeStamp();
 
     /**
      * @return the reference id (32-bit code) as defined in RFC-1305
      */
     int getReferenceId();
 
     /**
      * @return the reference id string
      */
     String getReferenceIdString();
 
     /**
      * @return the reference time as defined in RFC-1305
      */
     TimeStamp getReferenceTimeStamp();
 
     /**
      * @return root delay as defined in RFC-1305
      */
     int getRootDelay();
 
     /**
      * @return root delay in milliseconds
      */
     double getRootDelayInMillisDouble();
 
     /**
      * @return root dispersion as defined in RFC-1305
      */
     int getRootDispersion();
 
     /**
      * @return root dispersion in milliseconds
      */
     long getRootDispersionInMillis();
 
     /**
      * @return root dispersion in milliseconds
      */
     double getRootDispersionInMillisDouble();
 
     /**
      * @return stratum as defined in RFC-1305
      */
     int getStratum();
 
     /**
      * @return the {@code transmit} timestamp as defined in RFC-1305
      */
     TimeStamp getTransmitTimeStamp();
 
     /**
      * Return type of time packet. The values (e.g. NTP, TIME, ICMP, ...) correspond to the protocol used to obtain the timing information.
      *
      * @return packet type string identifier
      */
     String getType();
 
     /**
      * @return version as defined in RFC-1305
      */
     int getVersion();
 
     /**
      * Set the contents of this object from the datagram packet
      *
      * @param dp the packet
      */
     void setDatagramPacket(DatagramPacket dp);
 
     /**
      * Set leap indicator.
      *
      * @param li - leap indicator code
      */
     void setLeapIndicator(int li);
 
     /**
      * Set mode as defined in RFC-1305
      *
      * @param mode the mode to set
      */
     void setMode(int mode);
 
     /**
      * Set originate timestamp given NTP TimeStamp object.
      *
      * @param ts - timestamp
      */
     void setOriginateTimeStamp(TimeStamp ts);
 
     /**
      * Set poll interval as defined in RFC-1305. Field range between NTP_MINPOLL and NTP_MAXPOLL.
      *
      * @param poll the interval to set
      */
     void setPoll(int poll);
 
     /**
      * Set precision as defined in RFC-1305
      *
      * @param precision Precision
      * @since 3.4
      */
     void setPrecision(int precision);
 
     /**
      * Set receive timestamp given NTP TimeStamp object.
      *
      * @param ts - timestamp
      */
     void setReceiveTimeStamp(TimeStamp ts);
 
     /**
      * Set reference clock identifier field.
      *
      * @param refId the clock id field to set
      */
     void setReferenceId(int refId);
 
     /**
      * Set the reference timestamp given NTP TimeStamp object.
      *
      * @param ts - timestamp
      */
     void setReferenceTime(TimeStamp ts);
 
     /**
      * Set root delay as defined in RFC-1305
      *
      * @param delay the delay to set
      * @since 3.4
      */
     void setRootDelay(int delay);
 
     /**
      *
      * @param dispersion the value to set
      * @since 3.4
      */
     void setRootDispersion(int dispersion);
 
     /**
      * Set stratum as defined in RFC-1305
      *
      * @param stratum the stratum to set
      */
     void setStratum(int stratum);
 
     /**
      * Set the {@code transmit} timestamp given NTP TimeStamp object.
      *
      * @param ts - timestamp
      */
     void setTransmitTime(TimeStamp ts);
 
     /**
      * Set version as defined in RFC-1305
      *
      * @param version the version to set
      */
     void setVersion(int version);
 
 }