1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-24 22:13:52 +01:00

gnrc_sixlowpan_frag_rb: fix doc on DO_NOT_OVERRIDE

This commit is contained in:
Martine S. Lenders 2020-01-30 17:04:18 +01:00
parent d929087e57
commit 90ed5bf4af
No known key found for this signature in database
GPG Key ID: CCD317364F63286F
2 changed files with 12 additions and 12 deletions

View File

@ -83,16 +83,16 @@ extern "C" {
#endif
/**
* @brief Keep all but oldest fragment when reassembly buffer is full
* @brief Do not override oldest datagram when reassembly buffer is full
*
* @note Only applicable with
* [gnrc_sixlowpan_frag_rb](@ref net_gnrc_sixlowpan_frag_rb) module
*
* When not set, it will cause the reassembly buffer to override the oldest entry
* if a new entry has to be created and the reassembly buffer is full, no matter what.
* When set to 1, only incomplete entries that are older than
* @ref CONFIG_GNRC_SIXLOWPAN_FRAG_RBUF_TIMEOUT_US will be overwritten (they will still
* timeout normally).
* When not set, it will cause the reassembly buffer to override the oldest
* entry when a fragment for a new datagram is received. When set, only the
* oldest entry that is older than @ref
* CONFIG_GNRC_SIXLOWPAN_FRAG_RBUF_TIMEOUT_US will be overwritten (they will
* still timeout normally if reassembly buffer is not full).
*/
#ifdef DOXYGEN
#define CONFIG_GNRC_SIXLOWPAN_FRAG_RBUF_DO_NOT_OVERRIDE

View File

@ -21,13 +21,13 @@ config GNRC_SIXLOWPAN_FRAG_RBUF_TIMEOUT_US
default 3000000
config GNRC_SIXLOWPAN_FRAG_RBUF_DO_NOT_OVERRIDE
bool "Keep all but oldest fragment when reassembly buffer is full"
bool "Do not override oldest datagram when reassembly buffer is full"
help
When not set, it will cause the reassembly buffer to
override the oldest entry no matter what. When set, only the oldest
entry that is older than @ref CONFIG_GNRC_SIXLOWPAN_FRAG_RBUF_TIMEOUT_US
will be overwritten (they will still timeout normally if reassembly
buffer is not full).
When not set, it will cause the reassembly buffer to override the oldest
entry when a fragment for a new datagram is received. When set, only the
oldest entry that is older than @ref
CONFIG_GNRC_SIXLOWPAN_FRAG_RBUF_TIMEOUT_US will be overwritten (they
will still timeout normally if reassembly buffer is not full).
config GNRC_SIXLOWPAN_FRAG_RBUF_DEL_TIMER
int "Deletion timer for reassembly buffer entries in microseconds"