lws-map.h

Go to the documentation of this file.

/*
 * libwebsockets - small server side websockets and web server implementation
 *
 * Copyright (C) 2010 - 2021 Andy Green <andy@warmcat.com>
 *
 * 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.
 */

 
typedef struct lws_map lws_map_t;
struct lws_map_item;
 
typedef void * lws_map_key_t;
typedef void * lws_map_value_t;
typedef uint32_t lws_map_hash_t;
 
typedef lws_map_hash_t (*lws_map_hash_from_key_t)(const lws_map_key_t key,
                                                  size_t kl);
typedef int (*lws_map_compare_key_t)(const lws_map_key_t key1, size_t kl1,
                                     const lws_map_value_t key2, size_t kl2);
typedef void * (*lws_map_alloc_t)(struct lws_map *mo, size_t x);
typedef void (*lws_map_free_t)(void *);
 
/*
 * Creation parameters for the map, copied into the map owner
 */
 
typedef struct lws_map_info {
        lws_map_hash_from_key_t          _hash;
        lws_map_compare_key_t              _compare;
        lws_map_alloc_t                  _alloc;   /* NULL = lws_malloc */
        lws_map_free_t                    _free;     /* NULL = lws_free */
 
        void                            *opaque;
        void                            *aux;
        size_t                          modulo;
} lws_map_info_t;
 
LWS_VISIBLE LWS_EXTERN const void *
lws_map_item_key(struct lws_map_item *_item);
LWS_VISIBLE LWS_EXTERN const void *
lws_map_item_value(struct lws_map_item *_item);
LWS_VISIBLE LWS_EXTERN size_t
lws_map_item_key_len(struct lws_map_item *_item);
LWS_VISIBLE LWS_EXTERN size_t
lws_map_item_value_len(struct lws_map_item *_item);
 
/*
 * Helpers for C string keys case
 */
 
#define lws_map_item_create_ks(_map, _str, _v, _vl) \
                lws_map_item_create(_map, (const lws_map_key_t)_str, \
                                    strlen(_str), (const lws_map_value_t)_v, \
                                                    _vl)
#define lws_map_item_lookup_ks(_map, _str) \
                lws_map_item_lookup(_map, (const lws_map_key_t)_str, strlen(_str))

LWS_VISIBLE LWS_EXTERN lws_map_t *
lws_map_create(const lws_map_info_t *info);
 
/*
 * helpers that can be used for info._alloc and info._free if using lwsac
 * allocation for items, set info.opaque to point to the lwsac pointer, and
 * aux to (void *)chunksize, or leave zero / NULL for the default
 */
 
LWS_VISIBLE LWS_EXTERN void *
lws_map_alloc_lwsac(struct lws_map *map, size_t x);
 
LWS_VISIBLE LWS_EXTERN void
lws_map_free_lwsac(void *v);

LWS_VISIBLE LWS_EXTERN void
lws_map_destroy(lws_map_t **pmap);

 
LWS_VISIBLE LWS_EXTERN struct lws_map_item *
lws_map_item_create(lws_map_t *map,
                    const lws_map_key_t key, size_t keylen,
                    const lws_map_value_t value, size_t valuelen);

LWS_VISIBLE LWS_EXTERN void
lws_map_item_destroy(struct lws_map_item *item);

 
LWS_VISIBLE LWS_EXTERN struct lws_map_item *
lws_map_item_lookup(lws_map_t *map, const lws_map_key_t key, size_t keylen);