RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

net/fib: changed the fib_table_t doxy to be a bit more informative

Browse Source
This commit is contained in:
BytesGalore 2015-11-02 09:09:53 +01:00
parent a6df5e7426
commit 24c48181b9
1 changed files with 27 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
sys/include/net/fib/table.h
View File

@ -103,19 +103,36 @@ typedef struct fib_sr_meta_t {
#define FIB_TABLE_TYPE_SR (FIB_TABLE_TYPE_SH + 1) #define FIB_TABLE_TYPE_SR (FIB_TABLE_TYPE_SH + 1)
/** /**
* @brief Meta information about the FIB table * @brief Meta information of a FIB table
*/ */
typedef struct { typedef struct {
/** A single hop OR source route data array */
union{ union{
fib_entry_t *entries; /**< array holding the FIB entries */ /** array holding the FIB entries for single hops */
fib_sr_meta_t *source_routes; /**< array holding the FIB source routes */ fib_entry_t *entries;
/** array holding the FIB entries for source routes */
fib_sr_meta_t *source_routes;
}data; }data;
uint8_t table_type; /**< the table kind SR or single hop */ /** the kind of this FIB table, single hop or source route.
size_t size; /**< number of entries in this table */ * This value indicates what is stored in `data` of this table
mutex_t mtx_access; /** access mutex to control exclusive operations on calls */ */
size_t notify_rp_pos; /** registered RPs for notifications about unreachable destinations */ uint8_t table_type;
kernel_pid_t notify_rp[FIB_MAX_REGISTERED_RP]; /** the kernel_pid_t for notifying the RPs */ /** the maximim number of entries in this FIB table */
universal_address_container_t* prefix_rp[FIB_MAX_REGISTERED_RP]; /** prefix handled by the RP */ size_t size;
/** table access mutex to grant exclusive operations on calls */
mutex_t mtx_access;
/** current number of registered RPs. */
size_t notify_rp_pos;
/** the kernel_pid_t of the registered RPs.
* Used to notify the RPs by the FIB on certain conditions,
* e.g. when a destination is unreachable
*/
kernel_pid_t notify_rp[FIB_MAX_REGISTERED_RP];
/** the prefix handled by each registered RP.
* Used to dispatch if the RP is responsible for the condition,
* e.g. when the unreachable destination is covered by the prefix
*/
universal_address_container_t* prefix_rp[FIB_MAX_REGISTERED_RP];
} fib_table_t; } fib_table_t;
#ifdef __cplusplus #ifdef __cplusplus