MbedCloudClientConfig.h File Reference

Configuration options (set of defines and values). More...

#include <stdint.h>
#include "mbed-client/m2mconfig.h"
#include "MbedCloudClientConfigCheck.h"

Go to the source code of this file.

Macros
#define	MBED_CLOUD_CLIENT_ENDPOINT_TYPE   "default"
	This is an optional MACRO. You can define it like this #define MBED_CLOUD_CLIENT_ENDPOINT_TYPE "default".
#define	MBED_CLOUD_CLIENT_PROFILE_FULL   1
#define	MBED_CLOUD_CLIENT_PROFILE_LITE   2
#define	MBED_CLOUD_CLIENT_PROFILE   MBED_CLOUD_CLIENT_PROFILE_FULL
#define	MBED_CLOUD_CLIENT_LIFETIME   86400
	This is optional MACRO. You can define it like this: #define MBED_CLOUD_CLIENT_LIFETIME 86400. This value denotes time in seconds.
#define	MBED_CLOUD_CLIENT_TRANSPORT_MODE_UDP
	Enable this MACRO if you want to enable UDP mode for the client.
#define	MBED_CLOUD_CLIENT_TRANSPORT_MODE_TCP
	Enable this MACRO if you want to enable TCP mode for the client. This is the default for client.
#define	MBED_CLOUD_CLIENT_TRANSPORT_MODE_UDP_QUEUE
	Enable this MACRO if you want to enable UDP_QUEUE mode for the client.
#define	MBED_CLOUD_CLIENT_STL_API   0
	This flag controls the API's which use C++'s Standard Template Library (STL). The cost of STL is ~15KB of flash, depending on compiler, so on resource constrained devices it is essential to be able to remove any reference to it. In practice the SimpleM2MResourceString and SimpleM2MResourceInt classes are build with STL, so if one is not using them and wants to save RAM and ROM, setting this define to zero may help quite a lot. The SimpleM2MResource* classes and related API's are marked as deprecated, so they may be removed in the future releases.
#define	MBED_CLOUD_CLIENT_STD_NAMESPACE_POLLUTION   0
	This causes a inclusion of "MbedCloudCLient.h to "pollute" the namespace with "using namespace std;". This has been always the case, but any library should not pollute application's namespace with std by having the "using std" in a a public header file. But as as removal of it from our headers may break existing applications, which build due to this leakage, we need to maintain the old behavior for a while and just allow one to remove it.
#define	MBED_CLOUD_CLIENT_LISTEN_PORT   0
	This is mandatory MACRO and is set to 0 by default. This implies that the client picks a random port for listening to the incoming connection.

Detailed Description

Configuration options (set of defines and values).

This lists a set of compile-time options that needs to be used to enable or disable features selectively, and set the values for the mandatory parameters.