sntp_client_misc.h
Go to the documentation of this file.
1 /**
2  * @file sntp_client.h
3  * @brief Helper functions for SNTP client
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2019 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneTCP Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 1.9.2
29  **/
30 
31 #ifndef _SNTP_CLIENT_MISC_H
32 #define _SNTP_CLIENT_MISC_H
33 
34 //Dependencies
35 #include "core/net.h"
36 #include "sntp/sntp_client.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40  extern "C" {
41 #endif
42 
43 //SNTP client related functions
46 
49 
51  const IpAddr *ipAddr, uint16_t port, const uint8_t *message,
52  size_t length);
53 
55  NtpTimestamp *timestamp);
56 
58 
59 void sntpClientDumpMessage(const uint8_t *message, size_t length);
60 void sntpClientDumpTimestamp(const NtpTimestamp *timestamp);
61 
62 //C++ guard
63 #ifdef __cplusplus
64  }
65 #endif
66 
67 #endif
SNTP client context.
Definition: sntp_client.h:89
error_t sntpClientCheckTimeout(SntpClientContext *context)
Determine whether a timeout error has occurred.
TCP/IP stack core.
error_t sntpClientParseResponse(SntpClientContext *context, NtpTimestamp *timestamp)
Parse NTP server's response.
SNTP client (Simple Network Time Protocol)
uint8_t message[]
Definition: chap.h:152
void sntpClientDumpMessage(const uint8_t *message, size_t length)
Dump NTP message for debugging purpose.
IP network address.
Definition: ip.h:59
uint8_t ipAddr[4]
Definition: mib_common.h:187
void sntpClientDumpTimestamp(const NtpTimestamp *timestamp)
Dump NTP timestamp.
error_t sntpClientOpenConnection(SntpClientContext *context)
Open UDP connection.
error_t
Error codes.
Definition: error.h:42
void sntpClientCloseConnection(SntpClientContext *context)
Close UDP connection.
uint16_t port
Definition: dns_common.h:223
error_t sntpClientSendRequest(SntpClientContext *context)
Send request to the NTP server.
error_t sntpClientReceiveResponse(SntpClientContext *context)
Wait for NTP server's response.
uint8_t length
Definition: dtls_misc.h:142
error_t sntpClientCheckResponse(SntpClientContext *context, const IpAddr *ipAddr, uint16_t port, const uint8_t *message, size_t length)
Check whether the NTP response is valid.
__start_packed struct @296 NtpTimestamp
NTP timestamp representation.