Gecko [ www.arkitchencabinet.com ]

Name	Size	Permission	Date
aes.h	1.05 KB	-rw-r--r--	2025-11-06 07:45
app.h	10.23 KB	-rw-r--r--	2025-11-06 07:45
assertions.h	2.84 KB	-rw-r--r--	2025-11-06 07:45
atomic.h	4.07 KB	-rw-r--r--	2025-11-06 07:45
backtrace.h	3.8 KB	-rw-r--r--	2025-11-06 07:45
base32.h	4.35 KB	-rw-r--r--	2025-11-06 07:45
base64.h	2.8 KB	-rw-r--r--	2025-11-06 07:45
bind9.h	830 B	-rw-r--r--	2025-11-06 07:45
boolean.h	594 B	-rw-r--r--	2025-11-06 07:45
buffer.h	25.65 KB	-rw-r--r--	2025-11-06 07:45
bufferlist.h	1.42 KB	-rw-r--r--	2025-11-06 07:45
cmocka.h	1.35 KB	-rw-r--r--	2025-11-06 07:45
commandline.h	1.67 KB	-rw-r--r--	2025-11-06 07:45
condition.h	1.44 KB	-rw-r--r--	2025-11-06 07:45
counter.h	1.88 KB	-rw-r--r--	2025-11-06 07:45
crc64.h	998 B	-rw-r--r--	2025-11-06 07:45
deprecated.h	623 B	-rw-r--r--	2025-11-06 07:45
dir.h	1.56 KB	-rw-r--r--	2025-11-06 07:45
endian.h	4.67 KB	-rw-r--r--	2025-11-06 07:45
entropy.h	10.13 KB	-rw-r--r--	2025-11-06 07:45
errno.h	659 B	-rw-r--r--	2025-11-06 07:45
errno2result.h	902 B	-rw-r--r--	2025-11-06 07:45
error.h	1.4 KB	-rw-r--r--	2025-11-06 07:45
event.h	2.98 KB	-rw-r--r--	2025-11-06 07:45
eventclass.h	1.35 KB	-rw-r--r--	2025-11-06 07:45
file.h	11.39 KB	-rw-r--r--	2025-11-06 07:45
formatcheck.h	893 B	-rw-r--r--	2025-11-06 07:45
fsaccess.h	7.27 KB	-rw-r--r--	2025-11-06 07:45
hash.h	7.48 KB	-rw-r--r--	2025-11-06 07:45
heap.h	5.14 KB	-rw-r--r--	2025-11-06 07:45
hex.h	2.74 KB	-rw-r--r--	2025-11-06 07:45
hmacmd5.h	1.75 KB	-rw-r--r--	2025-11-06 07:45
hmacsha.h	4.41 KB	-rw-r--r--	2025-11-06 07:45
ht.h	4.29 KB	-rw-r--r--	2025-11-06 07:45
httpd.h	2.26 KB	-rw-r--r--	2025-11-06 07:45
int.h	1.06 KB	-rw-r--r--	2025-11-06 07:45
interfaceiter.h	3.05 KB	-rw-r--r--	2025-11-06 07:45
iterated_hash.h	1.02 KB	-rw-r--r--	2025-11-06 07:45
json.h	1.42 KB	-rw-r--r--	2025-11-06 07:45
keyboard.h	989 B	-rw-r--r--	2025-11-06 07:45
lang.h	637 B	-rw-r--r--	2025-11-06 07:45
lex.h	9.54 KB	-rw-r--r--	2025-11-06 07:45
lfsr.h	2.89 KB	-rw-r--r--	2025-11-06 07:45
lib.h	1.04 KB	-rw-r--r--	2025-11-06 07:45
likely.h	818 B	-rw-r--r--	2025-11-06 07:45
list.h	5.62 KB	-rw-r--r--	2025-11-06 07:45
log.h	28.06 KB	-rw-r--r--	2025-11-06 07:45
magic.h	994 B	-rw-r--r--	2025-11-06 07:45
md5.h	2.32 KB	-rw-r--r--	2025-11-06 07:45
mem.h	20.62 KB	-rw-r--r--	2025-11-06 07:45
meminfo.h	710 B	-rw-r--r--	2025-11-06 07:45
msgcat.h	2.66 KB	-rw-r--r--	2025-11-06 07:45
msgs.h	8.22 KB	-rw-r--r--	2025-11-06 07:45
mutex.h	3.44 KB	-rw-r--r--	2025-11-06 07:45
mutexblock.h	1.34 KB	-rw-r--r--	2025-11-06 07:45
net.h	10.29 KB	-rw-r--r--	2025-11-06 07:45
netaddr.h	4.48 KB	-rw-r--r--	2025-11-06 07:45
netdb.h	863 B	-rw-r--r--	2025-11-06 07:45
netscope.h	967 B	-rw-r--r--	2025-11-06 07:45
offset.h	700 B	-rw-r--r--	2025-11-06 07:45
once.h	983 B	-rw-r--r--	2025-11-06 07:45
ondestroy.h	2.73 KB	-rw-r--r--	2025-11-06 07:45
os.h	671 B	-rw-r--r--	2025-11-06 07:45
parseint.h	1.51 KB	-rw-r--r--	2025-11-06 07:45
platform.h	9.49 KB	-rw-r--r--	2025-11-06 07:45
pool.h	3.42 KB	-rw-r--r--	2025-11-06 07:45
portset.h	3.22 KB	-rw-r--r--	2025-11-06 07:45
print.h	2.42 KB	-rw-r--r--	2025-11-06 07:45
queue.h	5.08 KB	-rw-r--r--	2025-11-06 07:45
quota.h	2.38 KB	-rw-r--r--	2025-11-06 07:45
radix.h	6.34 KB	-rw-r--r--	2025-11-06 07:45
random.h	3.5 KB	-rw-r--r--	2025-11-06 07:45
ratelimiter.h	3.42 KB	-rw-r--r--	2025-11-06 07:45
refcount.h	8 KB	-rw-r--r--	2025-11-06 07:45
regex.h	767 B	-rw-r--r--	2025-11-06 07:45
region.h	1.99 KB	-rw-r--r--	2025-11-06 07:45
resource.h	2.79 KB	-rw-r--r--	2025-11-06 07:45
result.h	4.87 KB	-rw-r--r--	2025-11-06 07:45
resultclass.h	1.56 KB	-rw-r--r--	2025-11-06 07:45
rwlock.h	3.72 KB	-rw-r--r--	2025-11-06 07:45
safe.h	1.32 KB	-rw-r--r--	2025-11-06 07:45
serial.h	1.34 KB	-rw-r--r--	2025-11-06 07:45
sha1.h	1.52 KB	-rw-r--r--	2025-11-06 07:45
sha2.h	5.6 KB	-rw-r--r--	2025-11-06 07:45
siphash.h	734 B	-rw-r--r--	2025-11-06 07:45
sockaddr.h	5.9 KB	-rw-r--r--	2025-11-06 07:45
socket.h	35.8 KB	-rw-r--r--	2025-11-06 07:45
stat.h	806 B	-rw-r--r--	2025-11-06 07:45
stats.h	3.62 KB	-rw-r--r--	2025-11-06 07:45
stdatomic.h	5.13 KB	-rw-r--r--	2025-11-06 07:45
stdio.h	1.75 KB	-rw-r--r--	2025-11-06 07:45
stdlib.h	704 B	-rw-r--r--	2025-11-06 07:45
stdtime.h	1.04 KB	-rw-r--r--	2025-11-06 07:45
strerror.h	777 B	-rw-r--r--	2025-11-06 07:45
string.h	5.88 KB	-rw-r--r--	2025-11-06 07:45
symtab.h	4.22 KB	-rw-r--r--	2025-11-06 07:45
syslog.h	844 B	-rw-r--r--	2025-11-06 07:45
task.h	21.04 KB	-rw-r--r--	2025-11-06 07:45
taskpool.h	3.62 KB	-rw-r--r--	2025-11-06 07:45
thread.h	1.47 KB	-rw-r--r--	2025-11-06 07:45
time.h	8.67 KB	-rw-r--r--	2025-11-06 07:45
timer.h	10.54 KB	-rw-r--r--	2025-11-06 07:45
tm.h	895 B	-rw-r--r--	2025-11-06 07:45
types.h	5.64 KB	-rw-r--r--	2025-11-06 07:45
utf8.h	928 B	-rw-r--r--	2025-11-06 07:45
util.h	10.29 KB	-rw-r--r--	2025-11-06 07:45
version.h	689 B	-rw-r--r--	2025-11-06 07:45
xml.h	1.07 KB	-rw-r--r--	2025-11-06 07:45

Rename

/*
 * Copyright (C) Internet Systems Consortium, Inc. ("ISC")
 *
 * 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.
 */

#ifndef ISC_RATELIMITER_H
#define ISC_RATELIMITER_H 1

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

/*! \file isc/ratelimiter.h
 * \brief A rate limiter is a mechanism for dispatching events at a limited
 * rate.  This is intended to be used when sending zone maintenance
 * SOA queries, NOTIFY messages, etc.
 */

/***
 *** Imports.
 ***/

#include <inttypes.h>
#include <stdbool.h>

#include <isc/lang.h>
#include <isc/types.h>

ISC_LANG_BEGINDECLS

/*****
 ***** Functions.
 *****/

isc_result_t
isc_ratelimiter_create(isc_mem_t *mctx, isc_timermgr_t *timermgr,
		       isc_task_t *task, isc_ratelimiter_t **ratelimiterp);
/*%<
 * Create a rate limiter.  The execution interval is initially undefined.
 */

isc_result_t
isc_ratelimiter_setinterval(isc_ratelimiter_t *rl, isc_interval_t *interval);
/*!<
 * Set the minimum interval between event executions.
 * The interval value is copied, so the caller need not preserve it.
 *
 * Requires:
 *	'*interval' is a nonzero interval.
 */

void
isc_ratelimiter_setpertic(isc_ratelimiter_t *rl, uint32_t perint);
/*%<
 * Set the number of events processed per interval timer tick.
 * If 'perint' is zero it is treated as 1.
 */

void
isc_ratelimiter_setpushpop(isc_ratelimiter_t *rl, bool pushpop);
/*%<
 * Set / clear the ratelimiter to from push pop mode rather
 * first in - first out mode (default).
 */

isc_result_t
isc_ratelimiter_enqueue(isc_ratelimiter_t *rl, isc_task_t *task,
			isc_event_t **eventp);
/*%<
 * Queue an event for rate-limited execution.
 *
 * This is similar
 * to doing an isc_task_send() to the 'task', except that the
 * execution may be delayed to achieve the desired rate of
 * execution.
 *
 * '(*eventp)->ev_sender' is used to hold the task.  The caller
 * must ensure that the task exists until the event is delivered.
 *
 * Requires:
 *\li	An interval has been set by calling
 *	isc_ratelimiter_setinterval().
 *
 *\li	'task' to be non NULL.
 *\li	'(*eventp)->ev_sender' to be NULL.
 */

isc_result_t
isc_ratelimiter_dequeue(isc_ratelimiter_t *rl, isc_event_t *event);
/*
 * Dequeue a event off the ratelimiter queue.
 *
 * Returns:
 * \li	ISC_R_NOTFOUND if the event is no longer linked to the rate limiter.
 * \li	ISC_R_SUCCESS
 */

void
isc_ratelimiter_shutdown(isc_ratelimiter_t *ratelimiter);
/*%<
 * Shut down a rate limiter.
 *
 * Ensures:
 *\li	All events that have not yet been
 * 	dispatched to the task are dispatched immediately with
 *	the #ISC_EVENTATTR_CANCELED bit set in ev_attributes.
 *
 *\li	Further attempts to enqueue events will fail with
 * 	#ISC_R_SHUTTINGDOWN.
 *
 *\li	The rate limiter is no longer attached to its task.
 */

void
isc_ratelimiter_attach(isc_ratelimiter_t *source, isc_ratelimiter_t **target);
/*%<
 * Attach to a rate limiter.
 */

void
isc_ratelimiter_detach(isc_ratelimiter_t **ratelimiterp);
/*%<
 * Detach from a rate limiter.
 */

isc_result_t
isc_ratelimiter_stall(isc_ratelimiter_t *rl);
/*%<
 * Stall event processing.
 */

isc_result_t
isc_ratelimiter_release(isc_ratelimiter_t *rl);
/*%<
 * Release a stalled rate limiter.
 */

ISC_LANG_ENDDECLS

#endif /* ISC_RATELIMITER_H */