/* timing machinery
 * Copyright (C) 1998-2001,2013  D. Hugh Redelmeier.
 * Copyright (C) 2005-2008 Michael Richardson <mcr@xelerance.com>
 * Copyright (C) 2012 Paul Wouters <paul@libreswan.org>
 * Copyright (C) 2013 Matt Rogers <mrogers@redhat.com>
 * Copyright (C) 2017-2019 Andrew Cagney <cagney@gnu.org>
 * Copyright (C) 2019 Paul Wouters <pwouters@redhat.com>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.  See <https://www.gnu.org/licenses/gpl2.txt>.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details.
 */

#ifndef _TIMER_H
#define _TIMER_H

#include "deltatime.h"
#include "monotime.h"
#include "where.h"

struct state;   /* forward declaration */
struct fd;
struct logger;
struct show;

struct state_event {
	enum event_type ev_type;        /* Event type if time based */
	struct state *ev_state;     	/* Pointer to relevant state (if any) */
	struct timeout *timeout;	/* Underlying timer */
	monotime_t ev_epoch;		/* it was scheduled ... */
	deltatime_t ev_delay;		/* ... with the delay ... */
	monotime_t ev_time;		/* ... so should happen after ...*/
};

void state_event_sort(const struct state_event **events, unsigned nr_events);

extern void event_schedule_where(enum event_type type, deltatime_t delay,
				 struct state *st, where_t where);
#define event_schedule(TYPE, DELAY, ST) event_schedule_where(TYPE, DELAY, ST, HERE)

void event_delete_where(enum event_type type, struct state *st, where_t where);
#define event_delete(TYPE, ST) event_delete_where(TYPE, ST, HERE)
void delete_state_event(struct state_event **evp, where_t where);

struct state_event **state_event_slot(struct state *st, enum event_type type);
extern void event_force(enum event_type type, struct state *st);

extern void delete_event(struct state *st);

void whack_impair_call_state_event_handler(struct logger *logger, struct state *st,
					   enum event_type type, bool detach_whack);

extern void list_timers(struct show *s, const monotime_t now);
extern char *revive_conn;

/*
 * Since global timers (one-shot or periodic) rely on global state
 * they don't need a context parameter.
 *
 * The logger provided to a global timer may contain a whackfd (when
 * triggered from whack).
 *
 * XXX: implementation can be found in server.c and not timer.c as it
 * is just easier.
 */

typedef void (global_timer_cb)(struct logger *logger);
void enable_periodic_timer(enum global_timer type, global_timer_cb *cb,
			   deltatime_t period);

void init_oneshot_timer(enum global_timer type, global_timer_cb *cb);
void schedule_oneshot_timer(enum global_timer type, deltatime_t delay);
void deschedule_oneshot_timer(enum global_timer type);

#endif /* _TIMER_H */
