MbedCloudClientConfig.h

00001 // ----------------------------------------------------------------------------
00002 // Copyright 2016-2017 ARM Ltd.
00003 //
00004 // SPDX-License-Identifier: Apache-2.0
00005 //
00006 // Licensed under the Apache License, Version 2.0 (the "License");
00007 // you may not use this file except in compliance with the License.
00008 // You may obtain a copy of the License at
00009 //
00010 //     http://www.apache.org/licenses/LICENSE-2.0
00011 //
00012 // Unless required by applicable law or agreed to in writing, software
00013 // distributed under the License is distributed on an "AS IS" BASIS,
00014 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00015 // See the License for the specific language governing permissions and
00016 // limitations under the License.
00017 // ----------------------------------------------------------------------------
00018 
00019 #ifndef MBED_CLOUD_CLIENT_CONFIG_H
00020 #define MBED_CLOUD_CLIENT_CONFIG_H
00021 
00022 #include <stdint.h>
00023 
00024 /*! \file MbedCloudClientConfig.h
00025 * \brief Configuration options (set of defines and values).
00026 *
00027 *  This lists a set of compile-time options that needs to be used to enable
00028 *  or disable features selectively, and set the values for the mandatory
00029 *  parameters.
00030 */
00031 
00032 #if defined (__ICCARM__)
00033 #define m2m_deprecated
00034 #else
00035 #define m2m_deprecated __attribute__ ((deprecated))
00036 #endif
00037 
00038 #ifdef __DOXYGEN__
00039 
00040 /**
00041 * \def MBED_CLOUD_CLIENT_ENDPOINT_TYPE
00042 *
00043 * \brief This is mandatory MACRO and MUST be enabled. You MUST define it like this #define MBED_CLOUD_CLIENT_ENDPOINT_TYPE "default".
00044 */
00045 #define MBED_CLOUD_CLIENT_ENDPOINT_TYPE          /* "default" */
00046 
00047 /**
00048 * \def MBED_CLOUD_CLIENT_LIFETIME
00049 *
00050 * \brief This is mandatory MACRO and MUST be enabled. You MUST define it like this: #define MBED_CLOUD_CLIENT_LIFETIME 3600.
00051 * This value denotes time in seconds.
00052 */
00053 #define MBED_CLOUD_CLIENT_LIFETIME               /* 3600 */
00054 
00055 /**
00056 * \def MBED_CLOUD_CLIENT_TRANSPORT_MODE_UDP
00057 *
00058 * \brief Enable this MACRO if you want to enable UDP mode for the client.
00059 */
00060 #define MBED_CLOUD_CLIENT_TRANSPORT_MODE_UDP
00061 
00062 /**
00063 * \def MBED_CLOUD_CLIENT_TRANSPORT_MODE_TCP
00064 *
00065 * \brief Enable this MACRO if you want to enable TCP mode for the client.
00066 */
00067 #define MBED_CLOUD_CLIENT_TRANSPORT_MODE_TCP
00068 
00069 /**
00070 * \def MBED_CLOUD_CLIENT_TRANSPORT_MODE_UDP_QUEUE
00071 *
00072 * \brief Enable this MACRO if you want to enable UDP_QUEUE mode for the client.
00073 */
00074 #define MBED_CLOUD_CLIENT_TRANSPORT_MODE_UDP_QUEUE
00075 
00076 /**
00077 * \def MBED_CLOUD_CLIENT_TRANSPORT_MODE_TCP_QUEUE
00078 *
00079 * \brief Enable this MACRO if you want to enable TCP_QUEUE mode for the client.
00080 */
00081 
00082 #define MBED_CLOUD_CLIENT_TRANSPORT_MODE_TCP_QUEUE
00083 
00084 #endif
00085 
00086 /**
00087 * \def MBED_CLOUD_CLIENT_LISTEN_PORT
00088 *
00089 * \brief This is mandatory MACRO and is set to 0 by default. This implies that the client picks a random port
00090  * for listening to the incoming connection.
00091 */
00092 #define MBED_CLOUD_CLIENT_LISTEN_PORT           0
00093 
00094 #ifdef MBED_CLOUD_CLIENT_USER_CONFIG_FILE
00095 #include MBED_CLOUD_CLIENT_USER_CONFIG_FILE
00096 #endif
00097 
00098 #include "MbedCloudClientConfigCheck.h"
00099 
00100 #endif // MBED_CLOUD_CLIENT_CONFIG_H