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