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 will disable this feature, and also reduce use of ROM memory
00043  * Note: This define is common for both received and sent Blockwise messages
00044  */
00045 #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
00046 
00047 /**
00048  * \def COAP_DISABLE_OBS_FEATURE
00049  *
00050  * \brief Disables CoAP 'obs' sending feature
00051  * as part of registration message, this might be
00052  * needed to be enabled for some strict LWM2M server implementation.
00053  * By default, this feature is disabled.
00054  */
00055 #undef COAP_DISABLE_OBS_FEATURE
00056 
00057 /**
00058  * \def SN_COAP_DISABLE_RESENDINGS
00059  *
00060  * \brief Disables resending feature. Resending feature should not be needed
00061  * when using CoAP with TCP transport for example. By default resendings are
00062  * enabled. Set to 1 to disable.
00063  */
00064 #undef SN_COAP_DISABLE_RESENDINGS          /* 0 */ // < Default re-sending are not disabled. Set to 1 to disable re-sendings
00065 
00066 /**
00067  * \def SN_COAP_RESENDING_QUEUE_SIZE_MSGS
00068  *
00069  * \brief Sets the number of messages stored
00070  * in the resending queue. Default is 2
00071  */
00072 #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
00073 
00074 /**
00075  * \def SN_COAP_RESENDING_QUEUE_SIZE_BYTES
00076  *
00077  * \brief Sets the size of the re-sending buffer.
00078  * Setting this to 0 disables this feature.
00079  * By default, this feature is disabled.
00080  */
00081 #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
00082 
00083 /**
00084  * \def SN_COAP_MAX_INCOMING_MESSAGE_SIZE
00085  *
00086  * \brief Sets the maximum size (in bytes) that
00087  * mbed Client will allow to be handled while
00088  * receiving big payload in blockwise mode.
00089  * Application can set this value based on their
00090  * available storage capability.
00091  * By default, maximum size is UINT16_MAX, 65535 bytes.
00092  */
00093 #undef SN_COAP_MAX_INCOMING_MESSAGE_SIZE    /* UINT16_MAX */
00094 
00095 #ifdef MBED_CLIENT_USER_CONFIG_FILE
00096 #include MBED_CLIENT_USER_CONFIG_FILE
00097 #endif
00098 
00099 #endif // SN_CONFIG_H