timeout.h

Go to the documentation of this file.

/*
 * Copyright (C) 2017 Inria
 *               2017 Freie Universität Berlin
 *               2017 Kaspar Schleiser <kaspar@schleiser.de>
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#pragma once

 
#include "event.h"
#include "ztimer.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct {
    ztimer_clock_t *clock;  
    ztimer_t timer;         
    event_queue_t *queue;   
    event_t *event;         
} event_timeout_t;

void event_timeout_ztimer_init(event_timeout_t *event_timeout, ztimer_clock_t *clock,
                               event_queue_t *queue, event_t *event);
 
#if IS_USED(MODULE_EVENT_TIMEOUT) || DOXYGEN
void event_timeout_init(event_timeout_t *event_timeout, event_queue_t *queue,
                        event_t *event);
#endif

void event_timeout_set(event_timeout_t *event_timeout, uint32_t timeout);

void event_timeout_clear(event_timeout_t *event_timeout);

static inline bool event_timeout_is_pending(const event_timeout_t *event_timeout)
{
    if (event_timeout->clock == NULL || event_timeout->queue == NULL ||
        event_timeout->event == NULL) {
        return false;
    }
 
    return ztimer_is_set(event_timeout->clock, &event_timeout->timer)
        || event_is_queued(event_timeout->queue, event_timeout->event);
}
 
#ifdef __cplusplus
}
#endif