Electroneum
cachedb.h
Go to the documentation of this file.
1 /*
2  * cachedb/cachedb.h - cache from a database external to the program module
3  *
4  * Copyright (c) 2016, NLnet Labs. All rights reserved.
5  *
6  * This software is open source.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * Redistributions of source code must retain the above copyright notice,
13  * this list of conditions and the following disclaimer.
14  *
15  * Redistributions in binary form must reproduce the above copyright notice,
16  * this list of conditions and the following disclaimer in the documentation
17  * and/or other materials provided with the distribution.
18  *
19  * Neither the name of the NLNET LABS nor the names of its contributors may
20  * be used to endorse or promote products derived from this software without
21  * specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
29  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
30  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34  */
35 
42 #include "util/module.h"
43 struct cachedb_backend;
44 
50 struct cachedb_env {
52  int enabled;
53 
56 
58  void* backend_data;
59 };
60 
65  int todo;
66 };
67 
73  const char* name;
74 
76  int (*init)(struct module_env*, struct cachedb_env*);
77 
79  void (*deinit)(struct module_env*, struct cachedb_env*);
80 
82  int (*lookup)(struct module_env*, struct cachedb_env*, char*,
83  struct sldns_buffer*);
84 
86  void (*store)(struct module_env*, struct cachedb_env*, char*,
87  uint8_t*, size_t);
88 };
89 
90 #define CACHEDB_HASHSIZE 256 /* bit hash */
91 
93 int cachedb_init(struct module_env* env, int id);
95 void cachedb_deinit(struct module_env* env, int id);
97 void cachedb_operate(struct module_qstate* qstate, enum module_ev event,
98  int id, struct outbound_entry* outbound);
100 void cachedb_inform_super(struct module_qstate* qstate, int id,
101  struct module_qstate* super);
103 void cachedb_clear(struct module_qstate* qstate, int id);
105 size_t cachedb_get_mem(struct module_env* env, int id);
106 
112 
Definition: outbound_list.h:61
void cachedb_operate(struct module_qstate *qstate, enum module_ev event, int id, struct outbound_entry *outbound)
void * backend_data
Definition: cachedb.h:58
int(* lookup)(struct module_env *, struct cachedb_env *, char *, struct sldns_buffer *)
Definition: cachedb.h:82
unsigned char uint8_t
Definition: stdint.h:124
int cachedb_init(struct module_env *env, int id)
void cachedb_deinit(struct module_env *env, int id)
int(* init)(struct module_env *, struct cachedb_env *)
Definition: cachedb.h:76
size_t cachedb_get_mem(struct module_env *env, int id)
void cachedb_clear(struct module_qstate *qstate, int id)
struct cachedb_backend * backend
Definition: cachedb.h:55
void cachedb_inform_super(struct module_qstate *qstate, int id, struct module_qstate *super)
struct module_func_block * cachedb_get_funcblock(void)
module_ev
Definition: module.h:536
const char * name
Definition: cachedb.h:73
int enabled
Definition: cachedb.h:52
void(* deinit)(struct module_env *, struct cachedb_env *)
Definition: cachedb.h:79
void(* store)(struct module_env *, struct cachedb_env *, char *, uint8_t *, size_t)
Definition: cachedb.h:86