Revision 2:9a64a50df235, committed 2012-08-05

Comitter:

donatien

Date:

Sun Aug 05 15:36:47 2012 +0000

Parent:

1:b221a8765b3f

Child:

3:17d8bad407cc

Commit message:

Updated to use latest Socket API

Changed in this revision

--- a/NTPClient.cpp	Fri Jul 27 08:49:34 2012 +0000
+++ b/NTPClient.cpp	Sun Aug 05 15:36:47 2012 +0000
@@ -1,33 +1,39 @@
 /* NTPClient.cpp */
-/*
-Copyright (C) 2012 ARM Limited.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-of the Software, and to permit persons to whom the Software is furnished to do
-so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+/* Copyright (C) 2012 mbed.org, MIT License
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge, publish, distribute,
+ * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
+ * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-*/
+//Debug is disabled by default
+#if 
+//Enable debug
+#define __DEBUG__
+#include <cstdio>
+#define DBG(x, ...) std::printf("[NTPClient : DBG]"x"\r\n", ##__VA_ARGS__); 
+#define WARN(x, ...) std::printf("[NTPClient : WARN]"x"\r\n", ##__VA_ARGS__); 
+#define ERR(x, ...) std::printf("[NTPClient : ERR]"x"\r\n", ##__VA_ARGS__); 
 
-#define __DEBUG__ 0 //Disabled
-#ifndef __MODULE__
-#define __MODULE__ "NTPClient.cpp"
+#else
+//Disable debug
+#define DBG(x, ...) 
+#define WARN(x, ...)
+#define ERR(x, ...) 
+
 #endif
 
-#include "core/fwk.h"
-
 #include "NTPClient.h"
 
 #include "UDPSocket.h"
@@ -36,27 +42,27 @@
 
 #define NTP_PORT 123
 #define NTP_CLIENT_PORT 0 //Random port
-#define NTP_REQUEST_TIMEOUT 15000
 #define NTP_TIMESTAMP_DELTA 2208988800ull //Diff btw a UNIX timestamp (Starting Jan, 1st 1970) and a NTP timestamp (Starting Jan, 1st 1900)
 
-NTPClient::NTPClient()
+NTPClient::NTPClient() : m_sock()
 {
 
 
 }
 
-int NTPClient::setTime(const char* host, uint16_t port, uint32_t timeout)
+NTPResult NTPClient::setTime(const char* host, uint16_t port, uint32_t timeout)
 {
-#if __DEBUG__ >= 3
+#ifdef __DEBUG__
   time_t ctTime;
   ctTime = time(NULL);
-  INFO("Time is set to (UTC): %s", ctime(&ctTime));
+  DBG("Time is set to (UTC): %s", ctime(&ctTime));
 #endif
 
   //Create & bind socket
-  DBG("Creating socket");
-  UDPSocket sock;
-  sock.bind(0); //Bind to a random port
+  DBG("Binding socket");
+  m_sock.bind(0); //Bind to a random port
+  
+  m_sock.set_blocking(true, timeout); //Set blocking
 
   struct NTPPacket pkt;
 
@@ -81,41 +87,50 @@
 
   pkt.refTm_f = pkt.origTm_f = pkt.rxTm_f = pkt.txTm_f = 0;
 
+  Endpoint outEndpoint;
+  
+  if( outEndpoint.set_address(host, port) < 0)
+  {
+    m_sock.close();
+    return NTP_DNS;
+  }
+  
   //Set timeout, non-blocking and wait using select
-  if( sock.sendTo( (char*)&pkt, sizeof(NTPPacket), host, port, NTP_REQUEST_TIMEOUT ) < 0 )
+  int ret = m_sock.sendTo( outEndpoint, (char*)&pkt, sizeof(NTPPacket) );
+  if (ret < 0 )
   {
     ERR("Could not send packet");
-    sock.close();
-    return NET_CONN;
+    m_sock.close();
+    return NTP_CONN;
   }
 
   //Read response
+  Endpoint inEndpoint;
+
   DBG("Pong");
-  char* inHost;
-  int inPort;
   do
   {
-    ret = sock.receiveFrom( (char*)&pkt, sizeof(NTPPacket), &inHost, inPort); //FIXME need a DNS Resolver to actually compare the incoming address with the DNS name
+    ret = m_sock.receiveFrom( inEndpoint, (char*)&pkt, sizeof(NTPPacket) ); //FIXME need a DNS Resolver to actually compare the incoming address with the DNS name
     if(ret < 0)
     {
       ERR("Could not receive packet");
-      sock.close();
-      return NET_CONN;
+      m_sock.close();
+      return NTP_CONN;
     }
-  } while( respAddr.sin_addr.s_addr != serverAddr.sin_addr.s_addr);
+  } while( strcmp(outEndpoint.get_address(), inEndpoint.get_address()) != 0 );
 
   if(ret < sizeof(NTPPacket)) //TODO: Accept chunks
   {
     ERR("Receive packet size does not match");
-    sock.close();
-    return NET_PROTOCOL;
+    m_sock.close();
+    return NTP_PRTCL;
   }
 
   if( pkt.stratum == 0)  //Kiss of death message : Not good !
   {
     ERR("Kissed to death!");
-    sock.close();
-    return NTP_PORT;
+    m_sock.close();
+    return NTP_PRTCL;
   }
 
   //Correct Endianness
@@ -132,17 +147,17 @@
   uint32_t destTm_s = (NTP_TIMESTAMP_DELTA + time(NULL));
   int64_t offset = ( (int64_t)( pkt.rxTm_s - pkt.origTm_s ) + (int64_t) ( pkt.txTm_s - destTm_s ) ) / 2; //Avoid overflow
   DBG("Sent @%ul", pkt.txTm_s);
-  DBG("Offset: %ul", offset);
+  DBG("Offset: %lld", offset);
   //Set time accordingly
   set_time( time(NULL) + offset );
 
-#if __DEBUG__ >= 3
+#ifdef __DEBUG__
   ctTime = time(NULL);
-  INFO("Time is now (UTC): %s", ctime(&ctTime));
+  DBG("Time is now (UTC): %s", ctime(&ctTime));
 #endif
 
-  sock.close();
+  m_sock.close();
 
-  return OK;
+  return NTP_OK;
 }
 

--- a/NTPClient.h	Fri Jul 27 08:49:34 2012 +0000
+++ b/NTPClient.h	Sun Aug 05 15:36:47 2012 +0000
@@ -1,34 +1,50 @@
 /* NTPClient.h */
-/*
-Copyright (C) 2012 ARM Limited.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-of the Software, and to permit persons to whom the Software is furnished to do
-so, subject to the following conditions:
+/* Copyright (C) 2012 mbed.org, MIT License
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge, publish, distribute,
+ * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
+ * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+/** \file
+NTP Client header file
 */
 
-#include "core/fwk.h"
-
 #ifndef NTPCLIENT_H_
 #define NTPCLIENT_H_
 
+#include <cstdint>
+
+using std::uint8_t;
+using std::uint16_t;
+using std::uint32_t;
+
+#include "UDPSocket.h"
+
 #define NTP_DEFAULT_PORT 123
 #define NTP_DEFAULT_TIMEOUT 4000
 
+///NTP client results
+enum NTPResult
+{
+  NTP_DNS, ///<Could not resolve name
+  NTP_PRTCL, ///<Protocol error
+  NTP_TIMEOUT, ///<Connection timeout
+  NTP_CONN, ///<Connection error
+  NTP_OK = 0, ///<Success
+};
+
 /** NTP Client to update the mbed's RTC using a remote time server
 *
 */
@@ -46,9 +62,9 @@
   @param host NTP server IPv4 address or hostname (will be resolved via DNS)
   @param port port to use; defaults to 123
   @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
-  @return 0 on success, NET error code (<0) on failure
+  @return 0 on success, NTP error code (<0) on failure
   */
-  int setTime(const char* host, uint16_t port = NTP_DEFAULT_PORT, uint32_t timeout = NTP_DEFAULT_TIMEOUT); //Blocking
+  NTPResult setTime(const char* host, uint16_t port = NTP_DEFAULT_PORT, uint32_t timeout = NTP_DEFAULT_TIMEOUT); //Blocking
 
 private:
   struct NTPPacket //See RFC 4330 for Simple NTP
@@ -77,6 +93,8 @@
     uint32_t txTm_s;
     uint32_t txTm_f;
   } __attribute__ ((packed));
+  
+  UDPSocket m_sock;
 
 };