1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
|
#ifndef AWS_HTTP_RANDOM_ACCESS_SET_H
#define AWS_HTTP_RANDOM_ACCESS_SET_H
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#include <aws/common/array_list.h>
#include <aws/common/hash_table.h>
#include <aws/http/http.h>
/* TODO: someday, if you want to use it from other repo, move it to aws-c-common. */
struct aws_random_access_set_impl;
struct aws_random_access_set {
struct aws_random_access_set_impl *impl;
};
AWS_EXTERN_C_BEGIN
/**
* Initialize the set, which support constant time of insert, remove and get random element
* from the data structure.
*
* The underlying hash map will use hash_fn to compute the hash of each element. equals_fn to compute equality of two
* keys.
*
* @param set Pointer of structure to initialize with
* @param allocator Allocator
* @param hash_fn Compute the hash of each element
* @param equals_fn Compute equality of two elements
* @param destroy_element_fn Optional. Called when the element is removed
* @param initial_item_allocation The initial number of item to allocate.
* @return AWS_OP_ERR if any fails to initialize, AWS_OP_SUCCESS on success.
*/
AWS_HTTP_API
int aws_random_access_set_init(
struct aws_random_access_set *set,
struct aws_allocator *allocator,
aws_hash_fn *hash_fn,
aws_hash_callback_eq_fn *equals_fn,
aws_hash_callback_destroy_fn *destroy_element_fn,
size_t initial_item_allocation);
AWS_HTTP_API
void aws_random_access_set_clean_up(struct aws_random_access_set *set);
/**
* Insert the element to the end of the array list. A map from the element to the index of it to the hash table.
*/
AWS_HTTP_API
int aws_random_access_set_add(struct aws_random_access_set *set, const void *element, bool *added);
/**
* Find and remove the element from the table. If the element does not exist, or the table is empty, nothing will
* happen. Switch the element with the end of the arraylist if needed. Remove the end of the arraylist
*/
AWS_HTTP_API
int aws_random_access_set_remove(struct aws_random_access_set *set, const void *element);
/**
* Get the pointer to a random element from the data structure. Fails when the data structure is empty.
*/
AWS_HTTP_API
int aws_random_access_set_random_get_ptr(const struct aws_random_access_set *set, void **out);
AWS_HTTP_API
size_t aws_random_access_set_get_size(const struct aws_random_access_set *set);
/**
* Check the element exist in the data structure or not.
*/
AWS_HTTP_API
int aws_random_access_set_exist(const struct aws_random_access_set *set, const void *element, bool *exist);
/**
* Get the pointer to an element that currently stored at that index. It may change if operations like remove and add
* happens. Helpful for debugging and iterating through the whole set.
*/
AWS_HTTP_API
int aws_random_access_set_random_get_ptr_index(const struct aws_random_access_set *set, void **out, size_t index);
AWS_EXTERN_C_END
#endif /* AWS_HTTP_RANDOM_ACCESS_SET_H */
|