Macros
Serval_Defines.h File Reference

Essential configurations of the library. More...

Macros

#define SERVAL_ENABLE_COAP   1
 
#define SERVAL_ENABLE_DTLS   1
 
#define SERVAL_ENABLE_GENERIC_AUTHORIZATION   0
 
#define SERVAL_ENABLE_HTTP   1
 
#define SERVAL_ENABLE_MQTT   0
 
#define SERVAL_ENABLE_PROFILING   0
 
#define SERVAL_ENABLE_RESOURCE_MONITOR   1
 
#define SERVAL_ENABLE_REST   1
 
#define SERVAL_ENABLE_SERIALIZER   ( SERVAL_ENABLE_DPWS || SERVAL_ENABLE_WEBSERVER )
 
#define SERVAL_ENABLE_SNTP_CLIENT   0
 
#define SERVAL_ENABLE_STACK_SPY   0
 
#define SERVAL_ENABLE_TCP   ( SERVAL_ENABLE_HTTP || SERVAL_ENABLE_MQTT || SERVAL_ENABLE_WS || SERVAL_ENABLE_XTCP )
 
#define SERVAL_ENABLE_TLS   0
 
#define SERVAL_ENABLE_UDP   ( SERVAL_ENABLE_COAP || SERVAL_ENABLE_DPWS || SERVAL_ENABLE_SNTP_CLIENT || SERVAL_ENABLE_XUDP )
 
#define SERVAL_ENABLE_WS   0
 
#define SERVAL_ENABLE_WS_CLIENT   0
 
#define SERVAL_MACRO_VALUE(x)   SERVAL_MACRO_VALUE_AUX(x)
 
#define SERVAL_MACRO_VALUE_AUX(x)   #x
 
#define SERVAL_RESOURCE_MONITOR_PERIODE   1000
 

Detailed Description

This header contains the essential configurations which the user can use to customize the settings and resources of the library.

Macro Definition Documentation

#define SERVAL_ENABLE_COAP   1
#define SERVAL_ENABLE_DTLS   1
#define SERVAL_ENABLE_GENERIC_AUTHORIZATION   0

Generic authorization framework. Useful for cross-layer authentication and authorization.

Slightly increases the size of a message by MAX(sizeof(uint16_t), sizeof(void*))

#define SERVAL_ENABLE_HTTP   1
#define SERVAL_ENABLE_MQTT   0

Enable ''SERVAL_ENABLE_MQTT'' in order to enable support for the MQTT protocol (client-only).

Since
1.9
#define SERVAL_ENABLE_PROFILING   0

Enable ''SERVAL_ENABLE_PROFILING'' in order to enable the code related to the time and energy measurement.

#define SERVAL_ENABLE_RESOURCE_MONITOR   1

Switch on/off resource monitoring at all. If set to zero all subsequent settings for monitoring are disabled and monitor is even not compiled into the stack.

#define SERVAL_ENABLE_REST   1
#define SERVAL_ENABLE_SERIALIZER   ( SERVAL_ENABLE_DPWS || SERVAL_ENABLE_WEBSERVER )
#define SERVAL_ENABLE_SNTP_CLIENT   0

Enable ''SERVAL_ENABLE_SNTP'' in order to enable support for the SNTP protocol.

#define SERVAL_ENABLE_STACK_SPY   0

Enable ''SERVAL_ENABLE_STACK_SPY'' in order to enable the stack spy code.

#define SERVAL_ENABLE_TCP   ( SERVAL_ENABLE_HTTP || SERVAL_ENABLE_MQTT || SERVAL_ENABLE_WS || SERVAL_ENABLE_XTCP )
#define SERVAL_ENABLE_TLS   0
#define SERVAL_ENABLE_UDP   ( SERVAL_ENABLE_COAP || SERVAL_ENABLE_DPWS || SERVAL_ENABLE_SNTP_CLIENT || SERVAL_ENABLE_XUDP )
#define SERVAL_ENABLE_WS   0
#define SERVAL_ENABLE_WS_CLIENT   0

Enable SERVAL_ENABLE_WS_CLIENT in order to enable the websocket protocol (WS) Code/Feature

#define SERVAL_MACRO_VALUE (   x)    SERVAL_MACRO_VALUE_AUX(x)
#define SERVAL_MACRO_VALUE_AUX (   x)    #x
#define SERVAL_RESOURCE_MONITOR_PERIODE   1000

define the time period for the callbacks in of Resource monitor in milliseconds. It must be a value between 200 and 60.000


This documentation file has been automatically generated on Fri Oct 4 2019 03:47:20 by doxygen 1.8.8