src/session.h

   1 /*
   2  * Copyright (C) 1995-2005, Index Data ApS
   3  * See the file LICENSE for details.
   4  *
   5  * $Id: session.h,v 1.7 2005-03-03 23:16:20 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/oid.h>
  18 #include <yaz/proto.h>
  19 #include <yaz/backend.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     struct gfs_server *next;
  29 };
  30
  31 struct gfs_listen {
  32     char *id;
  33     char *address;
  34     struct gfs_listen *next;
  35 };
  36
  37 typedef enum {
  38     REQUEST_IDLE,    /* the request is just sitting in the queue */
  39     REQUEST_PENDING  /* operation pending (b'end processing or network I/O*/
  40     /* this list will have more elements when acc/res control is added */
  41 } request_state;
  42
  43 typedef struct request
  44 {
  45     int len_refid;          /* length of referenceid */
  46     char *refid;            /* referenceid */
  47     request_state state;
  48
  49     Z_GDU *gdu_request;     /* Current request */
  50     Z_APDU *apdu_request;   /* Current Z39.50 request */
  51     NMEM request_mem;    /* memory handle for request */
  52
  53     int size_response;     /* size of buffer */
  54     int len_response;      /* length of encoded data */
  55     char *response;        /* encoded data waiting for transmission */
  56
  57     void *clientData;
  58     struct request *next;
  59     struct request_q *q;
  60 } request;
  61
  62 typedef struct request_q
  63 {
  64     request *head;
  65     request *tail;
  66     request *list;
  67     int num;
  68 } request_q;
  69
  70 /*
  71  * association state.
  72  */
  73 typedef enum
  74 {
  75     ASSOC_NEW,                /* not initialized yet */
  76     ASSOC_UP,                 /* normal operation */
  77     ASSOC_DEAD                /* dead. Close if input arrives */
  78 } association_state;
  79
  80 typedef struct association
  81 {
  82     IOCHAN client_chan;           /* event-loop control */
  83     COMSTACK client_link;         /* communication handle */
  84     ODR decode;                   /* decoding stream */
  85     ODR encode;                   /* encoding stream */
  86     ODR print;                    /* printing stream (for -a) */
  87     char *encode_buffer;          /* temporary buffer for encoded data */
  88     int encoded_len;              /* length of encoded data */
  89     char *input_buffer;           /* input buffer (allocated by comstack) */
  90     int input_buffer_len;         /* length (size) of buffer */
  91     int input_apdu_len;           /* length of current incoming APDU */
  92     oid_proto proto;              /* protocol (PROTO_Z3950/PROTO_SR) */
  93     void *backend;                /* backend handle */
  94     request_q incoming;           /* Q of incoming PDUs */
  95     request_q outgoing;           /* Q of outgoing data buffers (enc. PDUs) */
  96     association_state state;
  97
  98     /* session parameters */
  99     int preferredMessageSize;
 100     int maximumRecordSize;
 101     int version;                  /* highest version-bit set (2 or 3) */
 102
 103     unsigned cs_get_mask;
 104     unsigned cs_put_mask;
 105     unsigned cs_accept_mask;
 106
 107     struct bend_initrequest *init;
 108     statserv_options_block *last_control;
 109     cql_transform_t cql_transform;
 110     void *server_node_ptr;
 111 } association;
 112
 113 association *create_association(IOCHAN channel, COMSTACK link,
 114                                 const char *apdufile);
 115 void destroy_association(association *h);
 116 void ir_session(IOCHAN h, int event);
 117
 118 void request_enq(request_q *q, request *r);
 119 request *request_head(request_q *q);
 120 request *request_deq(request_q *q);
 121 request *request_deq_x(request_q *q, request *r);
 122 void request_initq(request_q *q);
 123 void request_delq(request_q *q);
 124 request *request_get(request_q *q);
 125 void request_release(request *r);
 126
 127 int statserv_must_terminate(void);
 128
 129 int control_association(association *assoc, const char *host, int force);
 130
 131 #endif