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

/*! \file isc/heap.h */

#include <stdbool.h>

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

ISC_LANG_BEGINDECLS

/*%
 * The comparison function returns true if the first argument has
 * higher priority than the second argument, and false otherwise.
 */
typedef bool (*isc_heapcompare_t)(void *, void *);

/*%
 * The index function allows the client of the heap to receive a callback
 * when an item's index number changes.  This allows it to maintain
 * sync with its external state, but still delete itself, since deletions
 * from the heap require the index be provided.
 */
typedef void (*isc_heapindex_t)(void *, unsigned int);

/*%
 * The heapaction function is used when iterating over the heap.
 *
 * NOTE:  The heap structure CANNOT BE MODIFIED during the call to
 * isc_heap_foreach().
 */
typedef void (*isc_heapaction_t)(void *, void *);

typedef struct isc_heap isc_heap_t;

void
isc_heap_create(isc_mem_t *mctx, isc_heapcompare_t compare,
		isc_heapindex_t index, unsigned int size_increment,
		isc_heap_t **heapp);
/*!<
 * \brief Create a new heap.  The heap is implemented using a space-efficient
 * storage method.  When the heap elements are deleted space is not freed
 * but will be reused when new elements are inserted.
 *
 * Heap elements are indexed from 1.
 *
 * Requires:
 *\li	"mctx" is valid.
 *\li	"compare" is a function which takes two void * arguments and
 *	returns true if the first argument has a higher priority than
 *	the second, and false otherwise.
 *\li	"index" is a function which takes a void *, and an unsigned int
 *	argument.  This function will be called whenever an element's
 *	index value changes, so it may continue to delete itself from the
 *	heap.  This option may be NULL if this functionality is unneeded.
 *\li	"size_increment" is a hint about how large the heap should grow
 *	when resizing is needed.  If this is 0, a default size will be
 *	used, which is currently 1024, allowing space for an additional 1024
 *	heap elements to be inserted before adding more space.
 *\li	"heapp" is not NULL, and "*heap" is NULL.
 */

void
isc_heap_destroy(isc_heap_t **heapp);
/*!<
 * \brief Destroys a heap.
 *
 * Requires:
 *\li	"heapp" is not NULL and "*heap" points to a valid isc_heap_t.
 */

void
isc_heap_insert(isc_heap_t *heap, void *elt);
/*!<
 * \brief Inserts a new element into a heap.
 *
 * Requires:
 *\li	"heapp" is not NULL and "*heap" points to a valid isc_heap_t.
 */

void
isc_heap_delete(isc_heap_t *heap, unsigned int index);
/*!<
 * \brief Deletes an element from a heap, by element index.
 *
 * Requires:
 *\li	"heapp" is not NULL and "*heap" points to a valid isc_heap_t.
 *\li	"index" is a valid element index, as provided by the "index" callback
 *	provided during heap creation.
 */

void
isc_heap_increased(isc_heap_t *heap, unsigned int index);
/*!<
 * \brief Indicates to the heap that an element's priority has increased.
 * This function MUST be called whenever an element has increased in priority.
 *
 * Requires:
 *\li	"heapp" is not NULL and "*heap" points to a valid isc_heap_t.
 *\li	"index" is a valid element index, as provided by the "index" callback
 *	provided during heap creation.
 */

void
isc_heap_decreased(isc_heap_t *heap, unsigned int index);
/*!<
 * \brief Indicates to the heap that an element's priority has decreased.
 * This function MUST be called whenever an element has decreased in priority.
 *
 * Requires:
 *\li	"heapp" is not NULL and "*heap" points to a valid isc_heap_t.
 *\li	"index" is a valid element index, as provided by the "index" callback
 *	provided during heap creation.
 */

void *
isc_heap_element(isc_heap_t *heap, unsigned int index);
/*!<
 * \brief Returns the element for a specific element index.
 *
 * Requires:
 *\li	"heapp" is not NULL and "*heap" points to a valid isc_heap_t.
 *\li	"index" is a valid element index, as provided by the "index" callback
 *	provided during heap creation.
 *
 * Returns:
 *\li	A pointer to the element for the element index.
 */

void
isc_heap_foreach(isc_heap_t *heap, isc_heapaction_t action, void *uap);
/*!<
 * \brief Iterate over the heap, calling an action for each element.  The
 * order of iteration is not sorted.
 *
 * Requires:
 *\li	"heapp" is not NULL and "*heap" points to a valid isc_heap_t.
 *\li	"action" is not NULL, and is a function which takes two arguments.
 *	The first is a void *, representing the element, and the second is
 *	"uap" as provided to isc_heap_foreach.
 *\li	"uap" is a caller-provided argument, and may be NULL.
 *
 * Note:
 *\li	The heap structure CANNOT be modified during this iteration.  The only
 *	safe function to call while iterating the heap is isc_heap_element().
 */

ISC_LANG_ENDDECLS