Move xml_add utilities to xml_add.c source
[yaz-moved-to-github.git] / src / session.h
1 /* This file is part of the YAZ toolkit.
2  * Copyright (C) 1995-2013 Index Data.
3  * All rights reserved.
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  *     * Redistributions of source code must retain the above copyright
8  *       notice, this list of conditions and the following disclaimer.
9  *     * Redistributions in binary form must reproduce the above copyright
10  *       notice, this list of conditions and the following disclaimer in the
11  *       documentation and/or other materials provided with the distribution.
12  *     * Neither the name of Index Data nor the names of its contributors
13  *       may be used to endorse or promote products derived from this
14  *       software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 /**
28  * \file session.h
29  * \brief Internal Header for GFS.
30  */
31 #ifndef SESSION_H
32 #define SESSION_H
33
34 #include <yaz/comstack.h>
35 #include <yaz/cql.h>
36 #include <yaz/ccl.h>
37 #include <yaz/odr.h>
38 #include <yaz/proto.h>
39 #include <yaz/backend.h>
40 #include <yaz/retrieval.h>
41 #include "eventl.h"
42
43 struct gfs_server {
44     statserv_options_block cb;
45     char *host;
46     char *id;
47     int listen_ref;
48     cql_transform_t cql_transform;
49     CCL_bibset ccl_transform;
50     void *server_node_ptr;
51     char *directory;
52     char *docpath;
53     char *stylesheet;
54     yaz_retrieval_t retrieval;
55     struct gfs_server *next;
56 };
57
58 struct gfs_listen {
59     char *id;
60     char *address;
61     struct gfs_listen *next;
62 };
63
64 typedef enum {
65     REQUEST_IDLE,    /* the request is just sitting in the queue */
66     REQUEST_PENDING  /* operation pending (b'end processing or network I/O*/
67     /* this list will have more elements when acc/res control is added */
68 } request_state;
69
70 typedef struct request
71 {
72     request_state state;
73
74     Z_GDU *gdu_request;     /* Current request */
75     Z_APDU *apdu_request;   /* Current Z39.50 request */
76     NMEM request_mem;    /* memory handle for request */
77
78     int size_response;     /* size of buffer */
79     int len_response;      /* length of encoded data */
80     char *response;        /* encoded data waiting for transmission */
81
82     void *clientData;
83     struct request *next;
84     struct request_q *q;
85 } request;
86
87 typedef struct request_q
88 {
89     request *head;
90     request *tail;
91     request *list;
92     int num;
93 } request_q;
94
95 /*
96  * association state.
97  */
98 typedef enum
99 {
100     ASSOC_NEW,                /* not initialized yet or HTTP session */
101     ASSOC_UP,                 /* Z39.50 session is UP */
102     ASSOC_DEAD                /* dead. Close if input arrives */
103 } association_state;
104
105 typedef struct association
106 {
107     IOCHAN client_chan;           /* event-loop control */
108     COMSTACK client_link;         /* communication handle */
109     ODR decode;                   /* decoding stream */
110     ODR encode;                   /* encoding stream */
111     ODR print;                    /* printing stream (for -a) */
112     char *encode_buffer;          /* temporary buffer for encoded data */
113     int encoded_len;              /* length of encoded data */
114     char *input_buffer;           /* input buffer (allocated by comstack) */
115     int input_buffer_len;         /* length (size) of buffer */
116     int input_apdu_len;           /* length of current incoming APDU */
117     oid_proto proto;              /* protocol (PROTO_Z3950/PROTO_SR) */
118     void *backend;                /* backend handle */
119     request_q incoming;           /* Q of incoming PDUs */
120     request_q outgoing;           /* Q of outgoing data buffers (enc. PDUs) */
121     association_state state;
122
123     /* session parameters */
124     int preferredMessageSize;
125     int maximumRecordSize;
126     int version;                  /* highest version-bit set (2 or 3) */
127
128     int cs_get_mask;
129     int cs_put_mask;
130     int cs_accept_mask;
131
132     struct bend_initrequest *init;
133     statserv_options_block *last_control;
134
135     struct gfs_server *server;
136 } association;
137
138 association *create_association(IOCHAN channel, COMSTACK link,
139                                 const char *apdufile);
140 void destroy_association(association *h);
141 void ir_session(IOCHAN h, int event);
142
143 void request_enq(request_q *q, request *r);
144 request *request_head(request_q *q);
145 request *request_deq(request_q *q);
146 request *request_deq_x(request_q *q, request *r);
147 void request_initq(request_q *q);
148 void request_delq(request_q *q);
149 request *request_get(request_q *q);
150 void request_release(request *r);
151
152 int control_association(association *assoc, const char *host, int force);
153
154 int ir_read(IOCHAN h, int event);
155
156 #endif
157 /*
158  * Local variables:
159  * c-basic-offset: 4
160  * c-file-style: "Stroustrup"
161  * indent-tabs-mode: nil
162  * End:
163  * vim: shiftwidth=4 tabstop=8 expandtab
164  */
165