neighbor.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2017 Koen Zandberg <koen@bergzand.net>
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <string.h>
#include "net/netif.h"
#include "timex.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    NETSTATS_NB_SUCCESS = 0,    
    NETSTATS_NB_NOACK,          
    NETSTATS_NB_BUSY,           
} netstats_nb_result_t;


#define NETSTATS_NB_EWMA_SCALE            100

#define NETSTATS_NB_EWMA_ALPHA             15

#define NETSTATS_NB_EWMA_ALPHA_RAMP        30

#define NETSTATS_NB_ETX_NOACK_PENALTY       6
#define NETSTATS_NB_ETX_DIVISOR           128
#define NETSTATS_NB_ETX_INIT                2

#define NETSTATS_NB_FRESHNESS_HALF        600
#define NETSTATS_NB_FRESHNESS_TARGET        4
#define NETSTATS_NB_FRESHNESS_MAX          16
#define NETSTATS_NB_FRESHNESS_EXPIRATION 1200
#define NETSTATS_NB_TX_TIMEOUT_MS         100

void netstats_nb_init(netif_t *netif);

bool netstats_nb_get(netif_t *netif, const uint8_t *l2_addr, uint8_t len, netstats_nb_t *out);

void netstats_nb_record(netif_t *netif, const uint8_t *l2_addr, uint8_t len);

netstats_nb_t *netstats_nb_update_tx(netif_t *netif, netstats_nb_result_t result,
                                     uint8_t transmissions);

netstats_nb_t *netstats_nb_update_rx(netif_t *netif, const uint8_t *l2_addr,
                                     uint8_t l2_addr_len, uint8_t rssi, uint8_t lqi);

bool netstats_nb_isfresh(netif_t *netif, netstats_nb_t *stats);
 
#ifdef __cplusplus
}
#endif