coap_debug.h File Reference

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

#include "core/net.h"
#include "coap/coap_common.h"

Go to the source code of this file.

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

Functions
error_t	coapDumpMessage (const void *message, size_t length)
	Dump CoAP message for debugging purpose. More...
error_t	coapDumpMessageHeader (const uint8_t *p, size_t length, size_t *consumed)
	Dump CoAP message header. More...
error_t	coapDumpOptions (const uint8_t *p, size_t length, size_t *consumed)
	Dump the list of CoAP options. More...
error_t	coapDumpOption (const CoapOption *option)
	Dump CoAP option. More...
const char_t *	coapGetParamName (uint_t value, const CoapParamName *paramList, size_t paramListLen)
	Convert a parameter to string representation. More...

Detailed Description

Data logging functions for debugging purpose (CoAP)

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.0

Definition in file coap_debug.h.

Function Documentation

coapDumpMessage()

error_t coapDumpMessage	(	const void *	message,
		size_t	length
	)

Dump CoAP message for debugging purpose.

Parameters

[in]	message	Pointer to the CoAP message
[in]	length	Length of the message, in bytes

Returns

Error code

Definition at line 122 of file coap_debug.c.

coapDumpMessageHeader()

error_t coapDumpMessageHeader	(	const uint8_t *	p,
		size_t	length,
		size_t *	consumed
	)

Dump CoAP message header.

Parameters

[in]	p	Input stream where to read the CoAP message header
[in]	length	Number of bytes available in the input stream
[out]	consumed	Total number of bytes that have been consumed

Returns

Error code

Definition at line 182 of file coap_debug.c.

coapDumpOption()

error_t coapDumpOption

(

const CoapOption *

option

)

Dump CoAP option.

Parameters

[out]

option

CoAP option content

Returns

Error code

Definition at line 288 of file coap_debug.c.

coapDumpOptions()

error_t coapDumpOptions	(	const uint8_t *	p,
		size_t	length,
		size_t *	consumed
	)

Dump the list of CoAP options.

Parameters

[in]	p	Input stream where to read the CoAP options
[in]	length	Number of bytes available in the input stream
[out]	consumed	Total number of bytes that have been consumed

Returns

Error code

Definition at line 234 of file coap_debug.c.

coapGetParamName()

const char_t* coapGetParamName	(	uint_t	value,
		const CoapParamName *	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 402 of file coap_debug.c.