2 * Copyright (c) 1995, Index Data.
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,
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.
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.
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
26 * $Log: comstack.h,v $
27 * Revision 1.8 1995-09-27 15:02:46 quinn
28 * Modified function heads & prototypes.
30 * Revision 1.7 1995/06/19 12:38:24 quinn
31 * Reorganized include-files. Added small features.
33 * Revision 1.6 1995/05/30 10:54:51 quinn
34 * Added some backwards compatibility to the comstack (CS_SR->PROTO_SR)
36 * Revision 1.5 1995/05/29 08:11:31 quinn
37 * Moved oid from odr/asn to util.
39 * Revision 1.4 1995/05/16 08:50:29 quinn
40 * License, documentation, and memory fixes
42 * Revision 1.3 1995/04/20 15:12:44 quinn
45 * Revision 1.2 1995/04/17 11:28:17 quinn
48 * Revision 1.1 1995/03/30 09:39:40 quinn
49 * Moved .h files to include directory
51 * Revision 1.11 1995/03/27 08:36:05 quinn
52 * Some work on nonblocking operation in xmosi.c and rfct.c.
53 * Added protocol parameter to cs_create()
55 * Revision 1.10 1995/03/20 09:47:12 quinn
56 * Added server-side support to xmosi.c
57 * Fixed possible problems in rfct
60 * Revision 1.9 1995/03/15 15:36:27 quinn
61 * Mods to support nonblocking I/O
63 * Revision 1.8 1995/03/14 17:00:07 quinn
64 * Bug-fixes - added tracing info to tcpip.c
66 * Revision 1.7 1995/03/14 10:28:35 quinn
67 * Adding server-side support to tcpip.c and fixing bugs in nonblocking I/O
69 * Revision 1.6 1995/03/07 16:29:45 quinn
72 * Revision 1.5 1995/03/07 10:39:31 quinn
75 * Revision 1.4 1995/03/06 16:49:29 adam
76 * COMSTACK type inspection possible with cs_type.
78 * Revision 1.3 1995/02/14 11:54:48 quinn
79 * Beginning to add full CCL.
81 * Revision 1.2 1995/02/10 18:58:10 quinn
82 * Fixed tcpip_get (formerly tcpip_read).
83 * Turned tst (cli) into a proper, event-driven thing.
85 * Revision 1.1 1995/02/09 15:51:51 quinn
97 #define COMSTACK_DEFAULT_TIMEOUT -1 /* not used yet */
100 typedef struct comstack *COMSTACK;
101 typedef COMSTACK (*CS_TYPE)(int blocking, int protocol);
106 int errno; /* current error code of this stack */
107 char *stackerr;/* current lower-layer error string, or null if none */
108 int iofile; /* UNIX file descriptor for iochannel */
109 int timeout; /* how long to wait for trailing blocks (ignored for now) */
110 void *private; /* state info for lower stack */
111 int more; /* connection has extra data in buffer */
112 int state; /* current state */
117 #define CS_DATAXFER 4
118 int newfd; /* storing new descriptor between listen and accept */
119 int blocking; /* is this link (supposed to be) blocking? */
120 int event; /* current event */
126 enum oid_proto protocol; /* what application protocol are we talking? */
127 int (*f_look)(COMSTACK handle);
128 int (*f_put)(COMSTACK handle, char *buf, int size);
129 int (*f_get)(COMSTACK handle, char **buf, int *bufsize);
130 int (*f_more)(COMSTACK handle);
131 int (*f_connect)(COMSTACK handle, void *address);
132 int (*f_rcvconnect)(COMSTACK handle);
133 int (*f_bind)(COMSTACK handle, void *address, int mode);
136 int (*f_listen)(COMSTACK handle, char *addrp, int *addrlen);
137 COMSTACK (*f_accept)(COMSTACK handle);
138 int (*f_close)(COMSTACK handle);
141 #define cs_put(handle, buf, size) ((*(handle)->f_put)(handle, buf, size))
142 #define cs_get(handle, buf, size) ((*(handle)->f_get)(handle, buf, size))
143 #define cs_more(handle) ((*(handle)->f_more)(handle))
144 #define cs_connect(handle, address) ((*(handle)->f_connect)(handle, address))
145 #define cs_rcvconnect(handle) ((*(handle)->f_rcvconnect)(handle))
146 #define cs_bind(handle, ad, mo) ((*(handle)->f_bind)(handle, ad, mo))
147 #define cs_listen(handle, ap, al) ((*(handle)->f_listen)(handle, ap, al))
148 #define cs_accept(handle) ((*(handle)->f_accept)(handle))
149 #define cs_close(handle) ((*(handle)->f_close)(handle))
150 #define cs_create(type, blocking, proto) ((*type)(blocking, proto))
151 #define cs_type(handle) ((handle)->type)
152 #define cs_fileno(handle) ((handle)->iofile)
153 #define cs_stackerr(handle) ((handle)->stackerr)
154 #define cs_getstate(handle) ((handle)->getstate)
155 #define cs_errno(handle) ((handle)->errno)
156 #define cs_getproto(handle) ((handle)->protocol)
158 const char MDF *cs_strerror(COMSTACK h);
170 extern char *cs_errlist[];
172 /* backwards compatibility */
173 #define CS_SR PROTO_SR
174 #define CS_Z3950 PROTO_Z3950