Classification of function categories of the Network DS Component.
More...
Classification of function categories of the Network DS Component.
The API functions of the Network DS Component are classified into several function categories:
- [thread-safe] functions can be called from different threads without any harm. They are either re-entrant or internally protected from re-entering. Internal protection is usually achieved using RTOS mutexes.
- [not_thread-safe] functions cannot be used from different threads. It is allowed to be used from the same thread, in which the Network DS Core super-loop is running.
- [user-provided] functions need to be provided by the programmer. Some of user-provided functions are optional, others are mandatory. If an optional function is not provided, a default function from the Network DS library is used. Mandatory user-provided functions do not exist in the Network DS library. They have to be provided by the user if required in the application.
- [interface] functions are connecting to a different Middleware component (for example the File System). All interface functions are tagged as weak, so they can be replaced with an application specific implementation if required (for example if a different file system is to be used). Usually, the default functions are sufficient for proper operation.