Jim Carver / Mbed OS mbed-cloud-workshop-connect

Fork for workshops

simple-mbed-cloud-client/mbed-cloud-client/mbed-cloud-client/MbedCloudClientConfig.h@0:6b753f761943, 2018-10-12 (annotated)

Committer:
JimCarver
Date:
Fri Oct 12 21:22:49 2018 +0000
Revision:
0:6b753f761943
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
JimCarver 0:6b753f761943 1 // ----------------------------------------------------------------------------
JimCarver 0:6b753f761943 2 // Copyright 2016-2017 ARM Ltd.
JimCarver 0:6b753f761943 3 //
JimCarver 0:6b753f761943 4 // SPDX-License-Identifier: Apache-2.0
JimCarver 0:6b753f761943 5 //
JimCarver 0:6b753f761943 6 // Licensed under the Apache License, Version 2.0 (the "License");
JimCarver 0:6b753f761943 7 // you may not use this file except in compliance with the License.
JimCarver 0:6b753f761943 8 // You may obtain a copy of the License at
JimCarver 0:6b753f761943 9 //
JimCarver 0:6b753f761943 10 // http://www.apache.org/licenses/LICENSE-2.0
JimCarver 0:6b753f761943 11 //
JimCarver 0:6b753f761943 12 // Unless required by applicable law or agreed to in writing, software
JimCarver 0:6b753f761943 13 // distributed under the License is distributed on an "AS IS" BASIS,
JimCarver 0:6b753f761943 14 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
JimCarver 0:6b753f761943 15 // See the License for the specific language governing permissions and
JimCarver 0:6b753f761943 16 // limitations under the License.
JimCarver 0:6b753f761943 17 // ----------------------------------------------------------------------------
JimCarver 0:6b753f761943 18
JimCarver 0:6b753f761943 19 #ifndef MBED_CLOUD_CLIENT_CONFIG_H
JimCarver 0:6b753f761943 20 #define MBED_CLOUD_CLIENT_CONFIG_H
JimCarver 0:6b753f761943 21
JimCarver 0:6b753f761943 22 #include <stdint.h>
JimCarver 0:6b753f761943 23
JimCarver 0:6b753f761943 24 /*! \file MbedCloudClientConfig.h
JimCarver 0:6b753f761943 25 * \brief Configuration options (set of defines and values).
JimCarver 0:6b753f761943 26 *
JimCarver 0:6b753f761943 27 * This lists a set of compile-time options that needs to be used to enable
JimCarver 0:6b753f761943 28 * or disable features selectively, and set the values for the mandatory
JimCarver 0:6b753f761943 29 * parameters.
JimCarver 0:6b753f761943 30 */
JimCarver 0:6b753f761943 31
JimCarver 0:6b753f761943 32 #if defined (__ICCARM__)
JimCarver 0:6b753f761943 33 #define m2m_deprecated
JimCarver 0:6b753f761943 34 #else
JimCarver 0:6b753f761943 35 #define m2m_deprecated __attribute__ ((deprecated))
JimCarver 0:6b753f761943 36 #endif
JimCarver 0:6b753f761943 37
JimCarver 0:6b753f761943 38 #ifdef __DOXYGEN__
JimCarver 0:6b753f761943 39
JimCarver 0:6b753f761943 40 /**
JimCarver 0:6b753f761943 41 * \def MBED_CLOUD_CLIENT_ENDPOINT_TYPE
JimCarver 0:6b753f761943 42 *
JimCarver 0:6b753f761943 43 * \brief This is mandatory MACRO and MUST be enabled. You MUST define it like this #define MBED_CLOUD_CLIENT_ENDPOINT_TYPE "default".
JimCarver 0:6b753f761943 44 */
JimCarver 0:6b753f761943 45 #define MBED_CLOUD_CLIENT_ENDPOINT_TYPE /* "default" */
JimCarver 0:6b753f761943 46
JimCarver 0:6b753f761943 47 /**
JimCarver 0:6b753f761943 48 * \def MBED_CLOUD_CLIENT_LIFETIME
JimCarver 0:6b753f761943 49 *
JimCarver 0:6b753f761943 50 * \brief This is mandatory MACRO and MUST be enabled. You MUST define it like this: #define MBED_CLOUD_CLIENT_LIFETIME 3600.
JimCarver 0:6b753f761943 51 * This value denotes time in seconds.
JimCarver 0:6b753f761943 52 */
JimCarver 0:6b753f761943 53 #define MBED_CLOUD_CLIENT_LIFETIME /* 3600 */
JimCarver 0:6b753f761943 54
JimCarver 0:6b753f761943 55 /**
JimCarver 0:6b753f761943 56 * \def MBED_CLOUD_CLIENT_TRANSPORT_MODE_UDP
JimCarver 0:6b753f761943 57 *
JimCarver 0:6b753f761943 58 * \brief Enable this MACRO if you want to enable UDP mode for the client.
JimCarver 0:6b753f761943 59 */
JimCarver 0:6b753f761943 60 #define MBED_CLOUD_CLIENT_TRANSPORT_MODE_UDP
JimCarver 0:6b753f761943 61
JimCarver 0:6b753f761943 62 /**
JimCarver 0:6b753f761943 63 * \def MBED_CLOUD_CLIENT_TRANSPORT_MODE_TCP
JimCarver 0:6b753f761943 64 *
JimCarver 0:6b753f761943 65 * \brief Enable this MACRO if you want to enable TCP mode for the client.
JimCarver 0:6b753f761943 66 */
JimCarver 0:6b753f761943 67 #define MBED_CLOUD_CLIENT_TRANSPORT_MODE_TCP
JimCarver 0:6b753f761943 68
JimCarver 0:6b753f761943 69 /**
JimCarver 0:6b753f761943 70 * \def MBED_CLOUD_CLIENT_TRANSPORT_MODE_UDP_QUEUE
JimCarver 0:6b753f761943 71 *
JimCarver 0:6b753f761943 72 * \brief Enable this MACRO if you want to enable UDP_QUEUE mode for the client.
JimCarver 0:6b753f761943 73 */
JimCarver 0:6b753f761943 74 #define MBED_CLOUD_CLIENT_TRANSPORT_MODE_UDP_QUEUE
JimCarver 0:6b753f761943 75
JimCarver 0:6b753f761943 76 /**
JimCarver 0:6b753f761943 77 * \def MBED_CLOUD_CLIENT_TRANSPORT_MODE_TCP_QUEUE
JimCarver 0:6b753f761943 78 *
JimCarver 0:6b753f761943 79 * \brief Enable this MACRO if you want to enable TCP_QUEUE mode for the client.
JimCarver 0:6b753f761943 80 */
JimCarver 0:6b753f761943 81
JimCarver 0:6b753f761943 82 #define MBED_CLOUD_CLIENT_TRANSPORT_MODE_TCP_QUEUE
JimCarver 0:6b753f761943 83
JimCarver 0:6b753f761943 84 #endif
JimCarver 0:6b753f761943 85
JimCarver 0:6b753f761943 86 /**
JimCarver 0:6b753f761943 87 * \def MBED_CLOUD_CLIENT_LISTEN_PORT
JimCarver 0:6b753f761943 88 *
JimCarver 0:6b753f761943 89 * \brief This is mandatory MACRO and is set to 0 by default. This implies that the client picks a random port
JimCarver 0:6b753f761943 90 * for listening to the incoming connection.
JimCarver 0:6b753f761943 91 */
JimCarver 0:6b753f761943 92 #define MBED_CLOUD_CLIENT_LISTEN_PORT 0
JimCarver 0:6b753f761943 93
JimCarver 0:6b753f761943 94 #ifdef MBED_CLOUD_CLIENT_USER_CONFIG_FILE
JimCarver 0:6b753f761943 95 #include MBED_CLOUD_CLIENT_USER_CONFIG_FILE
JimCarver 0:6b753f761943 96 #endif
JimCarver 0:6b753f761943 97
JimCarver 0:6b753f761943 98 #include "MbedCloudClientConfigCheck.h"
JimCarver 0:6b753f761943 99
JimCarver 0:6b753f761943 100 #endif // MBED_CLOUD_CLIENT_CONFIG_H