server/session.h

   1 /*
   2  * Copyright (C) 1995-1999, Index Data
   3  * See the file LICENSE for details.
   4  * Sebastian Hammer, Adam Dickmeiss
   5  *
   6  * $Log: session.h,v $
   7  * Revision 1.21  1999-11-30 13:47:12  adam
   8  * Improved installation. Moved header files to include/yaz.
   9  *
  10  * Revision 1.20  1999/10/11 10:01:24  adam
  11  * Implemented bend_sort_rr handler for frontend server.
  12  *
  13  * Revision 1.19  1999/04/20 09:56:48  adam
  14  * Added 'name' paramter to encoder/decoder routines (typedef Odr_fun).
  15  * Modified all encoders/decoders to reflect this change.
  16  *
  17  * Revision 1.18  1998/08/03 10:23:57  adam
  18  * Fixed bug regarding Options for Sort.
  19  *
  20  * Revision 1.17  1998/07/20 12:38:43  adam
  21  * Implemented delete result set service to server API.
  22  *
  23  * Revision 1.16  1998/03/31 11:07:45  adam
  24  * Furhter work on UNIverse resource report.
  25  * Added Extended Services handling in frontend server.
  26  *
  27  * Revision 1.15  1998/02/11 11:53:36  adam
  28  * Changed code so that it compiles as C++.
  29  *
  30  * Revision 1.14  1998/02/10 11:03:57  adam
  31  * Added support for extended handlers in backend server interface.
  32  *
  33  * Revision 1.13  1998/01/29 13:30:23  adam
  34  * Better event handle system for NT/Unix.
  35  *
  36  * Revision 1.12  1997/09/01 08:53:01  adam
  37  * New windows NT/95 port using MSV5.0. The test server 'ztest' was
  38  * moved a separate directory. MSV5.0 project server.dsp created.
  39  * As an option, the server can now operate as an NT service.
  40  *
  41  * Revision 1.11  1995/11/08 17:41:40  quinn
  42  * Smallish.
  43  *
  44  * Revision 1.10  1995/08/29  11:18:01  quinn
  45  * Added code to receive close
  46  *
  47  * Revision 1.9  1995/06/16  10:31:38  quinn
  48  * Added session timeout.
  49  *
  50  * Revision 1.8  1995/05/17  08:42:28  quinn
  51  * Transfer auth info to backend. Allow backend to reject init gracefully.
  52  *
  53  * Revision 1.7  1995/05/16  08:51:08  quinn
  54  * License, documentation, and memory fixes
  55  *
  56  * Revision 1.6  1995/05/15  11:56:41  quinn
  57  * Asynchronous facilities. Restructuring of seshigh code.
  58  *
  59  * Revision 1.5  1995/04/20  15:13:01  quinn
  60  * Cosmetic
  61  *
  62  * Revision 1.4  1995/04/10  10:23:39  quinn
  63  * Some work to add scan and other things.
  64  *
  65  * Revision 1.3  1995/03/30  09:09:27  quinn
  66  * Added state-handle and some support for asynchronous activities.
  67  *
  68  * Revision 1.2  1995/03/27  08:34:29  quinn
  69  * Added dynamic server functionality.
  70  * Released bindings to session.c (is now redundant)
  71  *
  72  * Revision 1.1  1995/03/14  10:28:02  quinn
  73  * More work on demo server.
  74  *
  75  *
  76  */
  77
  78 #ifndef SESSION_H
  79 #define SESSION_H
  80
  81 #include <sys/types.h>
  82 #include <yaz/comstack.h>
  83 #include <yaz/odr.h>
  84 #include <yaz/oid.h>
  85 #include <yaz/proto.h>
  86 #include "eventl.h"
  87
  88 typedef enum {
  89         REQUEST_IDLE,    /* the request is just sitting in the queue */
  90         REQUEST_PENDING  /* operation pending (b'end processing or network I/O*/
  91         /* this list will have more elements when acc/res control is added */
  92 } request_state;
  93
  94 typedef struct request
  95 {
  96     int len_refid;          /* length of referenceid */
  97     char *refid;            /* referenceid */
  98     request_state state;
  99
 100     Z_APDU *request;        /* Current request */
 101     NMEM request_mem;    /* memory handle for request */
 102
 103     int size_response;     /* size of buffer */
 104     int len_response;      /* length of encoded data */
 105     char *response;        /* encoded data waiting for transmission */
 106
 107     void *clientData;
 108     struct request *next;
 109     struct request_q *q;
 110 } request;
 111
 112 typedef struct request_q
 113 {
 114     request *head;
 115     request *tail;
 116     request *list;
 117     int num;
 118 } request_q;
 119
 120 /*
 121  * association state.
 122  */
 123 typedef enum
 124 {
 125     ASSOC_NEW,                /* not initialized yet */
 126     ASSOC_UP,                 /* normal operation */
 127     ASSOC_DEAD                /* dead. Close if input arrives */
 128 } association_state;
 129
 130 typedef struct association
 131 {
 132     IOCHAN client_chan;           /* event-loop control */
 133     COMSTACK client_link;         /* communication handle */
 134     ODR decode;                   /* decoding stream */
 135     ODR encode;                   /* encoding stream */
 136     ODR print;                    /* printing stream (for -a) */
 137     char *encode_buffer;          /* temporary buffer for encoded data */
 138     int encoded_len;              /* length of encoded data */
 139     char *input_buffer;           /* input buffer (allocated by comstack) */
 140     int input_buffer_len;         /* length (size) of buffer */
 141     int input_apdu_len;           /* length of current incoming APDU */
 142     oid_proto proto;              /* protocol (PROTO_Z3950/PROTO_SR) */
 143     void *backend;                /* backend handle */
 144     request_q incoming;           /* Q of incoming PDUs */
 145     request_q outgoing;           /* Q of outgoing data buffers (enc. PDUs) */
 146     association_state state;
 147
 148     /* session parameters */
 149     int preferredMessageSize;
 150     int maximumRecordSize;
 151     int version;                  /* highest version-bit set (2 or 3) */
 152
 153     int (*bend_sort) ();
 154     int (*bend_search) ();
 155     int (*bend_present) ();
 156     int (*bend_esrequest) ();
 157     int (*bend_delete) ();
 158     int (*bend_scan) ();
 159 } association;
 160
 161 association *create_association(IOCHAN channel, COMSTACK link);
 162 void destroy_association(association *h);
 163 void ir_session(IOCHAN h, int event);
 164
 165 void request_enq(request_q *q, request *r);
 166 request *request_head(request_q *q);
 167 request *request_deq(request_q *q);
 168 request *request_deq_x(request_q *q, request *r);
 169 void request_initq(request_q *q);
 170 void request_delq(request_q *q);
 171 request *request_get(request_q *q);
 172 void request_release(request *r);
 173
 174 #endif