include/backend.h

   1 /*
   2  * Copyright (c) 1995, Index Data.
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and
   5  * its documentation, in whole or in part, for any purpose, is hereby granted,
   6  * provided that:
   7  *
   8  * 1. This copyright and permission notice appear in all copies of the
   9  * software and its documentation. Notices of copyright or attribution
  10  * which appear at the beginning of any file must remain unchanged.
  11  *
  12  * 2. The name of Index Data or the individual authors may not be used to
  13  * endorse or promote products derived from this software without specific
  14  * prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  18  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  19  * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
  20  * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
  21  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
  22  * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
  23  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  24  * OF THIS SOFTWARE.
  25  *
  26  */
  27
  28 #ifndef BACKEND_H
  29 #define BACKEND_H
  30
  31 #include <proto.h>
  32 #include <statserv.h>
  33
  34 typedef struct bend_initrequest
  35 {
  36     char *configname;
  37     Z_IdAuthentication *auth;
  38 } bend_initrequest;
  39
  40 typedef struct bend_initresult
  41 {
  42     int errcode;               /* 0==OK */
  43     char *errstring;           /* system error string or NULL */
  44     void *handle;              /* private handle to the backend module */
  45 } bend_initresult;
  46
  47 bend_initresult *bend_init(bend_initrequest *r);
  48
  49 typedef struct bend_searchrequest
  50 {
  51     char *setname;             /* name to give to this set */
  52     int replace_set;           /* replace set, if it already exists */
  53     int num_bases;             /* number of databases in list */
  54     char **basenames;          /* databases to search */
  55     Z_Query *query;            /* query structure */
  56 } bend_searchrequest;
  57
  58 typedef struct bend_searchresult
  59 {
  60     int hits;                  /* number of hits */
  61     int errcode;               /* 0==OK */
  62     char *errstring;           /* system error string or NULL */
  63 } bend_searchresult;
  64
  65 bend_searchresult *bend_search(void *handle, bend_searchrequest *r, int *fd);
  66 bend_searchresult *bend_searchresponse(void *handle);
  67
  68 typedef struct bend_fetchrequest
  69 {
  70     char *setname;             /* set name */
  71     int number;                /* record number */
  72     oid_value format;          /* One of the CLASS_RECSYN members */
  73 } bend_fetchrequest;
  74
  75 typedef struct bend_fetchresult
  76 {
  77     char *basename;            /* name of database that provided record */
  78     int len;                   /* length of record */
  79     char *record;              /* record */
  80     int last_in_set;           /* is it?  */
  81     oid_value format;          /* format */
  82     int errcode;               /* 0==success */
  83     char *errstring;           /* system error string or NULL */
  84 } bend_fetchresult;
  85
  86 bend_fetchresult *bend_fetch(void *handle, bend_fetchrequest *r, int *fd);
  87 bend_fetchresult *bend_fetchresponse(void *handle);
  88
  89 typedef struct bend_scanrequest
  90 {
  91     int num_bases;      /* number of elements in databaselist */
  92     char **basenames;   /* databases to search */
  93     Z_AttributesPlusTerm *term;
  94     int term_position;  /* desired index of term in result list */
  95     int num_entries;    /* number of entries requested */
  96 } bend_scanrequest;
  97
  98 typedef struct bend_scanresult
  99 {
 100     int num_entries;
 101     struct scan_entry
 102     {
 103         char *term;
 104         int occurrences;
 105     } *entries;
 106     int term_position;
 107     enum
 108     {
 109         BEND_SCAN_SUCCESS,   /* ok */
 110         BEND_SCAN_PARTIAL   /* not all entries could be found */
 111     } status;
 112     int errcode;
 113     char *errstring;
 114 } bend_scanresult;
 115
 116 bend_scanresult *bend_scan(void *handle, bend_scanrequest *r, int *fd);
 117 bend_scanresult *bend_scanresponse(void *handle);
 118
 119 typedef struct bend_deleterequest
 120 {
 121     char *setname;
 122 } bend_deleterequest;
 123
 124 typedef struct bend_deleteresult
 125 {
 126     int errcode;               /* 0==success */
 127     char *errstring;           /* system error string or NULL */
 128 } bend_deleteresult;
 129
 130 bend_deleteresult *bend_delete(void *handle, bend_deleterequest *r, int *fd);
 131 bend_deleteresult *bend_deleteresponse(void *handle);
 132
 133 void bend_close(void *handle);
 134
 135 #endif