xref: /nrf52832-nimble/rt-thread/components/net/lwip-2.1.0/src/include/lwip/apps/sntp.h (revision 104654410c56c573564690304ae786df310c91fc)
1*10465441SEvalZero /**
2*10465441SEvalZero  * @file
3*10465441SEvalZero  * SNTP client API
4*10465441SEvalZero  */
5*10465441SEvalZero 
6*10465441SEvalZero /*
7*10465441SEvalZero  * Copyright (c) 2007-2009 Frédéric Bernon, Simon Goldschmidt
8*10465441SEvalZero  * All rights reserved.
9*10465441SEvalZero  *
10*10465441SEvalZero  * Redistribution and use in source and binary forms, with or without modification,
11*10465441SEvalZero  * are permitted provided that the following conditions are met:
12*10465441SEvalZero  *
13*10465441SEvalZero  * 1. Redistributions of source code must retain the above copyright notice,
14*10465441SEvalZero  *    this list of conditions and the following disclaimer.
15*10465441SEvalZero  * 2. Redistributions in binary form must reproduce the above copyright notice,
16*10465441SEvalZero  *    this list of conditions and the following disclaimer in the documentation
17*10465441SEvalZero  *    and/or other materials provided with the distribution.
18*10465441SEvalZero  * 3. The name of the author may not be used to endorse or promote products
19*10465441SEvalZero  *    derived from this software without specific prior written permission.
20*10465441SEvalZero  *
21*10465441SEvalZero  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
22*10465441SEvalZero  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
23*10465441SEvalZero  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
24*10465441SEvalZero  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25*10465441SEvalZero  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
26*10465441SEvalZero  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27*10465441SEvalZero  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28*10465441SEvalZero  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
29*10465441SEvalZero  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
30*10465441SEvalZero  * OF SUCH DAMAGE.
31*10465441SEvalZero  *
32*10465441SEvalZero  * This file is part of the lwIP TCP/IP stack.
33*10465441SEvalZero  *
34*10465441SEvalZero  * Author: Frédéric Bernon, Simon Goldschmidt
35*10465441SEvalZero  *
36*10465441SEvalZero  */
37*10465441SEvalZero #ifndef LWIP_HDR_APPS_SNTP_H
38*10465441SEvalZero #define LWIP_HDR_APPS_SNTP_H
39*10465441SEvalZero 
40*10465441SEvalZero #include "lwip/apps/sntp_opts.h"
41*10465441SEvalZero #include "lwip/ip_addr.h"
42*10465441SEvalZero 
43*10465441SEvalZero #ifdef __cplusplus
44*10465441SEvalZero extern "C" {
45*10465441SEvalZero #endif
46*10465441SEvalZero 
47*10465441SEvalZero /* SNTP operating modes: default is to poll using unicast.
48*10465441SEvalZero    The mode has to be set before calling sntp_init(). */
49*10465441SEvalZero #define SNTP_OPMODE_POLL            0
50*10465441SEvalZero #define SNTP_OPMODE_LISTENONLY      1
51*10465441SEvalZero void sntp_setoperatingmode(u8_t operating_mode);
52*10465441SEvalZero u8_t sntp_getoperatingmode(void);
53*10465441SEvalZero 
54*10465441SEvalZero void sntp_init(void);
55*10465441SEvalZero void sntp_stop(void);
56*10465441SEvalZero u8_t sntp_enabled(void);
57*10465441SEvalZero 
58*10465441SEvalZero void sntp_setserver(u8_t idx, const ip_addr_t *addr);
59*10465441SEvalZero const ip_addr_t* sntp_getserver(u8_t idx);
60*10465441SEvalZero 
61*10465441SEvalZero #if SNTP_MONITOR_SERVER_REACHABILITY
62*10465441SEvalZero u8_t sntp_getreachability(u8_t idx);
63*10465441SEvalZero #endif /* SNTP_MONITOR_SERVER_REACHABILITY */
64*10465441SEvalZero 
65*10465441SEvalZero #if SNTP_SERVER_DNS
66*10465441SEvalZero void sntp_setservername(u8_t idx, const char *server);
67*10465441SEvalZero const char *sntp_getservername(u8_t idx);
68*10465441SEvalZero #endif /* SNTP_SERVER_DNS */
69*10465441SEvalZero 
70*10465441SEvalZero #if SNTP_GET_SERVERS_FROM_DHCP
71*10465441SEvalZero void sntp_servermode_dhcp(int set_servers_from_dhcp);
72*10465441SEvalZero #else /* SNTP_GET_SERVERS_FROM_DHCP */
73*10465441SEvalZero #define sntp_servermode_dhcp(x)
74*10465441SEvalZero #endif /* SNTP_GET_SERVERS_FROM_DHCP */
75*10465441SEvalZero 
76*10465441SEvalZero #ifdef __cplusplus
77*10465441SEvalZero }
78*10465441SEvalZero #endif
79*10465441SEvalZero 
80*10465441SEvalZero #endif /* LWIP_HDR_APPS_SNTP_H */
81