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  * Copyright (C) 2010-2018 Oryx Embedded SARL. All rights reserved.
8  *
9  * This file is part of CycloneTCP Open.
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version 2
14  * of the License, or (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24  *
25  * @author Oryx Embedded SARL (www.oryx-embedded.com)
26  * @version 1.9.0
27  **/
28 
29 #ifndef _COAP_DEBUG_H
30 #define _COAP_DEBUG_H
31 
32 //Dependencies
33 #include "core/net.h"
34 #include "coap/coap_common.h"
35 
36 //C++ guard
37 #ifdef __cplusplus
38  extern "C" {
39 #endif
40 
41 
42 /**
43  * @brief CoAP value/string binding
44  **/
45 
46 typedef struct
47 {
48  uint8_t value;
49  const char_t *name;
51 
52 
53 //CoAP related functions
54 error_t coapDumpMessage(const void *message, size_t length);
55 error_t coapDumpMessageHeader(const uint8_t *p, size_t length, size_t *consumed);
56 error_t coapDumpOptions(const uint8_t *p, size_t length, size_t *consumed);
57 error_t coapDumpOption(const CoapOption *option);
58 
60  const CoapParamDesc *paramList, size_t paramListLen);
61 
62 //C++ guard
63 #ifdef __cplusplus
64  }
65 #endif
66 
67 #endif
char char_t
Definition: compiler_port.h:41
const char_t * name
Definition: coap_debug.h:49
TCP/IP stack core.
CoAP value/string binding.
Definition: coap_debug.h:46
error_t coapDumpOption(const CoapOption *option)
Dump CoAP option.
Definition: coap_debug.c:287
uint8_t p
Definition: ndp.h:295
uint8_t message[]
Definition: chap.h:150
error_t coapDumpOptions(const uint8_t *p, size_t length, size_t *consumed)
Dump the list of CoAP options.
Definition: coap_debug.c:233
Definitions common to CoAP client and server.
const char_t * coapGetParamName(uint_t value, const CoapParamDesc *paramList, size_t paramListLen)
Convert a parameter to string representation.
Definition: coap_debug.c:399
error_t coapDumpMessage(const void *message, size_t length)
Dump CoAP message for debugging purpose.
Definition: coap_debug.c:121
error_t coapDumpMessageHeader(const uint8_t *p, size_t length, size_t *consumed)
Dump CoAP message header.
Definition: coap_debug.c:181
error_t
Error codes.
Definition: error.h:40
unsigned int uint_t
Definition: compiler_port.h:43
uint8_t value[]
Definition: dtls_misc.h:141
CoAP option.
Definition: coap_option.h:173
uint8_t length
Definition: dtls_misc.h:140
uint8_t value
Definition: coap_debug.h:48