NtpReply.h

Go to the documentation of this file.

#pragma once
 
#include <cmath> /* For std::pow. */
 
#include <QtCore/QDateTime>
#include <NDEVR/Time.h>
#include <NDEVR/TimeSpan.h>
 
/**
 * NTP reply.
 */
namespace NDEVR
{
    class NtpReply {
    public:
        /**
         * Default constructor, constructs a null NTP reply.
         */
        NtpReply() {}
 
        /**
         * Constructs an NTP reply given an NTP packet and current time.
         *
         * @param packet                   NTP packet.
         * @param destinationTime          Time at the client when the reply arrived from the server.
         */
        NtpReply(NtpFullPacket packet, Time destinationTime) :
            m_packet(packet),
            m_destinationTime(destinationTime)
        {}
 
        /**
         * @returns                        Leap indicator.
         */
        NtpLeapIndicator leapIndicator() const {
            return static_cast<NtpLeapIndicator>(m_packet.basic.flags.leapIndicator);
        }
 
        /**
         * @returns                        NTP version number.
         */
        quint8 versionNumber() const {
            return m_packet.basic.flags.versionNumber;
        }
 
        /**
         * @returns                        Ntp mode.
         */
        NtpMode mode() const {
            return static_cast<NtpMode>(m_packet.basic.flags.mode);
        }
 
        /**
         * @returns                        Stratum.
         */
        quint8 stratum() const {
            return m_packet.basic.stratum;
        }
 
        /**
         * @returns                        Maximum interval between successive messages, in seconds.
         */
        qreal pollInterval() const {
            return std::pow(static_cast<qreal>(2), static_cast<qreal>(m_packet.basic.poll));
        }
 
        /**
         * @returns                        Clock precision, in seconds.
         */
        qreal precision() const {
            return std::pow(static_cast<qreal>(2), static_cast<qreal>(m_packet.basic.precision));
        }
 
        /**
         * @returns                        Time when the system clock was last set or corrected.
         */
        Time referenceTime() const {
            return m_packet.basic.referenceTimestamp.toTime();
        }
 
        /**
         * @returns                        Time at the client when the request departed for the server.
         */
        Time originTime() const {
            return m_packet.basic.originateTimestamp.toTime();
        }
 
        /**
         * @returns                        Time at the server when the request arrived from the client.
         */
        Time receiveTime() const {
            return m_packet.basic.receiveTimestamp.toTime();
        }
 
        /**
         * @returns                        Time at the server when the response left for the client.
         */
        Time transmitTime() const {
            return m_packet.basic.transmitTimestamp.toTime();
        }
 
        /**
         * @returns                        Time at the client when the reply arrived from the server.
         */
        Time destinationTime() const {
            return m_destinationTime;
        }
 
        /**
         * @return                         Raw NTP reply, for the curious user.
         */
        const NtpFullPacket& rawData() const {
            return m_packet;
        }
 
    private:
        NtpFullPacket m_packet;
        Time m_destinationTime;
    };
}