More work on retrieve.

[idzebra-moved-to-github.git] / include / recctrl.h

diff --git a/include/recctrl.h b/include/recctrl.h
index ed6ace9..5622096 100644 (file)
--- a/include/recctrl.h
+++ b/include/recctrl.h
@@ -4,7 +4,16 @@
  * Sebastian Hammer, Adam Dickmeiss
  *
  * $Log: recctrl.h,v $
- * Revision 1.1  1995-09-14 07:48:13  adam
+ * Revision 1.4  1995-09-27 16:17:29  adam
+ * More work on retrieve.
+ *
+ * Revision 1.3  1995/09/27  12:21:25  adam
+ * New function: recType_byName.
+ *
+ * Revision 1.2  1995/09/15  14:45:03  adam
+ * Retrieve control.
+ *
+ * Revision 1.1  1995/09/14  07:48:13  adam
  * Record control management.
  *
  */
@@ -12,6 +21,10 @@
 #ifndef RECCTRL_H
 #define RECCTRL_H
 
+#include <oid.h>
+#include <odr.h>
+
+/* single word entity */
 typedef struct {
     int  attrSet;
     int  attrUse;
@@ -26,18 +39,37 @@ typedef struct {
     int seqno;
 } RecWord;
 
+/* Extract record control */
 struct recExtractCtrl {
-    FILE *inf;
-    char *subType;
-    void (*init)(RecWord *p);
-    void (*add)(const RecWord *p);
+    /* input parameters ... */
+    FILE *inf;                         /* Extract from this file */
+    char *subType;                     /* Sub type - may be NULL */
+    void (*init)(RecWord *p);          /* Init of word spec */
+    void (*add)(const RecWord *p);     /* Addition of a single word */
+};
+
+/* Retrieve record control */
+struct recRetrieveCtrl {
+    /* Input parameters ... */
+    ODR        odr;                    /* ODR used to create response */
+    int        fd;                     /* File descriptor and read function */
+    int       (*readf)(int fd, char *buf, size_t count);
+    oid_value  input_format;           /* Preferred record syntax */
+    
+    /* output parameters ... */
+    oid_value  output_format;          /* Record syntax of returned record */
+    void       *rec_buf;               /* Record buffer */
+    size_t     rec_len;                /* Length of record */
 };
 
 typedef struct recType
 {
-    char *name;
-    void (*init)(void);
-    int  (*extract)(struct recExtractCtrl *ctrl);
+    char *name;                        /* Name of record type */
+    void (*init)(void);                /* Init function - called once */
+    int  (*extract)(struct recExtractCtrl *ctrl);     /* Extract proc */
+    int  (*retrieve)(struct recRetrieveCtrl *ctrl);   /* Retrieve proc */
 } *RecType;
 
+RecType recType_byName (const char *name);
+
 #endif