server/session.h

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