include/yaz/srw.h

   1 /*
   2  * Copyright (c) 2002-2003, Index Data.
   3  * See the file LICENSE for details.
   4  *
   5  * $Id: srw.h,v 1.9 2003-12-20 00:51:19 adam Exp $
   6  */
   7
   8 #ifndef YAZ_SRW_H
   9 #define YAZ_SRW_H
  10
  11 #include <yaz/soap.h>
  12 #include <yaz/zgdu.h>
  13
  14 YAZ_BEGIN_CDECL
  15
  16 typedef struct {
  17     char *recordSchema;
  18     int recordPacking;
  19 #define Z_SRW_recordPacking_string 0
  20 #define Z_SRW_recordPacking_XML 1
  21     char *recordData_buf;
  22     int recordData_len;
  23     int *recordPosition;
  24 } Z_SRW_record;
  25
  26 typedef struct {
  27     int  *code;
  28     char *details;
  29 } Z_SRW_diagnostic;
  30
  31 typedef struct {
  32
  33 #define Z_SRW_query_type_cql  1
  34 #define Z_SRW_query_type_xcql 2
  35 #define Z_SRW_query_type_pqf  3
  36     int query_type;
  37     union {
  38         char *cql;
  39         char *xcql;
  40         char *pqf;
  41     } query;
  42
  43 #define Z_SRW_sort_type_none 1
  44 #define Z_SRW_sort_type_sort 2
  45 #define Z_SRW_sort_type_xSort 3
  46     int sort_type;
  47     union {
  48         char *none;
  49         char *sortKeys;
  50         char *xSortKeys;
  51     } sort;
  52     int *startRecord;
  53     int  *maximumRecords;
  54     char *recordSchema;
  55     char *recordPacking;
  56     char *database;
  57 } Z_SRW_searchRetrieveRequest;
  58
  59 typedef struct {
  60     int * numberOfRecords;
  61     char * resultSetId;
  62     int * resultSetIdleTime;
  63
  64     Z_SRW_record *records;
  65     int num_records;
  66
  67     Z_SRW_diagnostic *diagnostics;
  68     int num_diagnostics;
  69     int *nextRecordPosition;
  70 } Z_SRW_searchRetrieveResponse;
  71
  72 typedef struct {
  73     char *recordPacking;
  74     char *database;
  75 } Z_SRW_explainRequest;
  76
  77 typedef struct {
  78     Z_SRW_record record;
  79 } Z_SRW_explainResponse;
  80
  81 #define Z_SRW_searchRetrieve_request  1
  82 #define Z_SRW_searchRetrieve_response 2
  83 #define Z_SRW_explain_request 3
  84 #define Z_SRW_explain_response 4
  85
  86 typedef struct {
  87     int which;
  88     union {
  89         Z_SRW_searchRetrieveRequest *request;
  90         Z_SRW_searchRetrieveResponse *response;
  91         Z_SRW_explainRequest *explain_request;
  92         Z_SRW_explainResponse *explain_response;
  93     } u;
  94     char *srw_version;
  95     char *database;
  96 } Z_SRW_PDU;
  97
  98 YAZ_EXPORT int yaz_srw_codec(ODR o, void * pptr,
  99                              Z_SRW_PDU **handler_data,
 100                              void *client_data, const char *ns);
 101 YAZ_EXPORT Z_SRW_PDU *yaz_srw_get(ODR o, int which);
 102
 103 YAZ_EXPORT const char *yaz_diag_srw_str (int code);
 104
 105 YAZ_EXPORT int yaz_diag_bib1_to_srw (int bib1_code);
 106
 107 YAZ_EXPORT int yaz_diag_srw_to_bib1(int srw_code);
 108
 109 YAZ_EXPORT char *yaz_uri_val(const char *path, const char *name, ODR o);
 110 YAZ_EXPORT void yaz_uri_val_int(const char *path, const char *name,
 111                                 ODR o, int **intp);
 112 YAZ_EXPORT int yaz_check_for_srw(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
 113                                  char **soap_ns, ODR decode);
 114 YAZ_EXPORT int yaz_check_for_sru(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
 115                                  char **soap_ns, ODR decode);
 116 YAZ_END_CDECL
 117
 118 #endif