Nino Der Kinderen / Mbed 2 deprecated InetTest

Embedded C project:18/12/2014

Dependencies:   DS1307 TextLCD mbed

NetServices/services/ntp/NTPClient.h@0:8d87bc453349, 2014-12-18 (annotated)

Committer:
ninoderkinderen
Date:
Thu Dec 18 09:35:49 2014 +0000
Revision:
0:8d87bc453349
Programma embedded C

Who changed what in which revision?

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