• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  *  Copyright (c) 2019, The OpenThread Authors.
3  *  All rights reserved.
4  *
5  *  Redistribution and use in source and binary forms, with or without
6  *  modification, are permitted provided that the following conditions are met:
7  *  1. Redistributions of source code must retain the above copyright
8  *     notice, this list of conditions and the following disclaimer.
9  *  2. Redistributions in binary form must reproduce the above copyright
10  *     notice, this list of conditions and the following disclaimer in the
11  *     documentation and/or other materials provided with the distribution.
12  *  3. Neither the name of the copyright holder nor the
13  *     names of its contributors may be used to endorse or promote products
14  *     derived from this software without specific prior written permission.
15  *
16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  *  POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /**
30  * @file
31  *   This file includes compile-time configurations for CoAP.
32  */
33 
34 #ifndef CONFIG_COAP_H_
35 #define CONFIG_COAP_H_
36 
37 /**
38  * @addtogroup config-coap
39  *
40  * @brief
41  *   This module includes configuration variables for CoAP.
42  *
43  * @{
44  */
45 
46 /**
47  * @def OPENTHREAD_CONFIG_COAP_SERVER_MAX_CACHED_RESPONSES
48  *
49  * Maximum number of cached responses for CoAP Confirmable messages.
50  *
51  * Cached responses are used for message deduplication.
52  */
53 #ifndef OPENTHREAD_CONFIG_COAP_SERVER_MAX_CACHED_RESPONSES
54 #define OPENTHREAD_CONFIG_COAP_SERVER_MAX_CACHED_RESPONSES 10
55 #endif
56 
57 /**
58  * @def OPENTHREAD_CONFIG_COAP_API_ENABLE
59  *
60  * Define to 1 to enable the CoAP API.
61  */
62 #ifndef OPENTHREAD_CONFIG_COAP_API_ENABLE
63 #define OPENTHREAD_CONFIG_COAP_API_ENABLE 0
64 #endif
65 
66 /**
67  * @def OPENTHREAD_CONFIG_COAP_OBSERVE_API_ENABLE
68  *
69  * Define to 1 to enable the CoAP Observe (RFC7641) API.
70  */
71 #ifndef OPENTHREAD_CONFIG_COAP_OBSERVE_API_ENABLE
72 #define OPENTHREAD_CONFIG_COAP_OBSERVE_API_ENABLE 0
73 #endif
74 
75 /**
76  * @def OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE
77  *
78  * Define to 1 to enable the CoAP Block-Wise Transfer.
79  */
80 #ifndef OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE
81 #define OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE 0
82 #endif
83 
84 /**
85  * @def OPENTHREAD_CONFIG_COAP_MAX_BLOCK_LENGTH
86  *
87  * This setting configures the maximum length of one block during a CoAP Block-Wise Transfer.
88  */
89 #ifndef OPENTHREAD_CONFIG_COAP_MAX_BLOCK_LENGTH
90 #define OPENTHREAD_CONFIG_COAP_MAX_BLOCK_LENGTH 1024
91 #endif
92 
93 /**
94  * @def OPENTHREAD_CONFIG_COAP_SECURE_API_ENABLE
95  *
96  * Define to 1 to enable the CoAP Secure API.
97  */
98 #ifndef OPENTHREAD_CONFIG_COAP_SECURE_API_ENABLE
99 #define OPENTHREAD_CONFIG_COAP_SECURE_API_ENABLE 0
100 #endif
101 
102 /**
103  * @}
104  */
105 
106 #endif // CONFIG_COAP_H_
107