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