YAZ version 1.4.
[yaz-moved-to-github.git] / include / backend.h
index 7d5dcef..b4ffc12 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1995, Index Data.
+ * Copyright (c) 1995-1997, Index Data.
  *
  * Permission to use, copy, modify, distribute, and sell this software and
  * its documentation, in whole or in part, for any purpose, is hereby granted,
  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  * OF THIS SOFTWARE.
  *
+ * $Log: backend.h,v $
+ * Revision 1.16  1997-09-17 12:10:31  adam
+ * YAZ version 1.4.
+ *
  */
 
 #ifndef BACKEND_H
@@ -40,6 +44,7 @@ typedef struct bend_initrequest
 {
     char *configname;
     Z_IdAuthentication *auth;
+    ODR stream;                /* encoding stream */
 } bend_initrequest;
 
 typedef struct bend_initresult
@@ -49,7 +54,7 @@ typedef struct bend_initresult
     void *handle;              /* private handle to the backend module */
 } bend_initresult;
 
-bend_initresult MDF *bend_init(bend_initrequest *r);   
+YAZ_EXPORT bend_initresult MDF *bend_init(bend_initrequest *r);   
 
 typedef struct bend_searchrequest
 {
@@ -58,6 +63,7 @@ typedef struct bend_searchrequest
     int num_bases;             /* number of databases in list */
     char **basenames;          /* databases to search */
     Z_Query *query;            /* query structure */
+    ODR stream;                /* encoding stream */
 } bend_searchrequest;
 
 typedef struct bend_searchresult
@@ -67,8 +73,9 @@ typedef struct bend_searchresult
     char *errstring;           /* system error string or NULL */
 } bend_searchresult;
 
-bend_searchresult *bend_search(void *handle, bend_searchrequest *r, int *fd);
-bend_searchresult *bend_searchresponse(void *handle);
+YAZ_EXPORT bend_searchresult *bend_search(void *handle, bend_searchrequest *r,
+                                          int *fd);
+YAZ_EXPORT bend_searchresult *bend_searchresponse(void *handle);
 
 typedef struct bend_fetchrequest
 {
@@ -90,8 +97,9 @@ typedef struct bend_fetchresult
     char *errstring;           /* system error string or NULL */
 } bend_fetchresult;
 
-bend_fetchresult *bend_fetch(void *handle, bend_fetchrequest *r, int *fd);
-bend_fetchresult *bend_fetchresponse(void *handle);
+YAZ_EXPORT bend_fetchresult *bend_fetch(void *handle, bend_fetchrequest *r,
+                                        int *fd);
+YAZ_EXPORT bend_fetchresult *bend_fetchresponse(void *handle);
 
 typedef struct bend_scanrequest
 {
@@ -101,28 +109,32 @@ typedef struct bend_scanrequest
     Z_AttributesPlusTerm *term;
     int term_position;  /* desired index of term in result list */
     int num_entries;    /* number of entries requested */
+    ODR stream;         /* encoding stream - memory source if required */
 } bend_scanrequest;
 
+struct scan_entry {
+    char *term;
+    int occurrences;
+};
+
+typedef enum {
+    BEND_SCAN_SUCCESS,   /* ok */
+    BEND_SCAN_PARTIAL   /* not all entries could be found */
+} bend_scan_status;
+
 typedef struct bend_scanresult
 {
     int num_entries;
-    struct scan_entry
-    {
-       char *term;
-       int occurrences;
-    } *entries;
+    struct scan_entry *entries;
     int term_position;
-    enum
-    {
-       BEND_SCAN_SUCCESS,   /* ok */
-       BEND_SCAN_PARTIAL   /* not all entries could be found */
-    } status;
+    bend_scan_status status;
     int errcode;
     char *errstring;
 } bend_scanresult;
 
-bend_scanresult *bend_scan(void *handle, bend_scanrequest *r, int *fd);
-bend_scanresult *bend_scanresponse(void *handle);
+YAZ_EXPORT bend_scanresult *bend_scan(void *handle, bend_scanrequest *r,
+                                      int *fd);
+YAZ_EXPORT bend_scanresult *bend_scanresponse(void *handle);
 
 typedef struct bend_deleterequest
 {
@@ -135,10 +147,11 @@ typedef struct bend_deleteresult
     char *errstring;           /* system error string or NULL */
 } bend_deleteresult;
 
-bend_deleteresult *bend_delete(void *handle, bend_deleterequest *r, int *fd);
-bend_deleteresult *bend_deleteresponse(void *handle);
+YAZ_EXPORT bend_deleteresult *bend_delete(void *handle,
+                                          bend_deleterequest *r, int *fd);
+YAZ_EXPORT bend_deleteresult *bend_deleteresponse(void *handle);
 
-void bend_close(void *handle);
+YAZ_EXPORT void bend_close(void *handle);
 
 #ifdef __cplusplus
 }