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