usr.sbin/nscd/agent.h

   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
  27 #ifndef __NSCD_AGENT_H__
  28 #define __NSCD_AGENT_H__
  29
  30 /*
  31  * Agents are used to perform the actual lookups from the caching daemon.
  32  * There are two types of daemons: for common requests and for multipart
  33  * requests.
  34  * All agents are stored in the agents table, which is the singleton.
  35  */
  36
  37 enum agent_type {
  38     COMMON_AGENT = 0,
  39     MULTIPART_AGENT = 1
  40 };
  41
  42 struct agent {
  43         char    *name;
  44         enum agent_type type;
  45 };
  46
  47 struct common_agent {
  48         struct agent    parent;
  49         int (*lookup_func)(const char *, size_t, char **, size_t *);
  50 };
  51
  52 struct multipart_agent {
  53         struct agent    parent;
  54         void *(*mp_init_func)(void);
  55         int (*mp_lookup_func)(char **, size_t *, void *);
  56         void (*mp_destroy_func)(void *);
  57 };
  58
  59 struct agent_table {
  60         struct agent    **agents;
  61         size_t          agents_num;
  62 };
  63
  64 struct agent_table *init_agent_table(void);
  65 void register_agent(struct agent_table *, struct agent *);
  66 struct agent *find_agent(struct agent_table *, const char *, enum agent_type);
  67 void destroy_agent_table(struct agent_table *);
  68
  69 #endif