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     ODR stream;                /* encoding stream - memory source if required */
  74 } bend_fetchrequest;
  75
  76 typedef struct bend_fetchresult
  77 {
  78     char *basename;            /* name of database that provided record */
  79     int len;                   /* length of record or -1 if structured */
  80     char *record;              /* record */
  81     int last_in_set;           /* is it?  */
  82     oid_value format;          /* format */
  83     int errcode;               /* 0==success */
  84     char *errstring;           /* system error string or NULL */
  85 } bend_fetchresult;
  86
  87 bend_fetchresult *bend_fetch(void *handle, bend_fetchrequest *r, int *fd);
  88 bend_fetchresult *bend_fetchresponse(void *handle);
  89
  90 typedef struct bend_scanrequest
  91 {
  92     int num_bases;      /* number of elements in databaselist */
  93     char **basenames;   /* databases to search */
  94     Z_AttributesPlusTerm *term;
  95     int term_position;  /* desired index of term in result list */
  96     int num_entries;    /* number of entries requested */
  97 } bend_scanrequest;
  98
  99 typedef struct bend_scanresult
 100 {
 101     int num_entries;
 102     struct scan_entry
 103     {
 104         char *term;
 105         int occurrences;
 106     } *entries;
 107     int term_position;
 108     enum
 109     {
 110         BEND_SCAN_SUCCESS,   /* ok */
 111         BEND_SCAN_PARTIAL   /* not all entries could be found */
 112     } status;
 113     int errcode;
 114     char *errstring;
 115 } bend_scanresult;
 116
 117 bend_scanresult *bend_scan(void *handle, bend_scanrequest *r, int *fd);
 118 bend_scanresult *bend_scanresponse(void *handle);
 119
 120 typedef struct bend_deleterequest
 121 {
 122     char *setname;
 123 } bend_deleterequest;
 124
 125 typedef struct bend_deleteresult
 126 {
 127     int errcode;               /* 0==success */
 128     char *errstring;           /* system error string or NULL */
 129 } bend_deleteresult;
 130
 131 bend_deleteresult *bend_delete(void *handle, bend_deleterequest *r, int *fd);
 132 bend_deleteresult *bend_deleteresponse(void *handle);
 133
 134 void bend_close(void *handle);
 135
 136 #endif