Michael Spencer / Mbed 2 deprecated LaOS

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

NetServices/services/ntp/NTPClient.h@1:f5ac63519541, 2014-03-05 (annotated)

Committer:
Michael J. Spencer
Date:
Wed Mar 05 06:14:02 2014 -0800
Revision:
1:f5ac63519541
Initial commit.

Who changed what in which revision?

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