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

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.