FBI FRATER / Mbed 2 deprecated InetTest

Library for Bert van Dam's book "ARM MICROCONTROLLERS" For all chapters with internet.

Dependencies:   mbed

NetServices/services/ntp/NTPClient.h@0:4edb816d21e1, 2015-10-16 (annotated)

Committer:
ICTFBI
Date:
Fri Oct 16 14:28:26 2015 +0000
Revision:
0:4edb816d21e1
Pre-update 16-10-15

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ICTFBI 0:4edb816d21e1 1
ICTFBI 0:4edb816d21e1 2 /*
ICTFBI 0:4edb816d21e1 3 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
ICTFBI 0:4edb816d21e1 4
ICTFBI 0:4edb816d21e1 5 Permission is hereby granted, free of charge, to any person obtaining a copy
ICTFBI 0:4edb816d21e1 6 of this software and associated documentation files (the "Software"), to deal
ICTFBI 0:4edb816d21e1 7 in the Software without restriction, including without limitation the rights
ICTFBI 0:4edb816d21e1 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
ICTFBI 0:4edb816d21e1 9 copies of the Software, and to permit persons to whom the Software is
ICTFBI 0:4edb816d21e1 10 furnished to do so, subject to the following conditions:
ICTFBI 0:4edb816d21e1 11
ICTFBI 0:4edb816d21e1 12 The above copyright notice and this permission notice shall be included in
ICTFBI 0:4edb816d21e1 13 all copies or substantial portions of the Software.
ICTFBI 0:4edb816d21e1 14
ICTFBI 0:4edb816d21e1 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
ICTFBI 0:4edb816d21e1 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
ICTFBI 0:4edb816d21e1 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
ICTFBI 0:4edb816d21e1 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
ICTFBI 0:4edb816d21e1 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
ICTFBI 0:4edb816d21e1 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
ICTFBI 0:4edb816d21e1 21 THE SOFTWARE.
ICTFBI 0:4edb816d21e1 22 */
ICTFBI 0:4edb816d21e1 23
ICTFBI 0:4edb816d21e1 24 /** \file
ICTFBI 0:4edb816d21e1 25 NTP Client header file
ICTFBI 0:4edb816d21e1 26 */
ICTFBI 0:4edb816d21e1 27
ICTFBI 0:4edb816d21e1 28 #ifndef NTP_CLIENT_H
ICTFBI 0:4edb816d21e1 29 #define NTP_CLIENT_H
ICTFBI 0:4edb816d21e1 30
ICTFBI 0:4edb816d21e1 31 #include "core/net.h"
ICTFBI 0:4edb816d21e1 32 #include "core/netservice.h"
ICTFBI 0:4edb816d21e1 33 #include "api/UDPSocket.h"
ICTFBI 0:4edb816d21e1 34 #include "api/DNSRequest.h"
ICTFBI 0:4edb816d21e1 35 #include "mbed.h"
ICTFBI 0:4edb816d21e1 36
ICTFBI 0:4edb816d21e1 37 ///NTP Client results
ICTFBI 0:4edb816d21e1 38 enum NTPResult
ICTFBI 0:4edb816d21e1 39 {
ICTFBI 0:4edb816d21e1 40 NTP_OK, ///<Success
ICTFBI 0:4edb816d21e1 41 NTP_PROCESSING, ///<Processing
ICTFBI 0:4edb816d21e1 42 NTP_PRTCL, ///<Protocol error
ICTFBI 0:4edb816d21e1 43 NTP_TIMEOUT, ///<Connection timeout
ICTFBI 0:4edb816d21e1 44 NTP_DNS ///<Could not resolve DNS hostname
ICTFBI 0:4edb816d21e1 45 };
ICTFBI 0:4edb816d21e1 46
ICTFBI 0:4edb816d21e1 47 ///A NTP Client
ICTFBI 0:4edb816d21e1 48 /**
ICTFBI 0:4edb816d21e1 49 The NTP client is a simple UDP client that will update the mbed's RTC
ICTFBI 0:4edb816d21e1 50 */
ICTFBI 0:4edb816d21e1 51 class NTPClient : protected NetService
ICTFBI 0:4edb816d21e1 52 {
ICTFBI 0:4edb816d21e1 53 public:
ICTFBI 0:4edb816d21e1 54 /**
ICTFBI 0:4edb816d21e1 55 Instantiates the NTP client
ICTFBI 0:4edb816d21e1 56 */
ICTFBI 0:4edb816d21e1 57 NTPClient();
ICTFBI 0:4edb816d21e1 58 virtual ~NTPClient();
ICTFBI 0:4edb816d21e1 59
ICTFBI 0:4edb816d21e1 60 //High level setup functions
ICTFBI 0:4edb816d21e1 61
ICTFBI 0:4edb816d21e1 62 ///Gets current time (blocking)
ICTFBI 0:4edb816d21e1 63 /**
ICTFBI 0:4edb816d21e1 64 Updates the time using the server host
ICTFBI 0:4edb816d21e1 65 Blocks until completion
ICTFBI 0:4edb816d21e1 66 @param host : NTP server
ICTFBI 0:4edb816d21e1 67 */
ICTFBI 0:4edb816d21e1 68 NTPResult setTime(const Host& host); //Blocking
ICTFBI 0:4edb816d21e1 69
ICTFBI 0:4edb816d21e1 70 ///Gets current time (non-blocking)
ICTFBI 0:4edb816d21e1 71 /**
ICTFBI 0:4edb816d21e1 72 Updates the time using the server host
ICTFBI 0:4edb816d21e1 73 The function returns immediately and calls the callback on completion or error
ICTFBI 0:4edb816d21e1 74 @param host : NTP server
ICTFBI 0:4edb816d21e1 75 @param pMethod : callback function
ICTFBI 0:4edb816d21e1 76 */
ICTFBI 0:4edb816d21e1 77 NTPResult setTime(const Host& host, void (*pMethod)(NTPResult)); //Non blocking
ICTFBI 0:4edb816d21e1 78
ICTFBI 0:4edb816d21e1 79 ///Gets current time (non-blocking)
ICTFBI 0:4edb816d21e1 80 /**
ICTFBI 0:4edb816d21e1 81 Updates the time
ICTFBI 0:4edb816d21e1 82 @param host : NTP server
ICTFBI 0:4edb816d21e1 83 @param pItem : instance of class on which to execute the callback method
ICTFBI 0:4edb816d21e1 84 @param pMethod : callback method
ICTFBI 0:4edb816d21e1 85 The function returns immediately and calls the callback on completion or error
ICTFBI 0:4edb816d21e1 86 */
ICTFBI 0:4edb816d21e1 87 template<class T>
ICTFBI 0:4edb816d21e1 88 NTPResult setTime(const Host& host, T* pItem, void (T::*pMethod)(NTPResult)) //Non blocking
ICTFBI 0:4edb816d21e1 89 {
ICTFBI 0:4edb816d21e1 90 setOnResult(pItem, pMethod);
ICTFBI 0:4edb816d21e1 91 doSetTime(host);
ICTFBI 0:4edb816d21e1 92 return NTP_PROCESSING;
ICTFBI 0:4edb816d21e1 93 }
ICTFBI 0:4edb816d21e1 94
ICTFBI 0:4edb816d21e1 95 ///Gets current time (non-blocking)
ICTFBI 0:4edb816d21e1 96 /**
ICTFBI 0:4edb816d21e1 97 Updates the time using the server host
ICTFBI 0:4edb816d21e1 98 The function returns immediately and calls the previously set callback on completion or error
ICTFBI 0:4edb816d21e1 99 @param host : NTP server
ICTFBI 0:4edb816d21e1 100 */
ICTFBI 0:4edb816d21e1 101 void doSetTime(const Host& host);
ICTFBI 0:4edb816d21e1 102
ICTFBI 0:4edb816d21e1 103 ///Setups the result callback
ICTFBI 0:4edb816d21e1 104 /**
ICTFBI 0:4edb816d21e1 105 @param pMethod : callback function
ICTFBI 0:4edb816d21e1 106 */
ICTFBI 0:4edb816d21e1 107 void setOnResult( void (*pMethod)(NTPResult) );
ICTFBI 0:4edb816d21e1 108
ICTFBI 0:4edb816d21e1 109 ///Setups the result callback
ICTFBI 0:4edb816d21e1 110 /**
ICTFBI 0:4edb816d21e1 111 @param pItem : instance of class on which to execute the callback method
ICTFBI 0:4edb816d21e1 112 @param pMethod : callback method
ICTFBI 0:4edb816d21e1 113 */
ICTFBI 0:4edb816d21e1 114 class CDummy;
ICTFBI 0:4edb816d21e1 115 template<class T>
ICTFBI 0:4edb816d21e1 116 void setOnResult( T* pItem, void (T::*pMethod)(NTPResult) )
ICTFBI 0:4edb816d21e1 117 {
ICTFBI 0:4edb816d21e1 118 m_pCbItem = (CDummy*) pItem;
ICTFBI 0:4edb816d21e1 119 m_pCbMeth = (void (CDummy::*)(NTPResult)) pMethod;
ICTFBI 0:4edb816d21e1 120 }
ICTFBI 0:4edb816d21e1 121
ICTFBI 0:4edb816d21e1 122 void close();
ICTFBI 0:4edb816d21e1 123
ICTFBI 0:4edb816d21e1 124 protected:
ICTFBI 0:4edb816d21e1 125 virtual void poll(); //Called by NetServices
ICTFBI 0:4edb816d21e1 126
ICTFBI 0:4edb816d21e1 127 private:
ICTFBI 0:4edb816d21e1 128 void init();
ICTFBI 0:4edb816d21e1 129 void open();
ICTFBI 0:4edb816d21e1 130
ICTFBI 0:4edb816d21e1 131 __packed struct NTPPacket //See RFC 4330 for Simple NTP
ICTFBI 0:4edb816d21e1 132 {
ICTFBI 0:4edb816d21e1 133 //WARN: We are in LE! Network is BE!
ICTFBI 0:4edb816d21e1 134 //LSb first
ICTFBI 0:4edb816d21e1 135 unsigned mode : 3;
ICTFBI 0:4edb816d21e1 136 unsigned vn : 3;
ICTFBI 0:4edb816d21e1 137 unsigned li : 2;
ICTFBI 0:4edb816d21e1 138
ICTFBI 0:4edb816d21e1 139 uint8_t stratum;
ICTFBI 0:4edb816d21e1 140 uint8_t poll;
ICTFBI 0:4edb816d21e1 141 uint8_t precision;
ICTFBI 0:4edb816d21e1 142 //32 bits header
ICTFBI 0:4edb816d21e1 143
ICTFBI 0:4edb816d21e1 144 uint32_t rootDelay;
ICTFBI 0:4edb816d21e1 145 uint32_t rootDispersion;
ICTFBI 0:4edb816d21e1 146 uint32_t refId;
ICTFBI 0:4edb816d21e1 147
ICTFBI 0:4edb816d21e1 148 uint32_t refTm_s;
ICTFBI 0:4edb816d21e1 149 uint32_t refTm_f;
ICTFBI 0:4edb816d21e1 150 uint32_t origTm_s;
ICTFBI 0:4edb816d21e1 151 uint32_t origTm_f;
ICTFBI 0:4edb816d21e1 152 uint32_t rxTm_s;
ICTFBI 0:4edb816d21e1 153 uint32_t rxTm_f;
ICTFBI 0:4edb816d21e1 154 uint32_t txTm_s;
ICTFBI 0:4edb816d21e1 155 uint32_t txTm_f;
ICTFBI 0:4edb816d21e1 156 };
ICTFBI 0:4edb816d21e1 157
ICTFBI 0:4edb816d21e1 158 void process(); //Main state-machine
ICTFBI 0:4edb816d21e1 159
ICTFBI 0:4edb816d21e1 160 void setTimeout(int ms);
ICTFBI 0:4edb816d21e1 161 void resetTimeout();
ICTFBI 0:4edb816d21e1 162
ICTFBI 0:4edb816d21e1 163 void onTimeout(); //Connection has timed out
ICTFBI 0:4edb816d21e1 164 void onDNSReply(DNSReply r);
ICTFBI 0:4edb816d21e1 165 void onUDPSocketEvent(UDPSocketEvent e);
ICTFBI 0:4edb816d21e1 166 void onResult(NTPResult r); //Called when exchange completed or on failure
ICTFBI 0:4edb816d21e1 167
ICTFBI 0:4edb816d21e1 168 NTPResult blockingProcess(); //Called in blocking mode, calls Net::poll() until return code is available
ICTFBI 0:4edb816d21e1 169
ICTFBI 0:4edb816d21e1 170 UDPSocket* m_pUDPSocket;
ICTFBI 0:4edb816d21e1 171
ICTFBI 0:4edb816d21e1 172 enum NTPStep
ICTFBI 0:4edb816d21e1 173 {
ICTFBI 0:4edb816d21e1 174 NTP_PING,
ICTFBI 0:4edb816d21e1 175 NTP_PONG
ICTFBI 0:4edb816d21e1 176 };
ICTFBI 0:4edb816d21e1 177
ICTFBI 0:4edb816d21e1 178 NTPStep m_state;
ICTFBI 0:4edb816d21e1 179
ICTFBI 0:4edb816d21e1 180 NTPPacket m_pkt;
ICTFBI 0:4edb816d21e1 181
ICTFBI 0:4edb816d21e1 182 CDummy* m_pCbItem;
ICTFBI 0:4edb816d21e1 183 void (CDummy::*m_pCbMeth)(NTPResult);
ICTFBI 0:4edb816d21e1 184
ICTFBI 0:4edb816d21e1 185 void (*m_pCb)(NTPResult);
ICTFBI 0:4edb816d21e1 186
ICTFBI 0:4edb816d21e1 187 Timer m_watchdog;
ICTFBI 0:4edb816d21e1 188 int m_timeout;
ICTFBI 0:4edb816d21e1 189
ICTFBI 0:4edb816d21e1 190 bool m_closed;
ICTFBI 0:4edb816d21e1 191
ICTFBI 0:4edb816d21e1 192 Host m_host;
ICTFBI 0:4edb816d21e1 193
ICTFBI 0:4edb816d21e1 194 DNSRequest* m_pDnsReq;
ICTFBI 0:4edb816d21e1 195
ICTFBI 0:4edb816d21e1 196 NTPResult m_blockingResult; //Result if blocking mode
ICTFBI 0:4edb816d21e1 197
ICTFBI 0:4edb816d21e1 198 };
ICTFBI 0:4edb816d21e1 199
ICTFBI 0:4edb816d21e1 200 #endif