cachedb.h

Go to the documentation of this file.

/*
 * cachedb/cachedb.h - cache from a database external to the program module
 *
 * Copyright (c) 2016, NLnet Labs. All rights reserved.
 *
 * This software is open source.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * 
 * Neither the name of the NLNET LABS nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "util/module.h"
struct cachedb_backend;

struct cachedb_env {
    int enabled;

    struct cachedb_backend* backend;

    void* backend_data;
};

struct cachedb_qstate {
    int todo;
};

struct cachedb_backend {
    const char* name;

    int (*init)(struct module_env*, struct cachedb_env*);

    void (*deinit)(struct module_env*, struct cachedb_env*);

    int (*lookup)(struct module_env*, struct cachedb_env*, char*,
        struct sldns_buffer*);
    
    void (*store)(struct module_env*, struct cachedb_env*, char*,
        uint8_t*, size_t);
};
 
#define CACHEDB_HASHSIZE 256 /* bit hash */

int cachedb_init(struct module_env* env, int id);
void cachedb_deinit(struct module_env* env, int id);
void cachedb_operate(struct module_qstate* qstate, enum module_ev event,
    int id, struct outbound_entry* outbound);
void cachedb_inform_super(struct module_qstate* qstate, int id,
    struct module_qstate* super);
void cachedb_clear(struct module_qstate* qstate, int id);
size_t cachedb_get_mem(struct module_env* env, int id);

struct module_func_block* cachedb_get_funcblock(void);