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