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