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