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