fifo_string_cache.h

/* fifo_string_cache.h
 * A string cache, possibly with a bounded size, using FIFO order to control
 * the size.
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <gerald@wireshark.org>
 * Copyright 1998 Gerald Combs
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
#pragma once
#include <stdbool.h>
 
#include <glib.h>
 
#include "ws_symbol_export.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
typedef struct {
    GHashTable          *set;           
    GSList              *head;          
    GSList              *tail;          
    unsigned            max_entries;    
} fifo_string_cache_t;
 
// These functions are marked with WS_DLL_PUBLIC so they can be unit-tested
 
WS_DLL_PUBLIC void
fifo_string_cache_init(fifo_string_cache_t *fcache, unsigned max_entries, GDestroyNotify string_free_func);
 
WS_DLL_PUBLIC void
fifo_string_cache_free(fifo_string_cache_t *fcache);
 
WS_DLL_PUBLIC bool
fifo_string_cache_contains(fifo_string_cache_t *fcache, const char *entry);
 
WS_DLL_PUBLIC bool
fifo_string_cache_insert(fifo_string_cache_t *fcache, const char *entry);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */