Document new native platform defines

This commit is contained in:
Laurent Deru 2017-12-22 11:22:38 +01:00
parent 9fe252d107
commit d0ca150a38
1 changed files with 20 additions and 0 deletions

View File

@ -70,23 +70,43 @@
#define LOG_MODULE "Native" #define LOG_MODULE "Native"
#define LOG_LEVEL LOG_LEVEL_MAIN #define LOG_LEVEL LOG_LEVEL_MAIN
/*---------------------------------------------------------------------------*/
/**
* \name Native Platform Configuration
*
* @{
*/
/*
* Defines the maximum number of file descriptors monitored by the platform
* main loop.
*/
#ifdef SELECT_CONF_MAX #ifdef SELECT_CONF_MAX
#define SELECT_MAX SELECT_CONF_MAX #define SELECT_MAX SELECT_CONF_MAX
#else #else
#define SELECT_MAX 8 #define SELECT_MAX 8
#endif #endif
/*
* Defines the timeout (in msec) of the select operation if no monitored file
* descriptors becomes ready.
*/
#ifdef SELECT_CONF_TIMEOUT #ifdef SELECT_CONF_TIMEOUT
#define SELECT_TIMEOUT SELECT_CONF_TIMEOUT #define SELECT_TIMEOUT SELECT_CONF_TIMEOUT
#else #else
#define SELECT_TIMEOUT 1000 #define SELECT_TIMEOUT 1000
#endif #endif
/*
* Adds the STDIN file descriptor to the list of monitored file descriptors.
*/
#ifdef SELECT_CONF_STDIN #ifdef SELECT_CONF_STDIN
#define SELECT_STDIN SELECT_CONF_STDIN #define SELECT_STDIN SELECT_CONF_STDIN
#else #else
#define SELECT_STDIN 1 #define SELECT_STDIN 1
#endif #endif
/** @} */
/*---------------------------------------------------------------------------*/
static const struct select_callback *select_callback[SELECT_MAX]; static const struct select_callback *select_callback[SELECT_MAX];
static int select_max = 0; static int select_max = 0;