src/session.h

   1 /*
   2  * Copyright (C) 1995-2007, Index Data ApS
   3  * See the file LICENSE for details.
   4  *
   5  * $Id: session.h,v 1.15 2007-08-13 16:46:19 mike Exp $
   6  */
   7 /**
   8  * \file session.h
   9  * \brief Internal Header for GFS.
  10  */
  11 #ifndef SESSION_H
  12 #define SESSION_H
  13
  14 #include <yaz/comstack.h>
  15 #include <yaz/cql.h>
  16 #include <yaz/ccl.h>
  17 #include <yaz/odr.h>
  18 #include <yaz/proto.h>
  19 #include <yaz/backend.h>
  20 #include <yaz/retrieval.h>
  21 #include "eventl.h"
  22
  23 struct gfs_server {
  24     statserv_options_block cb;
  25     char *host;
  26     int listen_ref;
  27     cql_transform_t cql_transform;
  28     CCL_bibset ccl_transform;
  29     void *server_node_ptr;
  30     char *directory;
  31     char *docpath;
  32     char *stylesheet;
  33     yaz_retrieval_t retrieval;
  34     struct gfs_server *next;
  35 };
  36
  37 struct gfs_listen {
  38     char *id;
  39     char *address;
  40     struct gfs_listen *next;
  41 };
  42
  43 typedef enum {
  44     REQUEST_IDLE,    /* the request is just sitting in the queue */
  45     REQUEST_PENDING  /* operation pending (b'end processing or network I/O*/
  46     /* this list will have more elements when acc/res control is added */
  47 } request_state;
  48
  49 typedef struct request
  50 {
  51     int len_refid;          /* length of referenceid */
  52     char *refid;            /* referenceid */
  53     request_state state;
  54
  55     Z_GDU *gdu_request;     /* Current request */
  56     Z_APDU *apdu_request;   /* Current Z39.50 request */
  57     NMEM request_mem;    /* memory handle for request */
  58
  59     int size_response;     /* size of buffer */
  60     int len_response;      /* length of encoded data */
  61     char *response;        /* encoded data waiting for transmission */
  62
  63     void *clientData;
  64     struct request *next;
  65     struct request_q *q;
  66 } request;
  67
  68 typedef struct request_q
  69 {
  70     request *head;
  71     request *tail;
  72     request *list;
  73     int num;
  74 } request_q;
  75
  76 /*
  77  * association state.
  78  */
  79 typedef enum
  80 {
  81     ASSOC_NEW,                /* not initialized yet */
  82     ASSOC_UP,                 /* normal operation */
  83     ASSOC_DEAD                /* dead. Close if input arrives */
  84 } association_state;
  85
  86 typedef struct association
  87 {
  88     IOCHAN client_chan;           /* event-loop control */
  89     COMSTACK client_link;         /* communication handle */
  90     ODR decode;                   /* decoding stream */
  91     ODR encode;                   /* encoding stream */
  92     ODR print;                    /* printing stream (for -a) */
  93     char *encode_buffer;          /* temporary buffer for encoded data */
  94     int encoded_len;              /* length of encoded data */
  95     char *input_buffer;           /* input buffer (allocated by comstack) */
  96     int input_buffer_len;         /* length (size) of buffer */
  97     int input_apdu_len;           /* length of current incoming APDU */
  98     oid_proto proto;              /* protocol (PROTO_Z3950/PROTO_SR) */
  99     void *backend;                /* backend handle */
 100     request_q incoming;           /* Q of incoming PDUs */
 101     request_q outgoing;           /* Q of outgoing data buffers (enc. PDUs) */
 102     association_state state;
 103
 104     /* session parameters */
 105     int preferredMessageSize;
 106     int maximumRecordSize;
 107     int version;                  /* highest version-bit set (2 or 3) */
 108
 109     unsigned cs_get_mask;
 110     unsigned cs_put_mask;
 111     unsigned cs_accept_mask;
 112
 113     struct bend_initrequest *init;
 114     statserv_options_block *last_control;
 115
 116     struct gfs_server *server;
 117 } association;
 118
 119 association *create_association(IOCHAN channel, COMSTACK link,
 120                                 const char *apdufile);
 121 void destroy_association(association *h);
 122 void ir_session(IOCHAN h, int event);
 123
 124 void request_enq(request_q *q, request *r);
 125 request *request_head(request_q *q);
 126 request *request_deq(request_q *q);
 127 request *request_deq_x(request_q *q, request *r);
 128 void request_initq(request_q *q);
 129 void request_delq(request_q *q);
 130 request *request_get(request_q *q);
 131 void request_release(request *r);
 132
 133 int statserv_must_terminate(void);
 134
 135 int control_association(association *assoc, const char *host, int force);
 136
 137 int ir_read(IOCHAN h, int event);
 138
 139 #endif
 140 /*
 141  * Local variables:
 142  * c-basic-offset: 4
 143  * indent-tabs-mode: nil
 144  * End:
 145  * vim: shiftwidth=4 tabstop=8 expandtab
 146  */
 147