sn_config.h

00001 /*
00002  * Copyright (c) 2016 ARM Limited. All rights reserved.
00003  * SPDX-License-Identifier: Apache-2.0
00004  * Licensed under the Apache License, Version 2.0 (the License); you may
00005  * not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  * http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an AS IS BASIS, WITHOUT
00012  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 
00017 #ifndef SN_CONFIG_H
00018 #define SN_CONFIG_H
00019 
00020 /**
00021 * \brief Configuration options (set of defines and values)
00022 *
00023 *  This lists set of compile-time options that needs to be used to enable
00024 *  or disable features selectively, and set the values for the mandatory
00025 *  parameters.
00026 */
00027 
00028 /**
00029  * \def SN_COAP_DUPLICATION_MAX_MSGS_COUNT
00030  * \brief For Message duplication detection
00031  * Init value for the maximum count of messages to be stored for duplication detection
00032  * Setting of this value to 0 will disable duplication check, also reduce use of ROM memory
00033  * Default is set to 1.
00034  */
00035 #undef SN_COAP_DUPLICATION_MAX_MSGS_COUNT   /* 1 */
00036 
00037 /**
00038  * \def SN_COAP_MAX_BLOCKWISE_PAYLOAD_SIZE
00039  *
00040  * \brief For Message blockwising
00041  * Init value for the maximum payload size to be sent and received at one blockwise message
00042  * Setting of this value to 0 with SN_COAP_BLOCKWISE_ENABLED will disable this feature, and
00043  * also reduce use of ROM memory.
00044  * Note: This define is common for both received and sent Blockwise messages
00045  */
00046 #undef SN_COAP_MAX_BLOCKWISE_PAYLOAD_SIZE   /* 0 */ // < Must be 2^x and x is at least 4. Suitable values: 0, 16, 32, 64, 128, 256, 512 and 1024
00047 
00048 /**
00049  * \def COAP_DISABLE_OBS_FEATURE
00050  *
00051  * \brief Disables CoAP 'obs' sending feature
00052  * as part of registration message, this might be
00053  * needed to be enabled for some strict LWM2M server implementation.
00054  * By default, this feature is disabled.
00055  */
00056 #undef COAP_DISABLE_OBS_FEATURE
00057 
00058 /**
00059  * \def SN_COAP_DISABLE_RESENDINGS
00060  *
00061  * \brief Disables resending feature. Resending feature should not be needed
00062  * when using CoAP with TCP transport for example. By default resendings are
00063  * enabled. Set to 1 to disable.
00064  */
00065 #undef SN_COAP_DISABLE_RESENDINGS          /* 0 */ // < Default re-sending are not disabled. Set to 1 to disable re-sendings
00066 
00067 /**
00068  * \def SN_COAP_RESENDING_QUEUE_SIZE_MSGS
00069  *
00070  * \brief Sets the number of messages stored
00071  * in the resending queue. Default is 2
00072  */
00073 #undef SN_COAP_RESENDING_QUEUE_SIZE_MSGS    /* 2  */ // < Default re-sending queue size - defines how many messages can be stored. Setting this to 0 disables feature
00074 
00075 /**
00076  * \def SN_COAP_RESENDING_QUEUE_SIZE_BYTES
00077  *
00078  * \brief Sets the size of the re-sending buffer.
00079  * Setting this to 0 disables this feature.
00080  * By default, this feature is disabled.
00081  */
00082 #undef SN_COAP_RESENDING_QUEUE_SIZE_BYTES   /* 0  */ // Default re-sending queue size - defines size of the re-sending buffer. Setting this to 0 disables feature
00083 
00084 /**
00085  * \def SN_COAP_MAX_INCOMING_MESSAGE_SIZE
00086  *
00087  * \brief Sets the maximum size (in bytes) that
00088  * mbed Client will allow to be handled while
00089  * receiving big payload in blockwise mode.
00090  * Application can set this value based on their
00091  * available storage capability.
00092  * By default, maximum size is UINT16_MAX, 65535 bytes.
00093  */
00094 #undef SN_COAP_MAX_INCOMING_MESSAGE_SIZE    /* UINT16_MAX */
00095 
00096 /**
00097  * \def SN_COAP_MAX_NONBLOCKWISE_PAYLOAD_SIZE
00098  * \brief Sets the maximum payload size allowed before blockwising the message.
00099  * This option should only be used when using TCP and TLS as transport
00100  * with known maximum fragment size. This optimizes the number of messages
00101  * if it is possible to send larger than 1kB messages without blockwise transfer.
00102  * If payload length is larger than SN_COAP_MAX_NONBLOCKWISE_PAYLOAD_SIZE
00103  * it will be sent using blockwise transfer.
00104  * By default, this feature is disabled, 0 disables the feature, set to positive
00105  * value larger than SN_COAP_MAX_BLOCKWISE_PAYLOAD_SIZE to enable.
00106  * Note that value should be less than transport layer maximum fragment size.
00107  * Note that value has no effect if blockwise transfer is disabled.
00108  */
00109 #undef SN_COAP_MAX_NONBLOCKWISE_PAYLOAD_SIZE        /* 0 */
00110 
00111 /**
00112  * \def SN_COAP_BLOCKWISE_ENABLED
00113  * \brief Enables the blockwise functionality in CoAP library also when blockwise payload
00114  * size is set to '0' in  SN_COAP_MAX_BLOCKWISE_PAYLOAD_SIZE.
00115  */
00116 #undef SN_COAP_BLOCKWISE_ENABLED                    /* 0 */
00117 
00118 #ifdef MBED_CLIENT_USER_CONFIG_FILE
00119 #include MBED_CLIENT_USER_CONFIG_FILE
00120 #endif
00121 
00122 #endif // SN_CONFIG_H