Gecko [ goons4good.org ]

Name	Size	Permission	Date
aes.h	1.05 KB	-rw-r--r--	2025-03-04 05:23
app.h	10.23 KB	-rw-r--r--	2025-03-04 05:23
assertions.h	2.78 KB	-rw-r--r--	2025-03-04 05:23
atomic.h	4.15 KB	-rw-r--r--	2025-03-04 05:23
backtrace.h	3.8 KB	-rw-r--r--	2025-03-04 05:23
base32.h	3.94 KB	-rw-r--r--	2025-03-04 05:23
base64.h	2.39 KB	-rw-r--r--	2025-03-04 05:23
bind9.h	849 B	-rw-r--r--	2025-03-04 05:23
boolean.h	746 B	-rw-r--r--	2025-03-04 05:23
buffer.h	25.69 KB	-rw-r--r--	2025-03-04 05:23
bufferlist.h	1.42 KB	-rw-r--r--	2025-03-04 05:23
commandline.h	1.69 KB	-rw-r--r--	2025-03-04 05:23
condition.h	1.44 KB	-rw-r--r--	2025-03-04 05:23
counter.h	1.88 KB	-rw-r--r--	2025-03-04 05:23
crc64.h	986 B	-rw-r--r--	2025-03-04 05:23
deprecated.h	622 B	-rw-r--r--	2025-03-04 05:23
dir.h	1.96 KB	-rw-r--r--	2025-03-04 05:23
entropy.h	8.76 KB	-rw-r--r--	2025-03-04 05:23
errno.h	658 B	-rw-r--r--	2025-03-04 05:23
errno2result.h	893 B	-rw-r--r--	2025-03-04 05:23
error.h	1.4 KB	-rw-r--r--	2025-03-04 05:23
event.h	2.98 KB	-rw-r--r--	2025-03-04 05:23
eventclass.h	1.35 KB	-rw-r--r--	2025-03-04 05:23
file.h	11.43 KB	-rw-r--r--	2025-03-04 05:23
formatcheck.h	892 B	-rw-r--r--	2025-03-04 05:23
fsaccess.h	7.25 KB	-rw-r--r--	2025-03-04 05:23
hash.h	7.52 KB	-rw-r--r--	2025-03-04 05:23
heap.h	5.14 KB	-rw-r--r--	2025-03-04 05:23
hex.h	2.33 KB	-rw-r--r--	2025-03-04 05:23
hmacmd5.h	1.75 KB	-rw-r--r--	2025-03-04 05:23
hmacsha.h	4.44 KB	-rw-r--r--	2025-03-04 05:23
ht.h	4.29 KB	-rw-r--r--	2025-03-04 05:23
httpd.h	2.26 KB	-rw-r--r--	2025-03-04 05:23
int.h	1.37 KB	-rw-r--r--	2025-03-04 05:23
interfaceiter.h	3.03 KB	-rw-r--r--	2025-03-04 05:23
iterated_hash.h	1.02 KB	-rw-r--r--	2025-03-04 05:23
json.h	1.42 KB	-rw-r--r--	2025-03-04 05:23
keyboard.h	976 B	-rw-r--r--	2025-03-04 05:23
lang.h	636 B	-rw-r--r--	2025-03-04 05:23
lex.h	9.42 KB	-rw-r--r--	2025-03-04 05:23
lfsr.h	2.88 KB	-rw-r--r--	2025-03-04 05:23
lib.h	1.04 KB	-rw-r--r--	2025-03-04 05:23
likely.h	718 B	-rw-r--r--	2025-03-04 05:23
list.h	5.65 KB	-rw-r--r--	2025-03-04 05:23
log.h	28.06 KB	-rw-r--r--	2025-03-04 05:23
magic.h	993 B	-rw-r--r--	2025-03-04 05:23
md5.h	2.34 KB	-rw-r--r--	2025-03-04 05:23
mem.h	20.63 KB	-rw-r--r--	2025-03-04 05:23
meminfo.h	690 B	-rw-r--r--	2025-03-04 05:23
msgcat.h	2.66 KB	-rw-r--r--	2025-03-04 05:23
msgs.h	8.22 KB	-rw-r--r--	2025-03-04 05:23
mutex.h	3.44 KB	-rw-r--r--	2025-03-04 05:23
mutexblock.h	1.34 KB	-rw-r--r--	2025-03-04 05:23
net.h	10.32 KB	-rw-r--r--	2025-03-04 05:23
netaddr.h	4.56 KB	-rw-r--r--	2025-03-04 05:23
netdb.h	862 B	-rw-r--r--	2025-03-04 05:23
netscope.h	947 B	-rw-r--r--	2025-03-04 05:23
offset.h	699 B	-rw-r--r--	2025-03-04 05:23
once.h	981 B	-rw-r--r--	2025-03-04 05:23
ondestroy.h	2.79 KB	-rw-r--r--	2025-03-04 05:23
os.h	670 B	-rw-r--r--	2025-03-04 05:23
parseint.h	1.49 KB	-rw-r--r--	2025-03-04 05:23
platform.h	9.31 KB	-rw-r--r--	2025-03-04 05:23
pool.h	3.42 KB	-rw-r--r--	2025-03-04 05:23
portset.h	3.21 KB	-rw-r--r--	2025-03-04 05:23
print.h	2.49 KB	-rw-r--r--	2025-03-04 05:23
queue.h	4.66 KB	-rw-r--r--	2025-03-04 05:23
quota.h	2.29 KB	-rw-r--r--	2025-03-04 05:23
radix.h	6.37 KB	-rw-r--r--	2025-03-04 05:23
random.h	2.99 KB	-rw-r--r--	2025-03-04 05:23
ratelimiter.h	3.38 KB	-rw-r--r--	2025-03-04 05:23
refcount.h	7.89 KB	-rw-r--r--	2025-03-04 05:23
regex.h	766 B	-rw-r--r--	2025-03-04 05:23
region.h	1.99 KB	-rw-r--r--	2025-03-04 05:23
resource.h	2.8 KB	-rw-r--r--	2025-03-04 05:23
result.h	4.62 KB	-rw-r--r--	2025-03-04 05:23
resultclass.h	1.56 KB	-rw-r--r--	2025-03-04 05:23
rwlock.h	3.6 KB	-rw-r--r--	2025-03-04 05:23
safe.h	1.21 KB	-rw-r--r--	2025-03-04 05:23
serial.h	1.4 KB	-rw-r--r--	2025-03-04 05:23
sha1.h	1.52 KB	-rw-r--r--	2025-03-04 05:23
sha2.h	5.65 KB	-rw-r--r--	2025-03-04 05:23
sockaddr.h	6 KB	-rw-r--r--	2025-03-04 05:23
socket.h	35.81 KB	-rw-r--r--	2025-03-04 05:23
stat.h	805 B	-rw-r--r--	2025-03-04 05:23
stats.h	3.02 KB	-rw-r--r--	2025-03-04 05:23
stdio.h	1.74 KB	-rw-r--r--	2025-03-04 05:23
stdlib.h	703 B	-rw-r--r--	2025-03-04 05:23
stdtime.h	1.3 KB	-rw-r--r--	2025-03-04 05:23
strerror.h	776 B	-rw-r--r--	2025-03-04 05:23
string.h	5.94 KB	-rw-r--r--	2025-03-04 05:23
symtab.h	4.21 KB	-rw-r--r--	2025-03-04 05:23
syslog.h	843 B	-rw-r--r--	2025-03-04 05:23
task.h	21.08 KB	-rw-r--r--	2025-03-04 05:23
taskpool.h	3.61 KB	-rw-r--r--	2025-03-04 05:23
thread.h	1.47 KB	-rw-r--r--	2025-03-04 05:23
time.h	8.66 KB	-rw-r--r--	2025-03-04 05:23
timer.h	10.54 KB	-rw-r--r--	2025-03-04 05:23
tm.h	894 B	-rw-r--r--	2025-03-04 05:23
types.h	5.54 KB	-rw-r--r--	2025-03-04 05:23
util.h	7.49 KB	-rw-r--r--	2025-03-04 05:23
version.h	688 B	-rw-r--r--	2025-03-04 05:23
xml.h	1.07 KB	-rw-r--r--	2025-03-04 05:23

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 http://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 <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, isc_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, isc_boolean_t 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 */