net_timeout.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2018 Intel Corporation
 * Copyright (c) 2020 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_NET_TIMEOUT_H_
#define ZEPHYR_INCLUDE_NET_NET_TIMEOUT_H_
 
#include <string.h>
#include <stdbool.h>
#include <limits.h>
#include <zephyr/types.h>
#include <sys/slist.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define NET_TIMEOUT_MAX_VALUE ((uint32_t)INT32_MAX)
 
struct net_timeout {
        sys_snode_t node;
 
        /* Time at which the timer was last set.
         *
         * This usually corresponds to the low 32 bits of k_uptime_get(). */
        uint32_t timer_start;
 
        /* Portion of remaining timeout that does not exceed
         * NET_TIMEOUT_MAX_VALUE.
         *
         * This value is updated in parallel with timer_start and wrap_counter
         * by net_timeout_evaluate().
         */
        uint32_t timer_timeout;
 
        /* Timer wrap count.
         *
         * This tracks multiples of NET_TIMEOUT_MAX_VALUE milliseconds that
         * have yet to pass.  It is also updated along with timer_start and
         * wrap_counter by net_timeout_evaluate().
         */
        uint32_t wrap_counter;
};
 
void net_timeout_set(struct net_timeout *timeout,
                     uint32_t lifetime,
                     uint32_t now);
 
int64_t net_timeout_deadline(const struct net_timeout *timeout,
                             int64_t now);
 
uint32_t net_timeout_remaining(const struct net_timeout *timeout,
                               uint32_t now);
 
uint32_t net_timeout_evaluate(struct net_timeout *timeout,
                              uint32_t now);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_NET_NET_TIMEOUT_H_ */