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