Gecko [ paxlifestyle.com ]

Name	Size	Permission	Date
aes.h	979 B	-rw-r--r--	2025-01-20 13:39
align.h	608 B	-rw-r--r--	2025-01-20 13:39
app.h	6.98 KB	-rw-r--r--	2025-01-20 13:39
assertions.h	2.3 KB	-rw-r--r--	2025-01-20 13:39
astack.h	1.15 KB	-rw-r--r--	2025-01-20 13:39
atomic.h	3.05 KB	-rw-r--r--	2025-01-20 13:39
attributes.h	2.89 KB	-rw-r--r--	2025-01-20 13:39
backtrace.h	3.14 KB	-rw-r--r--	2025-01-20 13:39
barrier.h	1.05 KB	-rw-r--r--	2025-01-20 13:39
base32.h	4.33 KB	-rw-r--r--	2025-01-20 13:39
base64.h	2.78 KB	-rw-r--r--	2025-01-20 13:39
buffer.h	23.81 KB	-rw-r--r--	2025-01-20 13:39
cmocka.h	1.38 KB	-rw-r--r--	2025-01-20 13:39
commandline.h	1.51 KB	-rw-r--r--	2025-01-20 13:39
condition.h	1.43 KB	-rw-r--r--	2025-01-20 13:39
counter.h	1.95 KB	-rw-r--r--	2025-01-20 13:39
crc64.h	982 B	-rw-r--r--	2025-01-20 13:39
deprecated.h	626 B	-rw-r--r--	2025-01-20 13:39
dir.h	1.59 KB	-rw-r--r--	2025-01-20 13:39
endian.h	4.32 KB	-rw-r--r--	2025-01-20 13:39
errno.h	643 B	-rw-r--r--	2025-01-20 13:39
error.h	1.09 KB	-rw-r--r--	2025-01-20 13:39
event.h	3.35 KB	-rw-r--r--	2025-01-20 13:39
eventclass.h	1.38 KB	-rw-r--r--	2025-01-20 13:39
file.h	10.92 KB	-rw-r--r--	2025-01-20 13:39
formatcheck.h	906 B	-rw-r--r--	2025-01-20 13:39
fuzz.h	582 B	-rw-r--r--	2025-01-20 13:39
glob.h	820 B	-rw-r--r--	2025-01-20 13:39
hash.h	1.6 KB	-rw-r--r--	2025-01-20 13:39
heap.h	5.02 KB	-rw-r--r--	2025-01-20 13:39
hex.h	2.73 KB	-rw-r--r--	2025-01-20 13:39
hmac.h	3.92 KB	-rw-r--r--	2025-01-20 13:39
ht.h	4.29 KB	-rw-r--r--	2025-01-20 13:39
httpd.h	1.71 KB	-rw-r--r--	2025-01-20 13:39
interfaceiter.h	3.03 KB	-rw-r--r--	2025-01-20 13:39
iterated_hash.h	972 B	-rw-r--r--	2025-01-20 13:39
lang.h	673 B	-rw-r--r--	2025-01-20 13:39
lex.h	9.76 KB	-rw-r--r--	2025-01-20 13:39
list.h	8.76 KB	-rw-r--r--	2025-01-20 13:39
log.h	26.04 KB	-rw-r--r--	2025-01-20 13:39
magic.h	924 B	-rw-r--r--	2025-01-20 13:39
managers.h	860 B	-rw-r--r--	2025-01-20 13:39
md.h	5.64 KB	-rw-r--r--	2025-01-20 13:39
mem.h	16.85 KB	-rw-r--r--	2025-01-20 13:39
meminfo.h	688 B	-rw-r--r--	2025-01-20 13:39
mutex.h	1.41 KB	-rw-r--r--	2025-01-20 13:39
mutexblock.h	1.1 KB	-rw-r--r--	2025-01-20 13:39
net.h	6.8 KB	-rw-r--r--	2025-01-20 13:39
netaddr.h	4.74 KB	-rw-r--r--	2025-01-20 13:39
netdb.h	844 B	-rw-r--r--	2025-01-20 13:39
netmgr.h	24.41 KB	-rw-r--r--	2025-01-20 13:39
netscope.h	941 B	-rw-r--r--	2025-01-20 13:39
nonce.h	782 B	-rw-r--r--	2025-01-20 13:39
offset.h	668 B	-rw-r--r--	2025-01-20 13:39
once.h	728 B	-rw-r--r--	2025-01-20 13:39
os.h	1.24 KB	-rw-r--r--	2025-01-20 13:39
parseint.h	1.48 KB	-rw-r--r--	2025-01-20 13:39
pool.h	3.39 KB	-rw-r--r--	2025-01-20 13:39
portset.h	3.2 KB	-rw-r--r--	2025-01-20 13:39
print.h	638 B	-rw-r--r--	2025-01-20 13:39
quota.h	3.49 KB	-rw-r--r--	2025-01-20 13:39
radix.h	6.86 KB	-rw-r--r--	2025-01-20 13:39
random.h	1.49 KB	-rw-r--r--	2026-03-27 00:00
ratelimiter.h	3.38 KB	-rw-r--r--	2025-01-20 13:39
refcount.h	10.19 KB	-rw-r--r--	2025-01-20 13:39
regex.h	751 B	-rw-r--r--	2025-01-20 13:39
region.h	2.16 KB	-rw-r--r--	2025-01-20 13:39
resource.h	2.77 KB	-rw-r--r--	2025-01-20 13:39
result.h	7.78 KB	-rw-r--r--	2025-01-20 13:39
rwlock.h	2.43 KB	-rw-r--r--	2025-01-20 13:39
safe.h	1.11 KB	-rw-r--r--	2025-01-20 13:39
serial.h	1.32 KB	-rw-r--r--	2025-01-20 13:39
siphash.h	929 B	-rw-r--r--	2025-01-20 13:39
sockaddr.h	6.26 KB	-rw-r--r--	2025-01-20 13:39
stat.h	790 B	-rw-r--r--	2025-01-20 13:39
stats.h	6.6 KB	-rw-r--r--	2025-01-20 13:39
stdatomic.h	4.77 KB	-rw-r--r--	2025-01-20 13:39
stdio.h	1.67 KB	-rw-r--r--	2025-01-20 13:39
stdtime.h	1.34 KB	-rw-r--r--	2025-01-20 13:39
strerr.h	692 B	-rw-r--r--	2025-01-20 13:39
string.h	993 B	-rw-r--r--	2025-01-20 13:39
symtab.h	4.2 KB	-rw-r--r--	2025-01-20 13:39
syslog.h	824 B	-rw-r--r--	2025-01-20 13:39
task.h	14.81 KB	-rw-r--r--	2025-01-20 13:39
taskpool.h	3.18 KB	-rw-r--r--	2025-01-20 13:39
thread.h	1.18 KB	-rw-r--r--	2025-01-20 13:39
time.h	11.24 KB	-rw-r--r--	2025-01-20 13:39
timer.h	6.91 KB	-rw-r--r--	2025-01-20 13:39
tls.h	18.02 KB	-rw-r--r--	2025-01-20 13:39
tm.h	884 B	-rw-r--r--	2025-01-20 13:39
types.h	5.18 KB	-rw-r--r--	2025-01-20 13:39
url.h	2.7 KB	-rw-r--r--	2025-01-20 13:39
utf8.h	967 B	-rw-r--r--	2025-01-20 13:39
util.h	12.63 KB	-rw-r--r--	2025-01-20 13:39

Rename

/*
 * Copyright (C) Internet Systems Consortium, Inc. ("ISC")
 *
 * SPDX-License-Identifier: MPL-2.0
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, you can obtain one at https://mozilla.org/MPL/2.0/.
 *
 * See the COPYRIGHT file distributed with this work for additional
 * information regarding copyright ownership.
 */

#pragma once

/*****
***** Module Info
*****/

/*! \file isc/timer.h
 * \brief Provides timers which are event sources in the task system.
 *
 * Three types of timers are supported:
 *
 *\li	'ticker' timers generate a periodic tick event.
 *
 *\li	'once' timers generate an idle timeout event if they are idle for too
 *	long, and generate a life timeout event if their lifetime expires.
 *	They are used to implement both (possibly expiring) idle timers and
 *	'one-shot' timers.
 *
 *\li	'limited' timers generate a periodic tick event until they reach
 *	their lifetime when they generate a life timeout event.
 *
 *\li	'inactive' timers generate no events.
 *
 * Timers can change type.  It is typical to create a timer as
 * an 'inactive' timer and then change it into a 'ticker' or
 * 'once' timer.
 *
 *\li MP:
 *	The module ensures appropriate synchronization of data structures it
 *	creates and manipulates.
 *	Clients of this module must not be holding a timer's task's lock when
 *	making a call that affects that timer.  Failure to follow this rule
 *	can result in deadlock.
 *	The caller must ensure that isc_timermgr_destroy() is called only
 *	once for a given manager.
 *
 * \li Reliability:
 *	No anticipated impact.
 *
 * \li Resources:
 *	TBS
 *
 * \li Security:
 *	No anticipated impact.
 *
 * \li Standards:
 *	None.
 */

/***
 *** Imports
 ***/

#include <stdbool.h>

#include <isc/event.h>
#include <isc/eventclass.h>
#include <isc/lang.h>
#include <isc/time.h>
#include <isc/types.h>

ISC_LANG_BEGINDECLS

/***
 *** Types
 ***/

/*% Timer Type */
typedef enum {
	isc_timertype_undefined = -1, /*%< Undefined */
	isc_timertype_ticker = 0,     /*%< Ticker */
	isc_timertype_once = 1,	      /*%< Once */
	isc_timertype_limited = 2,    /*%< Limited */
	isc_timertype_inactive = 3    /*%< Inactive */
} isc_timertype_t;

typedef struct isc_timerevent isc_timerevent_t;

struct isc_timerevent {
	struct isc_event common;
	isc_time_t	 due;
	ISC_LINK(isc_timerevent_t) ev_timerlink;
};

#define ISC_TIMEREVENT_FIRSTEVENT (ISC_EVENTCLASS_TIMER + 0)
#define ISC_TIMEREVENT_TICK	  (ISC_EVENTCLASS_TIMER + 1)
#define ISC_TIMEREVENT_IDLE	  (ISC_EVENTCLASS_TIMER + 2)
#define ISC_TIMEREVENT_LIFE	  (ISC_EVENTCLASS_TIMER + 3)
#define ISC_TIMEREVENT_LASTEVENT  (ISC_EVENTCLASS_TIMER + 65535)

/***
 *** Timer and Timer Manager Functions
 ***
 *** Note: all Ensures conditions apply only if the result is success for
 *** those functions which return an isc_result_t.
 ***/

isc_result_t
isc_timer_create(isc_timermgr_t *manager, isc_timertype_t type,
		 const isc_time_t *expires, const isc_interval_t *interval,
		 isc_task_t *task, isc_taskaction_t action, void *arg,
		 isc_timer_t **timerp);
/*%<
 * Create a new 'type' timer managed by 'manager'.  The timers parameters
 * are specified by 'expires' and 'interval'.  Events will be posted to
 * 'task' and when dispatched 'action' will be called with 'arg' as the
 * arg value.  The new timer is returned in 'timerp'.
 *
 * Notes:
 *
 *\li	For ticker timers, the timer will generate a 'tick' event every
 *	'interval' seconds.  The value of 'expires' is ignored.
 *
 *\li	For once timers, 'expires' specifies the time when a life timeout
 *	event should be generated.  If 'expires' is 0 (the epoch), then no life
 *	timeout will be generated.  'interval' specifies how long the timer
 *	can be idle before it generates an idle timeout.  If 0, then no
 *	idle timeout will be generated.
 *
 *\li	If 'expires' is NULL, the epoch will be used.
 *
 *	If 'interval' is NULL, the zero interval will be used.
 *
 * Requires:
 *
 *\li	'manager' is a valid manager
 *
 *\li	'task' is a valid task
 *
 *\li	'action' is a valid action
 *
 *\li	'expires' points to a valid time, or is NULL.
 *
 *\li	'interval' points to a valid interval, or is NULL.
 *
 *\li	type == isc_timertype_inactive ||
 *	('expires' and 'interval' are not both 0)
 *
 *\li	'timerp' is a valid pointer, and *timerp == NULL
 *
 * Ensures:
 *
 *\li	'*timerp' is attached to the newly created timer
 *
 *\li	The timer is attached to the task
 *
 *\li	An idle timeout will not be generated until at least Now + the
 *	timer's interval if 'timer' is a once timer with a non-zero
 *	interval.
 *
 * Returns:
 *
 *\li	Success
 *\li	No memory
 *\li	Unexpected error
 */

isc_result_t
isc_timer_reset(isc_timer_t *timer, isc_timertype_t type,
		const isc_time_t *expires, const isc_interval_t *interval,
		bool purge);
/*%<
 * Change the timer's type, expires, and interval values to the given
 * values.  If 'purge' is TRUE, any pending events from this timer
 * are purged from its task's event queue.
 *
 * Notes:
 *
 *\li	If 'expires' is NULL, the epoch will be used.
 *
 *\li	If 'interval' is NULL, the zero interval will be used.
 *
 * Requires:
 *
 *\li	'timer' is a valid timer
 *
 *\li	The same requirements that isc_timer_create() imposes on 'type',
 *	'expires' and 'interval' apply.
 *
 * Ensures:
 *
 *\li	An idle timeout will not be generated until at least Now + the
 *	timer's interval if 'timer' is a once timer with a non-zero
 *	interval.
 *
 * Returns:
 *
 *\li	Success
 *\li	No memory
 *\li	Unexpected error
 */

isc_result_t
isc_timer_touch(isc_timer_t *timer);
/*%<
 * Set the last-touched time of 'timer' to the current time.
 *
 * Requires:
 *
 *\li	'timer' is a valid once timer.
 *
 * Ensures:
 *
 *\li	An idle timeout will not be generated until at least Now + the
 *	timer's interval if 'timer' is a once timer with a non-zero
 *	interval.
 *
 * Returns:
 *
 *\li	Success
 *\li	Unexpected error
 */

void
isc_timer_purge(isc_timer_t *timer);
/*%<
 * Purge timer.
 *
 * Requires:
 *
 *\li	'timer' points to a valid timer.
 *
 * Ensures:
 *
 *\li	Any events already posted by the timer are purged.
 *
 */

void
isc_timer_destroy(isc_timer_t **timerp);
/*%<
 * Destroy *timerp.
 *
 * Requires:
 *
 *\li	'timerp' points to a valid timer.
 *
 * Ensures:
 *
 *\li	*timerp is NULL.
 *
 *\code
 *		The timer will be shutdown
 *
 *		The timer will detach from its task
 *
 *		All resources used by the timer have been freed
 *
 *		Any events already posted by the timer will be purged.
 *		Therefore, if isc_timer_destroy() is called in the context
 *		of the timer's task, it is guaranteed that no more
 *		timer event callbacks will run after the call.
 *
 *		If this function is called from the timer event callback
 *		the event itself must be destroyed before the timer
 *		itself.
 *\endcode
 */

isc_timertype_t
isc_timer_gettype(isc_timer_t *timer);
/*%<
 * Return the timer type.
 *
 * Requires:
 *
 *\li	'timer' to be a valid timer.
 */

void
isc_timermgr_poke(isc_timermgr_t *m);

ISC_LANG_ENDDECLS