src/src/lookupapi.h

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) University of Cambridge 1995 - 2015 */
   6 /* See the file NOTICE for conditions of use and distribution. */
   7
   8
   9 /* The "type" field in each item is a set of bit flags:
  10
  11   lookup_querystyle     => this is a query-style lookup,
  12                              else single-key (+ file) style
  13   lookup_absfile        => an absolute file name is required,
  14                              (for single-key style only)
  15 */
  16
  17 typedef struct lookup_info {
  18   uschar *name;                   /* e.g. "lsearch" */
  19   int type;                       /* query/singlekey/abs-file */
  20   void *(*open)(                  /* open function */
  21     const uschar *,               /* file name for those that have one */
  22     uschar **);                   /* for error message */
  23   BOOL (*check)(                  /* file checking function */
  24     void *,                       /* handle */
  25     const uschar *,               /* file name */
  26     int,                          /* modemask for file checking */
  27     uid_t *,                      /* owners for file checking */
  28     gid_t *,                      /* owngroups for file checking */
  29     uschar **);                   /* for error messages */
  30   int (*find)(                    /* find function */
  31     void *,                       /* handle */
  32     const uschar *,               /* file name or NULL */
  33     const uschar *,               /* key or query */
  34     int,                          /* length of key or query */
  35     uschar **,                    /* for returning answer */
  36     uschar **,                    /* for error message */
  37     uint *,                       /* cache TTL, seconds */
  38     const uschar *);              /* options */
  39   void (*close)(                  /* close function */
  40     void *);                      /* handle */
  41   void (*tidy)(void);             /* tidy function */
  42   uschar *(*quote)(               /* quoting function */
  43     uschar *,                     /* string to quote */
  44     uschar *);                    /* additional data from quote name */
  45   void (*version_report)(         /* diagnostic function */
  46     FILE *);                      /* fh to write to */
  47 } lookup_info;
  48
  49 /* This magic number is used by the following lookup_module_info structure
  50    for checking API compatibility. It used to be equivalent to the string"LMM3" */
  51 #define LOOKUP_MODULE_INFO_MAGIC 0x4c4d4933
  52 /* Version 2 adds: version_report */
  53 /* Version 3 change: non/cache becomes TTL in seconds */
  54
  55 typedef struct lookup_module_info {
  56   uint magic;
  57   lookup_info **lookups;
  58   uint lookupcount;
  59 } lookup_module_info;
  60
  61 /* End of lookupapi.h */