Skip to content

Commit

Permalink
gnrc_sixlowpan_frag_rb: fix doc on DO_NOT_OVERRIDE
Browse files Browse the repository at this point in the history
  • Loading branch information
miri64 committed Feb 3, 2020
1 parent d929087 commit 90ed5bf
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
12 changes: 6 additions & 6 deletions sys/include/net/gnrc/sixlowpan/config.h
Expand Up @@ -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
Expand Down
12 changes: 6 additions & 6 deletions sys/net/gnrc/network_layer/sixlowpan/frag/rb/Kconfig
Expand Up @@ -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"
Expand Down

0 comments on commit 90ed5bf

Please sign in to comment.