NtpClient.h

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2015 by Skurydin Alexey
 * http://github.com/anakod/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * NtpClient.h
 *
 ****/

#ifndef _SMING_CORE_NETWORK_NTP_CLIENT_H_
#define _SMING_CORE_NETWORK_NTP_CLIENT_H_

#include "UdpConnection.h"
#include "Platform/System.h"
#include "Timer.h"
#include "DateTime.h"
#include "Delegate.h"

#define NTP_PORT 123
#define NTP_PACKET_SIZE 48
#define NTP_VERSION 4
#define NTP_MODE_CLIENT 3
#define NTP_MODE_SERVER 4

#define NTP_DEFAULT_SERVER F("pool.ntp.org")
#define NTP_DEFAULT_AUTOQUERY_SECONDS 30U // (10U * SECS_PER_MIN) 
#define NTP_MIN_AUTOQUERY_SECONDS 10U    
#define NTP_CONNECTION_TIMEOUT_MS 1666U   
#define NTP_RESPONSE_TIMEOUT_MS 20000U  

class NtpClient;

// Delegate constructor usage: (&YourClass::method, this)
typedef Delegate<void(NtpClient& client, time_t ntpTime)> NtpTimeResultDelegate;

class NtpClient : protected UdpConnection
{
public:
    NtpClient() : NtpClient(NTP_DEFAULT_SERVER, NTP_DEFAULT_AUTOQUERY_SECONDS, nullptr)
    {
    }

    NtpClient(NtpTimeResultDelegate onTimeReceivedCb)
        : NtpClient(NTP_DEFAULT_SERVER, NTP_DEFAULT_AUTOQUERY_SECONDS, onTimeReceivedCb)
    {
    }

    NtpClient(const String& reqServer, unsigned reqIntervalSeconds, NtpTimeResultDelegate onTimeReceivedCb = nullptr);

    void requestTime();

    void setNtpServer(const String& server)
    {
        this->server = server;
    }

    void setAutoQuery(bool autoQuery);

    void setAutoQueryInterval(unsigned seconds);

    void setAutoUpdateSystemClock(bool autoUpdateClock)
    {
        autoUpdateSystemClock = autoUpdateClock;
    }

protected:
    void onReceive(pbuf* buf, IPAddress remoteIP, uint16_t remotePort) override;

    void internalRequestTime(IPAddress serverIp);

    void startTimer(uint32_t milliseconds)
    {
        debug_d("NtpClient::startTimer(%u)", milliseconds);
        timer.setIntervalMs(milliseconds);
        timer.startOnce();
    }

    void stopTimer()
    {
        debug_d("NtpClient::stopTimer()");
        timer.stop();
    }

protected:
    String server; 

    NtpTimeResultDelegate delegateCompleted = nullptr; 
    bool autoUpdateSystemClock = false;                
    bool autoQueryEnabled = false;
    unsigned autoQuerySeconds = NTP_DEFAULT_AUTOQUERY_SECONDS;
    Timer timer; 
};

#endif /* _SMING_CORE_NETWORK_NTP_CLIENT_H_ */