nts_debug.h File Reference

Data logging functions for debugging purpose (NTS) More...

#include "core/net.h"
#include "nts/nts_common.h"
#include "debug.h"

Go to the source code of this file.

Data Structures
struct	NtsParamName
	Parameter value/name binding. More...

Functions
void	ntsDumpNtsKeRecords (const uint8_t *records, size_t length)
	Dump NTS-KE records. More...
void	ntsDumpNtsKeRecord (const NtsKeRecord *record, size_t length)
	Dump NTS-KE record. More...
void	ntsDumpNtsNextProtoNegoRecord (const uint8_t *body, size_t length)
	Dump NTS Next Protocol Negotiation record. More...
void	ntsDumpAeadAlgoNegoRecord (const uint8_t *body, size_t length)
	Dump AEAD Algorithm Negotiation record. More...
void	ntsDumpNtpv4ServerNegoRecord (const uint8_t *body, size_t length)
	Dump NTPv4 Server Negotiation record. More...
void	ntsDumpNtpv4PortNegoRecord (const uint8_t *body, size_t length)
	Dump NTPv4 Port Negotiation record. More...
void	ntsDumpErrorRecord (const uint8_t *body, size_t length)
	Dump Error record. More...
void	ntsDumpWarningRecord (const uint8_t *body, size_t length)
	Dump Warning record. More...
const char_t *	ntsGetParamName (uint_t value, const NtsParamName *paramList, size_t paramListLen)
	Convert a parameter to string representation. More...

Detailed Description

Data logging functions for debugging purpose (NTS)

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author

Oryx Embedded SARL (www.oryx-embedded.com)

Version

2.4.4

Definition in file nts_debug.h.

Function Documentation

ntsDumpAeadAlgoNegoRecord()

void ntsDumpAeadAlgoNegoRecord	(	const uint8_t *	body,
		size_t	length
	)

Dump AEAD Algorithm Negotiation record.

Parameters

[in]	body	Pointer to the record body
[in]	length	Length of the record body, in bytes

Definition at line 286 of file nts_debug.c.

ntsDumpErrorRecord()

void ntsDumpErrorRecord	(	const uint8_t *	body,
		size_t	length
	)

Dump Error record.

Parameters

[in]	body	Pointer to the record body
[in]	length	Length of the record body, in bytes

Definition at line 233 of file nts_debug.c.

ntsDumpNtpv4PortNegoRecord()

void ntsDumpNtpv4PortNegoRecord	(	const uint8_t *	body,
		size_t	length
	)

Dump NTPv4 Port Negotiation record.

Parameters

[in]	body	Pointer to the record body
[in]	length	Length of the record body, in bytes

Definition at line 341 of file nts_debug.c.

ntsDumpNtpv4ServerNegoRecord()

void ntsDumpNtpv4ServerNegoRecord	(	const uint8_t *	body,
		size_t	length
	)

Dump NTPv4 Server Negotiation record.

Parameters

[in]	body	Pointer to the record body
[in]	length	Length of the record body, in bytes

Definition at line 315 of file nts_debug.c.

ntsDumpNtsKeRecord()

void ntsDumpNtsKeRecord	(	const NtsKeRecord *	record,
		size_t	length
	)

Dump NTS-KE record.

Parameters

[in]	record	Pointer to the record
[in]	length	Length of the record, in bytes

Definition at line 121 of file nts_debug.c.

ntsDumpNtsKeRecords()

void ntsDumpNtsKeRecords	(	const uint8_t *	records,
		size_t	length
	)

Dump NTS-KE records.

Parameters

[in]	records	Pointer to the records
[in]	length	Total length of the records, in bytes

Definition at line 83 of file nts_debug.c.

ntsDumpNtsNextProtoNegoRecord()

void ntsDumpNtsNextProtoNegoRecord	(	const uint8_t *	body,
		size_t	length
	)

Dump NTS Next Protocol Negotiation record.

Parameters

[in]	body	Pointer to the record body
[in]	length	Length of the record body, in bytes

Definition at line 204 of file nts_debug.c.

ntsDumpWarningRecord()

void ntsDumpWarningRecord	(	const uint8_t *	body,
		size_t	length
	)

Dump Warning record.

Parameters

[in]	body	Pointer to the record body
[in]	length	Length of the record body, in bytes

Definition at line 262 of file nts_debug.c.

ntsGetParamName()

const char_t* ntsGetParamName	(	uint_t	value,
		const NtsParamName *	paramList,
		size_t	paramListLen
	)

Convert a parameter to string representation.

Parameters

[in]	value	Parameter value
[in]	paramList	List of acceptable parameters
[in]	paramListLen	Number of entries in the list

Returns

NULL-terminated string describing the parameter

Definition at line 366 of file nts_debug.c.