Added prettier client.
[yaz-moved-to-github.git] / include / comstack.h
1 /*
2  * Copyright (c) 1995, Index Data.
3  *
4  * Permission to use, copy, modify, distribute, and sell this software and
5  * its documentation, in whole or in part, for any purpose, is hereby granted,
6  * provided that:
7  *
8  * 1. This copyright and permission notice appear in all copies of the
9  * software and its documentation. Notices of copyright or attribution
10  * which appear at the beginning of any file must remain unchanged.
11  *
12  * 2. The name of Index Data or the individual authors may not be used to
13  * endorse or promote products derived from this software without specific
14  * prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
18  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
19  * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
20  * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
21  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
22  * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
23  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
24  * OF THIS SOFTWARE.
25  *
26  * $Log: comstack.h,v $
27  * Revision 1.4  1995-05-16 08:50:29  quinn
28  * License, documentation, and memory fixes
29  *
30  * Revision 1.3  1995/04/20  15:12:44  quinn
31  * Cosmetic
32  *
33  * Revision 1.2  1995/04/17  11:28:17  quinn
34  * Smallish
35  *
36  * Revision 1.1  1995/03/30  09:39:40  quinn
37  * Moved .h files to include directory
38  *
39  * Revision 1.11  1995/03/27  08:36:05  quinn
40  * Some work on nonblocking operation in xmosi.c and rfct.c.
41  * Added protocol parameter to cs_create()
42  *
43  * Revision 1.10  1995/03/20  09:47:12  quinn
44  * Added server-side support to xmosi.c
45  * Fixed possible problems in rfct
46  * Other little mods
47  *
48  * Revision 1.9  1995/03/15  15:36:27  quinn
49  * Mods to support nonblocking I/O
50  *
51  * Revision 1.8  1995/03/14  17:00:07  quinn
52  * Bug-fixes - added tracing info to tcpip.c
53  *
54  * Revision 1.7  1995/03/14  10:28:35  quinn
55  * Adding server-side support to tcpip.c and fixing bugs in nonblocking I/O
56  *
57  * Revision 1.6  1995/03/07  16:29:45  quinn
58  * Various fixes.
59  *
60  * Revision 1.5  1995/03/07  10:39:31  quinn
61  * Added cs_fileno
62  *
63  * Revision 1.4  1995/03/06  16:49:29  adam
64  * COMSTACK type inspection possible with cs_type.
65  *
66  * Revision 1.3  1995/02/14  11:54:48  quinn
67  * Beginning to add full CCL.
68  *
69  * Revision 1.2  1995/02/10  18:58:10  quinn
70  * Fixed tcpip_get (formerly tcpip_read).
71  * Turned tst (cli) into a proper, event-driven thing.
72  *
73  * Revision 1.1  1995/02/09  15:51:51  quinn
74  * Works better now.
75  *
76  */
77
78 #ifndef COMSTACK_H
79 #define COMSTACK_H
80
81 #include <dmalloc.h>
82
83 #define COMSTACK_DEFAULT_TIMEOUT -1
84
85 struct comstack;
86 typedef struct comstack *COMSTACK;
87 typedef COMSTACK (*CS_TYPE)(int blocking, int protocol);
88
89 struct comstack
90 {
91     CS_TYPE type;
92     int errno;     /* current error code of this stack */
93     char *stackerr;/* current lower-layer error string, or null if none */
94     int iofile;    /* UNIX file descriptor for iochannel */
95     int timeout;   /* how long to wait for trailing blocks */          
96     void *private; /* state info for lower stack */
97     int more;      /* connection has extra data in buffer */
98     int state;     /* current state */
99 #define CS_UNBND      0
100 #define CS_IDLE       1
101 #define CS_INCON      2
102 #define CS_OUTCON     3
103 #define CS_DATAXFER   4
104     int newfd;     /* storing new descriptor between listen and accept */
105     int blocking;  /* is this link (supposed to be) blocking? */
106     int event;     /* current event */
107 #define CS_NONE       0
108 #define CS_CONNECT    1
109 #define CS_DISCON     2
110 #define CS_LISTEN     3
111 #define CS_DATA       4
112     int protocol;  /* what application protocol are we talking? */
113 #define CS_Z3950      0
114 #define CS_SR         1
115     int (*f_look)(COMSTACK handle);
116     int (*f_put)(COMSTACK handle, char *buf, int size);
117     int (*f_get)(COMSTACK handle, char **buf, int *bufsize);
118     int (*f_more)(COMSTACK handle);
119     int (*f_connect)(COMSTACK handle, void *address);
120     int (*f_rcvconnect)(COMSTACK handle);
121     int (*f_bind)(COMSTACK handle, void *address, int mode);
122 #define CS_CLIENT 0
123 #define CS_SERVER 1
124     int (*f_listen)(COMSTACK handle, char *addrp, int *addrlen);
125     COMSTACK (*f_accept)(COMSTACK handle);
126     int (*f_close)(COMSTACK handle);
127 };
128
129 #define cs_put(handle, buf, size) ((*(handle)->f_put)(handle, buf, size))
130 #define cs_get(handle, buf, size) ((*(handle)->f_get)(handle, buf, size))
131 #define cs_more(handle) ((*(handle)->f_more)(handle))
132 #define cs_connect(handle, address) ((*(handle)->f_connect)(handle, address))
133 #define cs_rcvconnect(handle) ((*(handle)->f_rcvconnect)(handle))
134 #define cs_bind(handle, ad, mo) ((*(handle)->f_bind)(handle, ad, mo))
135 #define cs_listen(handle, ap, al) ((*(handle)->f_listen)(handle, ap, al))
136 #define cs_accept(handle) ((*(handle)->f_accept)(handle))
137 #define cs_close(handle) ((*(handle)->f_close)(handle))
138 #define cs_create(type, blocking, proto) ((*type)(blocking, proto))
139 #define cs_type(handle) ((handle)->type)
140 #define cs_fileno(handle) ((handle)->iofile)
141 #define cs_stackerr(handle) ((handle)->stackerr)
142 #define cs_getstate(handle) ((handle)->getstate)
143 #define cs_errno(handle) ((handle)->errno)
144 #define cs_getproto(handle) ((handle)->protocol)
145
146 const char *cs_strerror(COMSTACK h);
147
148 /*
149  * error management.
150  */
151
152 #define CSNONE     0
153 #define CSYSERR    1
154 #define CSOUTSTATE 2
155 #define CSNODATA   3
156 #define CSWRONGBUF 4
157
158 extern char *cs_errlist[];
159
160 #endif