sntp.h

00001 /**
00002  * @file
00003  * SNTP client API
00004  */
00005 
00006 /*
00007  * Copyright (c) 2007-2009 Frédéric Bernon, Simon Goldschmidt
00008  * All rights reserved.
00009  *
00010  * Redistribution and use in source and binary forms, with or without modification,
00011  * are permitted provided that the following conditions are met:
00012  *
00013  * 1. Redistributions of source code must retain the above copyright notice,
00014  *    this list of conditions and the following disclaimer.
00015  * 2. Redistributions in binary form must reproduce the above copyright notice,
00016  *    this list of conditions and the following disclaimer in the documentation
00017  *    and/or other materials provided with the distribution.
00018  * 3. The name of the author may not be used to endorse or promote products
00019  *    derived from this software without specific prior written permission.
00020  *
00021  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
00022  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
00023  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
00024  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00025  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
00026  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00027  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00028  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
00029  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
00030  * OF SUCH DAMAGE.
00031  *
00032  * This file is part of the lwIP TCP/IP stack.
00033  *
00034  * Author: Frédéric Bernon, Simon Goldschmidt
00035  *
00036  */
00037 #ifndef LWIP_HDR_APPS_SNTP_H
00038 #define LWIP_HDR_APPS_SNTP_H
00039 
00040 #include "lwip/apps/sntp_opts.h"
00041 #include "lwip/ip_addr.h"
00042 
00043 #ifdef __cplusplus
00044 extern "C" {
00045 #endif
00046 
00047 /* SNTP operating modes: default is to poll using unicast.
00048    The mode has to be set before calling sntp_init(). */
00049 #define SNTP_OPMODE_POLL            0
00050 #define SNTP_OPMODE_LISTENONLY      1
00051 void sntp_setoperatingmode(u8_t operating_mode);
00052 u8_t sntp_getoperatingmode(void);
00053 
00054 void sntp_init(void);
00055 void sntp_stop(void);
00056 u8_t sntp_enabled(void);
00057 
00058 void sntp_setserver(u8_t idx, const ip_addr_t *addr);
00059 const ip_addr_t* sntp_getserver(u8_t idx);
00060 
00061 #if SNTP_MONITOR_SERVER_REACHABILITY
00062 u8_t sntp_getreachability(u8_t idx);
00063 #endif /* SNTP_MONITOR_SERVER_REACHABILITY */
00064 
00065 #if SNTP_SERVER_DNS
00066 void sntp_setservername(u8_t idx, const char *server);
00067 const char *sntp_getservername(u8_t idx);
00068 #endif /* SNTP_SERVER_DNS */
00069 
00070 #if SNTP_GET_SERVERS_FROM_DHCP
00071 void sntp_servermode_dhcp(int set_servers_from_dhcp);
00072 #else /* SNTP_GET_SERVERS_FROM_DHCP */
00073 #define sntp_servermode_dhcp(x)
00074 #endif /* SNTP_GET_SERVERS_FROM_DHCP */
00075 
00076 #ifdef __cplusplus
00077 }
00078 #endif
00079 
00080 #endif /* LWIP_HDR_APPS_SNTP_H */