nghttp2/lib/nghttp2_map.h

143 lines
4.3 KiB
C
Raw Normal View History

/*
2014-03-30 12:09:21 +02:00
* nghttp2 - HTTP/2 C Library
*
2020-07-26 07:00:45 +02:00
* Copyright (c) 2017 ngtcp2 contributors
* Copyright (c) 2012 nghttp2 contributors
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
2013-07-12 17:19:03 +02:00
#ifndef NGHTTP2_MAP_H
#define NGHTTP2_MAP_H
#ifdef HAVE_CONFIG_H
2018-06-09 09:21:30 +02:00
# include <config.h>
#endif /* HAVE_CONFIG_H */
2013-07-12 17:19:03 +02:00
#include <nghttp2/nghttp2.h>
2020-07-26 07:00:45 +02:00
#include "nghttp2_mem.h"
2013-12-04 16:41:42 +01:00
/* Implementation of unordered map */
2021-05-13 08:01:58 +02:00
typedef int32_t nghttp2_map_key_type;
2020-07-26 07:00:45 +02:00
typedef struct nghttp2_map_bucket {
2021-05-13 08:01:58 +02:00
uint32_t hash;
nghttp2_map_key_type key;
void *data;
2020-07-26 07:00:45 +02:00
} nghttp2_map_bucket;
2021-05-13 08:01:58 +02:00
typedef struct nghttp2_map {
2020-07-26 07:00:45 +02:00
nghttp2_map_bucket *table;
nghttp2_mem *mem;
2012-01-25 18:28:58 +01:00
size_t size;
2015-09-23 07:41:53 +02:00
uint32_t tablelen;
2021-05-13 08:01:58 +02:00
uint32_t tablelenbits;
2013-07-12 17:19:03 +02:00
} nghttp2_map;
/*
* Initializes the map |map|.
2013-12-04 16:41:42 +01:00
*
* This function returns 0 if it succeeds, or one of the following
* negative error codes:
*
* NGHTTP2_ERR_NOMEM
* Out of memory
*/
int nghttp2_map_init(nghttp2_map *map, nghttp2_mem *mem);
/*
* Deallocates any resources allocated for |map|. The stored entries
2013-07-12 17:19:03 +02:00
* are not freed by this function. Use nghttp2_map_each_free() to free
* each entries.
*/
2013-07-12 17:19:03 +02:00
void nghttp2_map_free(nghttp2_map *map);
/*
* Deallocates each entries using |func| function and any resources
* allocated for |map|. The |func| function is responsible for freeing
2021-05-13 08:01:58 +02:00
* given the |data| object. The |ptr| will be passed to the |func| as
* send argument. The return value of the |func| will be ignored.
*/
2021-05-13 08:01:58 +02:00
void nghttp2_map_each_free(nghttp2_map *map, int (*func)(void *data, void *ptr),
void *ptr);
/*
2021-05-13 08:01:58 +02:00
* Inserts the new |data| with the |key| to the map |map|.
*
* This function returns 0 if it succeeds, or one of the following
2013-12-04 16:41:42 +01:00
* negative error codes:
*
2013-07-12 17:19:03 +02:00
* NGHTTP2_ERR_INVALID_ARGUMENT
* The item associated by |key| already exists.
2013-12-04 16:41:42 +01:00
* NGHTTP2_ERR_NOMEM
* Out of memory
*/
2021-05-13 08:01:58 +02:00
int nghttp2_map_insert(nghttp2_map *map, nghttp2_map_key_type key, void *data);
/*
2021-05-13 08:01:58 +02:00
* Returns the data associated by the key |key|. If there is no such
* data, this function returns NULL.
*/
2021-05-13 08:01:58 +02:00
void *nghttp2_map_find(nghttp2_map *map, nghttp2_map_key_type key);
/*
2021-05-13 08:01:58 +02:00
* Removes the data associated by the key |key| from the |map|. The
* removed data is not freed by this function.
*
* This function returns 0 if it succeeds, or one of the following
* negative error codes:
*
2013-07-12 17:19:03 +02:00
* NGHTTP2_ERR_INVALID_ARGUMENT
2021-05-13 08:01:58 +02:00
* The data associated by |key| does not exist.
*/
2021-05-13 08:01:58 +02:00
int nghttp2_map_remove(nghttp2_map *map, nghttp2_map_key_type key);
2020-07-26 07:00:45 +02:00
/*
* Removes all entries from |map|.
*/
void nghttp2_map_clear(nghttp2_map *map);
/*
* Returns the number of items stored in the map |map|.
*/
2013-07-12 17:19:03 +02:00
size_t nghttp2_map_size(nghttp2_map *map);
2012-01-25 18:28:58 +01:00
/*
2021-05-13 08:01:58 +02:00
* Applies the function |func| to each data in the |map| with the
* optional user supplied pointer |ptr|.
*
* If the |func| returns 0, this function calls the |func| with the
2021-05-13 08:01:58 +02:00
* next data. If the |func| returns nonzero, it will not call the
* |func| for further entries and return the return value of the
* |func| immediately. Thus, this function returns 0 if all the
* invocations of the |func| return 0, or nonzero value which the last
* invocation of |func| returns.
*
2021-05-13 08:01:58 +02:00
* Don't use this function to free each data. Use
2013-07-12 17:19:03 +02:00
* nghttp2_map_each_free() instead.
*/
2021-05-13 08:01:58 +02:00
int nghttp2_map_each(nghttp2_map *map, int (*func)(void *data, void *ptr),
void *ptr);
2021-05-13 08:01:58 +02:00
void nghttp2_map_print_distance(nghttp2_map *map);
2013-07-12 17:19:03 +02:00
#endif /* NGHTTP2_MAP_H */