RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-01-18 12:52:44 +01:00
Code Releases Activity

doc: gnrc_netreg: add doc on gnrc_netreg_type_t enumerators

Browse Source
This commit is contained in:
Martine Lenders 2017-06-26 10:19:47 +02:00
parent 5e0150c3ad
commit 6f299f9ac7
No known key found for this signature in database
GPG Key ID: 8E97A9FE55F25D62
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
sys/include/net/gnrc/netreg.h
View File

@ -43,11 +43,30 @@ extern "C" {
* Different types are availalbe dependent on the used modules.
*/
typedef enum {
/**
* @brief Use [default IPC](@ref core_msg) for
* [netapi](@ref net_gnrc_netapi) operations.
*
* @note Implicitly chosen without `gnrc_netapi_mbox` and
* `gnrc_netapi_callbacks` modules.
*/
GNRC_NETREG_TYPE_DEFAULT = 0,
#if defined(MODULE_GNRC_NETAPI_MBOX) || defined(DOXYGEN)
/**
* @brief Use [centralized IPC](@ref core_mbox) for
* [netapi](@ref net_gnrc_netapi) operations.
*
* @note Only available with `gnrc_netapi_mbox` module.
*/
GNRC_NETREG_TYPE_MBOX,
#endif
#if defined(MODULE_GNRC_NETAPI_CALLBACKS) || defined(DOXYGEN)
/**
* @brief Use function callbacks for [netapi](@ref net_gnrc_netapi)
* operations.
*
* @note Only available with `gnrc_netapi_callbacks` module.
*/
GNRC_NETREG_TYPE_CB,
#endif
} gnrc_netreg_type_t;