Network Services API  1.11.00.10
sntp.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013-2016, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  * */
32 /*
33  * ======== sntp.h ========
34  */
232 #ifndef ti_net_sntp_SNTP__include
233 #define ti_net_sntp_SNTP__include
234 
237 #include <xdc/std.h>
238 
239 #include <ti/net/socket.h>
240 
241 #ifdef __cplusplus
242 extern "C" {
243 #endif
244 
245 /*
246  * ======== SNTP_start ========
247  */
288 extern int SNTP_start(uint32_t (*get)(void), void (*set)(uint32_t newtime),
289  void (*timeUpdatedHook)(void *), struct sockaddr *servers,
290  unsigned int numservers, size_t stacksize);
291 
292 /*
293  * ======== SNTP_stop ========
294  */
307 extern void SNTP_stop(void);
308 
309 /*
310  * ======== SNTP_setServers ========
311  */
325 extern void SNTP_setServers(struct sockaddr *servers, unsigned int numservers);
326 
327 /*
328  * ======== SNTP_forceTimeSync ========
329  */
343 extern void SNTP_forceTimeSync(void);
344 
346 #ifdef __cplusplus
347 }
348 #endif
349 
350 #endif
int SNTP_start(uint32_t(*get)(void), void(*set)(uint32_t newtime), void(*timeUpdatedHook)(void *), struct sockaddr *servers, unsigned int numservers, size_t stacksize)
Initialize and start the SNTP client Task.
void SNTP_stop(void)
Stops the SNTP client Task and frees resources used by the module.
void SNTP_forceTimeSync(void)
Force SNTP client to get the time from a configured NTP server.
void SNTP_setServers(struct sockaddr *servers, unsigned int numservers)
Updates the list of NTP servers to communicate with.
Copyright 2016, Texas Instruments Incorporated