coap_debug.h
Go to the documentation of this file.
1 /**
2  * @file coap_debug.h
3  * @brief Data logging functions for debugging purpose (CoAP)
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.6
29  **/
30 
31 #ifndef _COAP_DEBUG_H
32 #define _COAP_DEBUG_H
33 
34 //Dependencies
35 #include "core/net.h"
36 #include "coap/coap_common.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 
44 /**
45  * @brief CoAP value/string binding
46  **/
47 
48 typedef struct
49 {
50  uint8_t value;
51  const char_t *name;
53 
54 
55 //CoAP related functions
56 error_t coapDumpMessage(const void *message, size_t length);
57 error_t coapDumpMessageHeader(const uint8_t *p, size_t length, size_t *consumed);
58 error_t coapDumpOptions(const uint8_t *p, size_t length, size_t *consumed);
59 error_t coapDumpOption(const CoapOption *option);
60 
62  const CoapParamDesc *paramList, size_t paramListLen);
63 
64 //C++ guard
65 #ifdef __cplusplus
66 }
67 #endif
68 
69 #endif
const char_t * coapGetParamName(uint_t value, const CoapParamDesc *paramList, size_t paramListLen)
Convert a parameter to string representation.
Definition: coap_debug.c:401
uint8_t length
Definition: dtls_misc.h:149
uint8_t p
Definition: ndp.h:298
error_t coapDumpMessageHeader(const uint8_t *p, size_t length, size_t *consumed)
Dump CoAP message header.
Definition: coap_debug.c:183
error_t coapDumpOptions(const uint8_t *p, size_t length, size_t *consumed)
Dump the list of CoAP options.
Definition: coap_debug.c:235
error_t
Error codes.
Definition: error.h:42
uint8_t value
Definition: coap_debug.h:50
error_t coapDumpMessage(const void *message, size_t length)
Dump CoAP message for debugging purpose.
Definition: coap_debug.c:123
const char_t * name
Definition: coap_debug.h:51
char char_t
Definition: compiler_port.h:43
CoAP value/string binding.
Definition: coap_debug.h:48
uint8_t message[]
Definition: chap.h:152
error_t coapDumpOption(const CoapOption *option)
Dump CoAP option.
Definition: coap_debug.c:289
CoAP option.
Definition: coap_option.h:175
uint8_t value[]
Definition: dtls_misc.h:150
unsigned int uint_t
Definition: compiler_port.h:45
TCP/IP stack core.
Definitions common to CoAP client and server.