sntp_client.h

Go to the documentation of this file.

 
#ifndef _SNTP_CLIENT_H
#define _SNTP_CLIENT_H
 
//Dependencies
#include "core/net.h"
#include "sntp/ntp_common.h"
 
//SNTP client support
#ifndef SNTP_CLIENT_SUPPORT
   #define SNTP_CLIENT_SUPPORT ENABLED
#elif (SNTP_CLIENT_SUPPORT != ENABLED && SNTP_CLIENT_SUPPORT != DISABLED)
   #error SNTP_CLIENT_SUPPORT parameter is not valid
#endif
 
//Default timeout
#ifndef SNTP_CLIENT_DEFAULT_TIMEOUT
   #define SNTP_CLIENT_DEFAULT_TIMEOUT 30000
#elif (SNTP_CLIENT_DEFAULT_TIMEOUT < 1000)
   #error SNTP_CLIENT_DEFAULT_TIMEOUT parameter is not valid
#endif
 
//Initial retransmission timeout
#ifndef SNTP_CLIENT_INIT_RETRANSMIT_TIMEOUT
   #define SNTP_CLIENT_INIT_RETRANSMIT_TIMEOUT 2000
#elif (SNTP_CLIENT_INIT_RETRANSMIT_TIMEOUT < 1000)
   #error SNTP_CLIENT_INIT_RETRANSMIT_TIMEOUT parameter is not valid
#endif
 
//Maximum retransmission timeout
#ifndef SNTP_CLIENT_MAX_RETRANSMIT_TIMEOUT
   #define SNTP_CLIENT_MAX_RETRANSMIT_TIMEOUT 15000
#elif (SNTP_CLIENT_MAX_RETRANSMIT_TIMEOUT < 1000)
   #error SNTP_CLIENT_MAX_RETRANSMIT_TIMEOUT parameter is not valid
#endif
 
//Application specific context
#ifndef SNTP_CLIENT_PRIVATE_CONTEXT
   #define SNTP_CLIENT_PRIVATE_CONTEXT
#endif
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
 
typedef enum
{
   SNTP_CLIENT_STATE_INIT      = 0,
   SNTP_CLIENT_STATE_SENDING   = 2,
   SNTP_CLIENT_STATE_RECEIVING = 3,
   SNTP_CLIENT_STATE_COMPLETE  = 4
} SntpClientState;
 
 
typedef struct
{
   SntpClientState state;             
   NetInterface *interface;           
   IpAddr serverIpAddr;               
   uint16_t serverPort;               
   systime_t timeout;                 
   Socket *socket;                    
   systime_t startTime;               
   systime_t retransmitStartTime;     
   systime_t retransmitTimeout;       
   uint8_t message[NTP_MAX_MSG_SIZE]; 
   size_t messageLen;                 
   uint32_t kissCode;                 
   SNTP_CLIENT_PRIVATE_CONTEXT        
} SntpClientContext;
 
 
//SNTP client related functions
error_t sntpClientInit(SntpClientContext *context);
 
error_t sntpClientSetTimeout(SntpClientContext *context, systime_t timeout);
 
error_t sntpClientBindToInterface(SntpClientContext *context,
   NetInterface *interface);
 
error_t sntpClientSetServerAddr(SntpClientContext *context,
   const IpAddr *serverIpAddr, uint16_t serverPort);
 
error_t sntpClientGetTimestamp(SntpClientContext *context,
   NtpTimestamp *timestamp);
 
uint32_t sntpClientGetKissCode(SntpClientContext *context);
 
void sntpClientDeinit(SntpClientContext *context);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif