Dirk-Willem van Gulik (NXP/mbed)
/
AmpereMeter
Example self-announcing webserver which controls a servo through a smallHTML userinterface.
services/ntp/NTPClient.h@0:a259777c45a3, 2010-08-14 (annotated)
- Committer:
- dirkx
- Date:
- Sat Aug 14 15:56:01 2010 +0000
- Revision:
- 0:a259777c45a3
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
dirkx | 0:a259777c45a3 | 1 | |
dirkx | 0:a259777c45a3 | 2 | /* |
dirkx | 0:a259777c45a3 | 3 | Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com) |
dirkx | 0:a259777c45a3 | 4 | |
dirkx | 0:a259777c45a3 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy |
dirkx | 0:a259777c45a3 | 6 | of this software and associated documentation files (the "Software"), to deal |
dirkx | 0:a259777c45a3 | 7 | in the Software without restriction, including without limitation the rights |
dirkx | 0:a259777c45a3 | 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
dirkx | 0:a259777c45a3 | 9 | copies of the Software, and to permit persons to whom the Software is |
dirkx | 0:a259777c45a3 | 10 | furnished to do so, subject to the following conditions: |
dirkx | 0:a259777c45a3 | 11 | |
dirkx | 0:a259777c45a3 | 12 | The above copyright notice and this permission notice shall be included in |
dirkx | 0:a259777c45a3 | 13 | all copies or substantial portions of the Software. |
dirkx | 0:a259777c45a3 | 14 | |
dirkx | 0:a259777c45a3 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
dirkx | 0:a259777c45a3 | 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
dirkx | 0:a259777c45a3 | 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
dirkx | 0:a259777c45a3 | 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
dirkx | 0:a259777c45a3 | 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
dirkx | 0:a259777c45a3 | 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
dirkx | 0:a259777c45a3 | 21 | THE SOFTWARE. |
dirkx | 0:a259777c45a3 | 22 | */ |
dirkx | 0:a259777c45a3 | 23 | |
dirkx | 0:a259777c45a3 | 24 | #ifndef NTP_CLIENT_H |
dirkx | 0:a259777c45a3 | 25 | #define NTP_CLIENT_H |
dirkx | 0:a259777c45a3 | 26 | |
dirkx | 0:a259777c45a3 | 27 | #include "if/net/net.h" |
dirkx | 0:a259777c45a3 | 28 | #include "api/UDPSocket.h" |
dirkx | 0:a259777c45a3 | 29 | #include "api/DNSRequest.h" |
dirkx | 0:a259777c45a3 | 30 | #include "mbed.h" |
dirkx | 0:a259777c45a3 | 31 | |
dirkx | 0:a259777c45a3 | 32 | enum NTPResult |
dirkx | 0:a259777c45a3 | 33 | { |
dirkx | 0:a259777c45a3 | 34 | NTP_OK, |
dirkx | 0:a259777c45a3 | 35 | NTP_PROCESSING, |
dirkx | 0:a259777c45a3 | 36 | NTP_PRTCL, //Protocol error |
dirkx | 0:a259777c45a3 | 37 | NTP_TIMEOUT, //Connection timeout |
dirkx | 0:a259777c45a3 | 38 | NTP_DNS //Could not resolve DNS Addr |
dirkx | 0:a259777c45a3 | 39 | }; |
dirkx | 0:a259777c45a3 | 40 | |
dirkx | 0:a259777c45a3 | 41 | class NTPClient : protected NetService |
dirkx | 0:a259777c45a3 | 42 | { |
dirkx | 0:a259777c45a3 | 43 | public: |
dirkx | 0:a259777c45a3 | 44 | NTPClient(); |
dirkx | 0:a259777c45a3 | 45 | virtual ~NTPClient(); |
dirkx | 0:a259777c45a3 | 46 | |
dirkx | 0:a259777c45a3 | 47 | //High level setup functions |
dirkx | 0:a259777c45a3 | 48 | NTPResult setTime(const Host& host); //Blocking |
dirkx | 0:a259777c45a3 | 49 | NTPResult setTime(const Host& host, void (*pMethod)(NTPResult)); //Non blocking |
dirkx | 0:a259777c45a3 | 50 | template<class T> |
dirkx | 0:a259777c45a3 | 51 | NTPResult setTime(const Host& host, T* pItem, void (T::*pMethod)(NTPResult)) //Non blocking |
dirkx | 0:a259777c45a3 | 52 | { |
dirkx | 0:a259777c45a3 | 53 | setOnResult(pItem, pMethod); |
dirkx | 0:a259777c45a3 | 54 | doSetTime(host); |
dirkx | 0:a259777c45a3 | 55 | return NTP_PROCESSING; |
dirkx | 0:a259777c45a3 | 56 | } |
dirkx | 0:a259777c45a3 | 57 | |
dirkx | 0:a259777c45a3 | 58 | void doSetTime(const Host& host); |
dirkx | 0:a259777c45a3 | 59 | |
dirkx | 0:a259777c45a3 | 60 | void setOnResult( void (*pMethod)(NTPResult) ); |
dirkx | 0:a259777c45a3 | 61 | class CDummy; |
dirkx | 0:a259777c45a3 | 62 | template<class T> |
dirkx | 0:a259777c45a3 | 63 | void setOnResult( T* pItem, void (T::*pMethod)(NTPResult) ) |
dirkx | 0:a259777c45a3 | 64 | { |
dirkx | 0:a259777c45a3 | 65 | m_pCbItem = (CDummy*) pItem; |
dirkx | 0:a259777c45a3 | 66 | m_pCbMeth = (void (CDummy::*)(NTPResult)) pMethod; |
dirkx | 0:a259777c45a3 | 67 | } |
dirkx | 0:a259777c45a3 | 68 | |
dirkx | 0:a259777c45a3 | 69 | void close(); |
dirkx | 0:a259777c45a3 | 70 | |
dirkx | 0:a259777c45a3 | 71 | protected: |
dirkx | 0:a259777c45a3 | 72 | virtual void poll(); //Called by NetServices |
dirkx | 0:a259777c45a3 | 73 | |
dirkx | 0:a259777c45a3 | 74 | private: |
dirkx | 0:a259777c45a3 | 75 | void init(); |
dirkx | 0:a259777c45a3 | 76 | void open(); |
dirkx | 0:a259777c45a3 | 77 | |
dirkx | 0:a259777c45a3 | 78 | __packed struct NTPPacket //See RFC 4330 for Simple NTP |
dirkx | 0:a259777c45a3 | 79 | { |
dirkx | 0:a259777c45a3 | 80 | //WARN: We are in LE! Network is BE! |
dirkx | 0:a259777c45a3 | 81 | //LSb first |
dirkx | 0:a259777c45a3 | 82 | unsigned mode : 3; |
dirkx | 0:a259777c45a3 | 83 | unsigned vn : 3; |
dirkx | 0:a259777c45a3 | 84 | unsigned li : 2; |
dirkx | 0:a259777c45a3 | 85 | |
dirkx | 0:a259777c45a3 | 86 | uint8_t stratum; |
dirkx | 0:a259777c45a3 | 87 | uint8_t poll; |
dirkx | 0:a259777c45a3 | 88 | uint8_t precision; |
dirkx | 0:a259777c45a3 | 89 | //32 bits header |
dirkx | 0:a259777c45a3 | 90 | |
dirkx | 0:a259777c45a3 | 91 | uint32_t rootDelay; |
dirkx | 0:a259777c45a3 | 92 | uint32_t rootDispersion; |
dirkx | 0:a259777c45a3 | 93 | uint32_t refId; |
dirkx | 0:a259777c45a3 | 94 | |
dirkx | 0:a259777c45a3 | 95 | uint32_t refTm_s; |
dirkx | 0:a259777c45a3 | 96 | uint32_t refTm_f; |
dirkx | 0:a259777c45a3 | 97 | uint32_t origTm_s; |
dirkx | 0:a259777c45a3 | 98 | uint32_t origTm_f; |
dirkx | 0:a259777c45a3 | 99 | uint32_t rxTm_s; |
dirkx | 0:a259777c45a3 | 100 | uint32_t rxTm_f; |
dirkx | 0:a259777c45a3 | 101 | uint32_t txTm_s; |
dirkx | 0:a259777c45a3 | 102 | uint32_t txTm_f; |
dirkx | 0:a259777c45a3 | 103 | }; |
dirkx | 0:a259777c45a3 | 104 | |
dirkx | 0:a259777c45a3 | 105 | void process(); //Main state-machine |
dirkx | 0:a259777c45a3 | 106 | |
dirkx | 0:a259777c45a3 | 107 | void setTimeout(int ms); |
dirkx | 0:a259777c45a3 | 108 | void resetTimeout(); |
dirkx | 0:a259777c45a3 | 109 | |
dirkx | 0:a259777c45a3 | 110 | void onTimeout(); //Connection has timed out |
dirkx | 0:a259777c45a3 | 111 | void onDNSReply(DNSReply r); |
dirkx | 0:a259777c45a3 | 112 | void onUDPSocketEvent(UDPSocketEvent e); |
dirkx | 0:a259777c45a3 | 113 | void onResult(NTPResult r); //Called when exchange completed or on failure |
dirkx | 0:a259777c45a3 | 114 | |
dirkx | 0:a259777c45a3 | 115 | NTPResult blockingProcess(); //Called in blocking mode, calls Net::poll() until return code is available |
dirkx | 0:a259777c45a3 | 116 | |
dirkx | 0:a259777c45a3 | 117 | UDPSocket* m_pUDPSocket; |
dirkx | 0:a259777c45a3 | 118 | |
dirkx | 0:a259777c45a3 | 119 | enum NTPStep |
dirkx | 0:a259777c45a3 | 120 | { |
dirkx | 0:a259777c45a3 | 121 | NTP_PING, |
dirkx | 0:a259777c45a3 | 122 | NTP_PONG |
dirkx | 0:a259777c45a3 | 123 | }; |
dirkx | 0:a259777c45a3 | 124 | |
dirkx | 0:a259777c45a3 | 125 | NTPStep m_state; |
dirkx | 0:a259777c45a3 | 126 | |
dirkx | 0:a259777c45a3 | 127 | NTPPacket m_pkt; |
dirkx | 0:a259777c45a3 | 128 | |
dirkx | 0:a259777c45a3 | 129 | CDummy* m_pCbItem; |
dirkx | 0:a259777c45a3 | 130 | void (CDummy::*m_pCbMeth)(NTPResult); |
dirkx | 0:a259777c45a3 | 131 | |
dirkx | 0:a259777c45a3 | 132 | void (*m_pCb)(NTPResult); |
dirkx | 0:a259777c45a3 | 133 | |
dirkx | 0:a259777c45a3 | 134 | Timer m_watchdog; |
dirkx | 0:a259777c45a3 | 135 | int m_timeout; |
dirkx | 0:a259777c45a3 | 136 | |
dirkx | 0:a259777c45a3 | 137 | bool m_closed; |
dirkx | 0:a259777c45a3 | 138 | |
dirkx | 0:a259777c45a3 | 139 | Host m_host; |
dirkx | 0:a259777c45a3 | 140 | |
dirkx | 0:a259777c45a3 | 141 | DNSRequest* m_pDnsReq; |
dirkx | 0:a259777c45a3 | 142 | |
dirkx | 0:a259777c45a3 | 143 | NTPResult m_blockingResult; //Result if blocking mode |
dirkx | 0:a259777c45a3 | 144 | |
dirkx | 0:a259777c45a3 | 145 | }; |
dirkx | 0:a259777c45a3 | 146 | |
dirkx | 0:a259777c45a3 | 147 | #endif |