Donatien Garnier
NetServices Stack source
Dependents: HelloWorld ServoInterfaceBoardExample1 4180_Lab4
services/ntp/NTPClient.h@0:632c9925f013, 2010-06-11 (annotated)
- Committer:
- donatien
- Date:
- Fri Jun 11 16:05:15 2010 +0000
- Revision:
- 0:632c9925f013
- Child:
- 2:a4f97773c90f
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 | 0:632c9925f013 | 24 | #ifndef NTP_CLIENT_H |
| donatien | 0:632c9925f013 | 25 | #define NTP_CLIENT_H |
| donatien | 0:632c9925f013 | 26 | |
| donatien | 0:632c9925f013 | 27 | #include "if/net/net.h" |
| donatien | 0:632c9925f013 | 28 | #include "api/UDPSocket.h" |
| donatien | 0:632c9925f013 | 29 | #include "api/DNSRequest.h" |
| donatien | 0:632c9925f013 | 30 | #include "mbed.h" |
| donatien | 0:632c9925f013 | 31 | |
| donatien | 0:632c9925f013 | 32 | enum NTPResult |
| donatien | 0:632c9925f013 | 33 | { |
| donatien | 0:632c9925f013 | 34 | NTP_OK, |
| donatien | 0:632c9925f013 | 35 | NTP_PROCESSING, |
| donatien | 0:632c9925f013 | 36 | NTP_PRTCL, //Protocol error |
| donatien | 0:632c9925f013 | 37 | NTP_TIMEOUT, //Connection timeout |
| donatien | 0:632c9925f013 | 38 | NTP_DNS //Could not resolve DNS Addr |
| donatien | 0:632c9925f013 | 39 | }; |
| donatien | 0:632c9925f013 | 40 | |
| donatien | 0:632c9925f013 | 41 | class NTPClient |
| donatien | 0:632c9925f013 | 42 | { |
| donatien | 0:632c9925f013 | 43 | public: |
| donatien | 0:632c9925f013 | 44 | NTPClient(); |
| donatien | 0:632c9925f013 | 45 | virtual ~NTPClient(); |
| donatien | 0:632c9925f013 | 46 | |
| donatien | 0:632c9925f013 | 47 | //High level setup functions |
| donatien | 0:632c9925f013 | 48 | NTPResult setTime(const Host& host); //Blocking |
| donatien | 0:632c9925f013 | 49 | NTPResult setTime(const Host& host, void (*pMethod)(NTPResult)); //Non blocking |
| donatien | 0:632c9925f013 | 50 | template<class T> |
| donatien | 0:632c9925f013 | 51 | NTPResult setTime(const Host& host, T* pItem, void (T::*pMethod)(NTPResult)) //Non blocking |
| donatien | 0:632c9925f013 | 52 | { |
| donatien | 0:632c9925f013 | 53 | setOnResult(pItem, pMethod); |
| donatien | 0:632c9925f013 | 54 | doSetTime(host); |
| donatien | 0:632c9925f013 | 55 | return NTP_PROCESSING; |
| donatien | 0:632c9925f013 | 56 | } |
| donatien | 0:632c9925f013 | 57 | |
| donatien | 0:632c9925f013 | 58 | void doSetTime(const Host& host); |
| donatien | 0:632c9925f013 | 59 | |
| donatien | 0:632c9925f013 | 60 | void setOnResult( void (*pMethod)(NTPResult) ); |
| donatien | 0:632c9925f013 | 61 | class CDummy; |
| donatien | 0:632c9925f013 | 62 | template<class T> |
| donatien | 0:632c9925f013 | 63 | void setOnResult( T* pItem, void (T::*pMethod)(NTPResult) ) |
| donatien | 0:632c9925f013 | 64 | { |
| donatien | 0:632c9925f013 | 65 | m_pCbItem = (CDummy*) pItem; |
| donatien | 0:632c9925f013 | 66 | m_pCbMeth = (void (CDummy::*)(NTPResult)) pMethod; |
| donatien | 0:632c9925f013 | 67 | } |
| donatien | 0:632c9925f013 | 68 | |
| donatien | 0:632c9925f013 | 69 | void init(); |
| donatien | 0:632c9925f013 | 70 | void close(); |
| donatien | 0:632c9925f013 | 71 | |
| donatien | 0:632c9925f013 | 72 | private: |
| donatien | 0:632c9925f013 | 73 | __packed struct NTPPacket //See RFC 4330 for Simple NTP |
| donatien | 0:632c9925f013 | 74 | { |
| donatien | 0:632c9925f013 | 75 | //WARN: We are in LE! Network is BE! |
| donatien | 0:632c9925f013 | 76 | //LSb first |
| donatien | 0:632c9925f013 | 77 | unsigned mode : 3; |
| donatien | 0:632c9925f013 | 78 | unsigned vn : 3; |
| donatien | 0:632c9925f013 | 79 | unsigned li : 2; |
| donatien | 0:632c9925f013 | 80 | |
| donatien | 0:632c9925f013 | 81 | uint8_t stratum; |
| donatien | 0:632c9925f013 | 82 | uint8_t poll; |
| donatien | 0:632c9925f013 | 83 | uint8_t precision; |
| donatien | 0:632c9925f013 | 84 | //32 bits header |
| donatien | 0:632c9925f013 | 85 | |
| donatien | 0:632c9925f013 | 86 | uint32_t rootDelay; |
| donatien | 0:632c9925f013 | 87 | uint32_t rootDispersion; |
| donatien | 0:632c9925f013 | 88 | uint32_t refId; |
| donatien | 0:632c9925f013 | 89 | |
| donatien | 0:632c9925f013 | 90 | uint32_t refTm_s; |
| donatien | 0:632c9925f013 | 91 | uint32_t refTm_f; |
| donatien | 0:632c9925f013 | 92 | uint32_t origTm_s; |
| donatien | 0:632c9925f013 | 93 | uint32_t origTm_f; |
| donatien | 0:632c9925f013 | 94 | uint32_t rxTm_s; |
| donatien | 0:632c9925f013 | 95 | uint32_t rxTm_f; |
| donatien | 0:632c9925f013 | 96 | uint32_t txTm_s; |
| donatien | 0:632c9925f013 | 97 | uint32_t txTm_f; |
| donatien | 0:632c9925f013 | 98 | }; |
| donatien | 0:632c9925f013 | 99 | |
| donatien | 0:632c9925f013 | 100 | void process(); //Main state-machine |
| donatien | 0:632c9925f013 | 101 | |
| donatien | 0:632c9925f013 | 102 | void setTimeout(int ms); |
| donatien | 0:632c9925f013 | 103 | void resetTimeout(); |
| donatien | 0:632c9925f013 | 104 | |
| donatien | 0:632c9925f013 | 105 | void onTimeout(); //Connection has timed out |
| donatien | 0:632c9925f013 | 106 | void onDNSReply(DNSReply r); |
| donatien | 0:632c9925f013 | 107 | void onUDPSocketEvent(UDPSocketEvent e); |
| donatien | 0:632c9925f013 | 108 | void onResult(NTPResult r); //Called when exchange completed or on failure |
| donatien | 0:632c9925f013 | 109 | |
| donatien | 0:632c9925f013 | 110 | NTPResult blockingProcess(); //Called in blocking mode, calls Net::poll() until return code is available |
| donatien | 0:632c9925f013 | 111 | |
| donatien | 0:632c9925f013 | 112 | UDPSocket* m_pUDPSocket; |
| donatien | 0:632c9925f013 | 113 | |
| donatien | 0:632c9925f013 | 114 | enum NTPStep |
| donatien | 0:632c9925f013 | 115 | { |
| donatien | 0:632c9925f013 | 116 | NTP_PING, |
| donatien | 0:632c9925f013 | 117 | NTP_PONG |
| donatien | 0:632c9925f013 | 118 | }; |
| donatien | 0:632c9925f013 | 119 | |
| donatien | 0:632c9925f013 | 120 | NTPStep m_state; |
| donatien | 0:632c9925f013 | 121 | |
| donatien | 0:632c9925f013 | 122 | CDummy* m_pCbItem; |
| donatien | 0:632c9925f013 | 123 | void (CDummy::*m_pCbMeth)(NTPResult); |
| donatien | 0:632c9925f013 | 124 | |
| donatien | 0:632c9925f013 | 125 | void (*m_pCb)(NTPResult); |
| donatien | 0:632c9925f013 | 126 | |
| donatien | 0:632c9925f013 | 127 | Timeout m_watchdog; |
| donatien | 0:632c9925f013 | 128 | int m_timeout; |
| donatien | 0:632c9925f013 | 129 | |
| donatien | 0:632c9925f013 | 130 | bool m_closed; |
| donatien | 0:632c9925f013 | 131 | |
| donatien | 0:632c9925f013 | 132 | Host m_host; |
| donatien | 0:632c9925f013 | 133 | |
| donatien | 0:632c9925f013 | 134 | DNSRequest* m_pDnsReq; |
| donatien | 0:632c9925f013 | 135 | |
| donatien | 0:632c9925f013 | 136 | NTPResult m_blockingResult; //Result if blocking mode |
| donatien | 0:632c9925f013 | 137 | |
| donatien | 0:632c9925f013 | 138 | }; |
| donatien | 0:632c9925f013 | 139 | |
| donatien | 0:632c9925f013 | 140 | #endif |