tor/src/common/timers.h

/* Copyright (c) 2016-2017, The Tor Project, Inc. */
/* See LICENSE for licensing information */

#ifndef TOR_TIMERS_H
#define TOR_TIMERS_H

#include "orconfig.h"
#include "testsupport.h"

struct monotime_t;
typedef struct timeout tor_timer_t;
typedef void (*timer_cb_fn_t)(tor_timer_t *, void *,
                              const struct monotime_t *);
tor_timer_t *timer_new(timer_cb_fn_t cb, void *arg);
void timer_set_cb(tor_timer_t *t, timer_cb_fn_t cb, void *arg);
void timer_get_cb(const tor_timer_t *t,
                  timer_cb_fn_t *cb_out, void **arg_out);
void timer_schedule(tor_timer_t *t, const struct timeval *delay);
void timer_disable(tor_timer_t *t);
void timer_free_(tor_timer_t *t);
#define timer_free(t) FREE_AND_NULL(tor_timer_t, timer_free_, (t))

void timers_initialize(void);
void timers_shutdown(void);

#ifdef TOR_TIMERS_PRIVATE
STATIC void timers_run_pending(void);
#endif

#endif /* !defined(TOR_TIMERS_H) */
Run the copyright update script. 2017-03-15 21:13:17 +01:00			`/* Copyright (c) 2016-2017, The Tor Project, Inc. */`
Add wrappers to tie the new timeouts into libevent. 2016-04-13 17:11:35 +02:00			`/* See LICENSE for licensing information */`

			`#ifndef TOR_TIMERS_H`
			`#define TOR_TIMERS_H`

			`#include "orconfig.h"`
			`#include "testsupport.h"`

convert timers.c to use real monotonic time. 2016-07-08 20:38:02 +02:00			`struct monotime_t;`
Add wrappers to tie the new timeouts into libevent. 2016-04-13 17:11:35 +02:00			`typedef struct timeout tor_timer_t;`
Keep make check-spaces happy 2016-07-29 07:05:12 +02:00			`typedef void (timer_cb_fn_t)(tor_timer_t , void *,`
			`const struct monotime_t *);`
Add wrappers to tie the new timeouts into libevent. 2016-04-13 17:11:35 +02:00			`tor_timer_t timer_new(timer_cb_fn_t cb, void arg);`
			`void timer_set_cb(tor_timer_t t, timer_cb_fn_t cb, void arg);`
Add accessor for inspecting timer callbacks. 2016-12-02 18:15:07 +01:00			`void timer_get_cb(const tor_timer_t *t,`
			`timer_cb_fn_t cb_out, void *arg_out);`
Add wrappers to tie the new timeouts into libevent. 2016-04-13 17:11:35 +02:00			`void timer_schedule(tor_timer_t t, const struct timeval delay);`
			`void timer_disable(tor_timer_t *t);`
Convert the rest of src/common's headers to use FREE_AND_NULL 2017-11-17 18:27:25 +01:00			`void timer_free_(tor_timer_t *t);`
Replace all FREE_AND_NULL* uses to take a type and a free function. This commit was made mechanically by this perl script: \#!/usr/bin/perl -w -i -p next if /^#define FREE_AND_NULL/; s/\bFREE_AND_NULL\((\w+),/FREE_AND_NULL\(${1}_t, ${1}_free_,/; s/\bFREE_AND_NULL_UNMATCHED\(/FREE_AND_NULL\(/; 2017-12-07 16:44:04 +01:00			`#define timer_free(t) FREE_AND_NULL(tor_timer_t, timer_free_, (t))`
Add wrappers to tie the new timeouts into libevent. 2016-04-13 17:11:35 +02:00
			`void timers_initialize(void);`
			`void timers_shutdown(void);`

Extract the important parts of the run-pending-timers function. Our unit tests will need this, so that they can simulate advancing time without getting libevent involved. 2017-09-11 19:48:39 +02:00			`#ifdef TOR_TIMERS_PRIVATE`
			`STATIC void timers_run_pending(void);`
			`#endif`

Run our #else/#endif annotator on our source code. 2017-09-15 22:24:44 +02:00			`#endif /* !defined(TOR_TIMERS_H) */`
Add wrappers to tie the new timeouts into libevent. 2016-04-13 17:11:35 +02:00