xref: /freebsd/usr.sbin/nscd/agent.h (revision dd41de95a84d979615a2ef11df6850622bf6184e)
1 /*-
2  * Copyright (c) 2005 Michael Bushkov <bushman@rsu.ru>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef __NSCD_AGENT_H__
30 #define __NSCD_AGENT_H__
31 
32 /*
33  * Agents are used to perform the actual lookups from the caching daemon.
34  * There are two types of daemons: for common requests and for multipart
35  * requests.
36  * All agents are stored in the agents table, which is the singleton.
37  */
38 
39 enum agent_type {
40     COMMON_AGENT = 0,
41     MULTIPART_AGENT = 1
42 };
43 
44 struct agent {
45    	char	*name;
46     	enum agent_type type;
47 };
48 
49 struct common_agent {
50     	struct agent	parent;
51 	int (*lookup_func)(const char *, size_t, char **, size_t *);
52 };
53 
54 struct multipart_agent {
55     	struct agent	parent;
56 	void *(*mp_init_func)(void);
57     	int (*mp_lookup_func)(char **, size_t *, void *);
58 	void (*mp_destroy_func)(void *);
59 };
60 
61 struct agent_table {
62    	struct agent	**agents;
63 	size_t		agents_num;
64 };
65 
66 struct agent_table *init_agent_table(void);
67 void register_agent(struct agent_table *, struct agent *);
68 struct agent *find_agent(struct agent_table *, const char *, enum agent_type);
69 void destroy_agent_table(struct agent_table *);
70 
71 #endif
72