include/comstack.h

   1 /*
   2  * Copyright (c) 1995-1998, 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.20  1998-05-18 13:06:55  adam
  28  * Changed the way attribute sets are handled by the retriaval module.
  29  * Extended Explain conversion / schema.
  30  * Modified server and client to work with ASN.1 compiled protocol handlers.
  31  *
  32  * Revision 1.19  1997/09/29 07:16:14  adam
  33  * Array cs_errlist no longer global.
  34  *
  35  * Revision 1.18  1997/09/17 12:10:31  adam
  36  * YAZ version 1.4.
  37  *
  38  * Revision 1.17  1997/09/01 08:49:47  adam
  39  * New windows NT/95 port using MSV5.0. To export DLL functions the
  40  * YAZ_EXPORT modifier was added. Defined in yconfig.h.
  41  *
  42  * Revision 1.16  1997/05/14 06:53:37  adam
  43  * C++ support.
  44  *
  45  * Revision 1.15  1996/07/06 19:58:32  quinn
  46  * System headerfiles gathered in yconfig
  47  *
  48  * Revision 1.14  1996/02/10  12:23:41  quinn
  49  * Enable inetd operations fro TCP/IP stack
  50  *
  51  * Revision 1.13  1995/11/01  13:54:33  quinn
  52  * Minor adjustments
  53  *
  54  * Revision 1.12  1995/10/30  12:41:27  quinn
  55  * Added hostname lookup for server.
  56  *
  57  * Revision 1.11  1995/09/29  17:12:01  quinn
  58  * Smallish
  59  *
  60  * Revision 1.10  1995/09/29  17:01:48  quinn
  61  * More Windows work
  62  *
  63  * Revision 1.9  1995/09/28  10:12:36  quinn
  64  * Windows-support changes
  65  *
  66  * Revision 1.8  1995/09/27  15:02:46  quinn
  67  * Modified function heads & prototypes.
  68  *
  69  * Revision 1.7  1995/06/19  12:38:24  quinn
  70  * Reorganized include-files. Added small features.
  71  *
  72  * Revision 1.6  1995/05/30  10:54:51  quinn
  73  * Added some backwards compatibility to the comstack (CS_SR->PROTO_SR)
  74  *
  75  * Revision 1.5  1995/05/29  08:11:31  quinn
  76  * Moved oid from odr/asn to util.
  77  *
  78  * Revision 1.4  1995/05/16  08:50:29  quinn
  79  * License, documentation, and memory fixes
  80  *
  81  * Revision 1.3  1995/04/20  15:12:44  quinn
  82  * Cosmetic
  83  *
  84  * Revision 1.2  1995/04/17  11:28:17  quinn
  85  * Smallish
  86  *
  87  * Revision 1.1  1995/03/30  09:39:40  quinn
  88  * Moved .h files to include directory
  89  *
  90  * Revision 1.11  1995/03/27  08:36:05  quinn
  91  * Some work on nonblocking operation in xmosi.c and rfct.c.
  92  * Added protocol parameter to cs_create()
  93  *
  94  * Revision 1.10  1995/03/20  09:47:12  quinn
  95  * Added server-side support to xmosi.c
  96  * Fixed possible problems in rfct
  97  * Other little mods
  98  *
  99  * Revision 1.9  1995/03/15  15:36:27  quinn
 100  * Mods to support nonblocking I/O
 101  *
 102  * Revision 1.8  1995/03/14  17:00:07  quinn
 103  * Bug-fixes - added tracing info to tcpip.c
 104  *
 105  * Revision 1.7  1995/03/14  10:28:35  quinn
 106  * Adding server-side support to tcpip.c and fixing bugs in nonblocking I/O
 107  *
 108  * Revision 1.6  1995/03/07  16:29:45  quinn
 109  * Various fixes.
 110  *
 111  * Revision 1.5  1995/03/07  10:39:31  quinn
 112  * Added cs_fileno
 113  *
 114  * Revision 1.4  1995/03/06  16:49:29  adam
 115  * COMSTACK type inspection possible with cs_type.
 116  *
 117  * Revision 1.3  1995/02/14  11:54:48  quinn
 118  * Beginning to add full CCL.
 119  *
 120  * Revision 1.2  1995/02/10  18:58:10  quinn
 121  * Fixed tcpip_get (formerly tcpip_read).
 122  * Turned tst (cli) into a proper, event-driven thing.
 123  *
 124  * Revision 1.1  1995/02/09  15:51:51  quinn
 125  * Works better now.
 126  *
 127  */
 128
 129 #ifndef COMSTACK_H
 130 #define COMSTACK_H
 131
 132 #define YNETINCLUDE
 133 #include <yconfig.h>
 134 #include <oid.h>
 135 #include <xmalloc.h>
 136
 137 #ifdef __cplusplus
 138 extern "C" {
 139 #endif
 140
 141 #define COMSTACK_DEFAULT_TIMEOUT -1  /* not used yet */
 142
 143 struct comstack;
 144 typedef struct comstack *COMSTACK;
 145 typedef COMSTACK (*CS_TYPE)(int s, int blocking, int protocol);
 146
 147 struct comstack
 148 {
 149     CS_TYPE type;
 150     int cerrno;     /* current error code of this stack */
 151     char *stackerr;/* current lower-layer error string, or null if none */
 152     int iofile;    /* UNIX file descriptor for iochannel */
 153     int timeout;   /* how long to wait for trailing blocks (ignored for now) */
 154     void *cprivate;/* state info for lower stack */
 155     int more;      /* connection has extra data in buffer */
 156     int state;     /* current state */
 157 #define CS_UNBND      0
 158 #define CS_IDLE       1
 159 #define CS_INCON      2
 160 #define CS_OUTCON     3
 161 #define CS_DATAXFER   4
 162     int newfd;     /* storing new descriptor between listen and accept */
 163     int blocking;  /* is this link (supposed to be) blocking? */
 164     int event;     /* current event */
 165 #define CS_NONE       0
 166 #define CS_CONNECT    1
 167 #define CS_DISCON     2
 168 #define CS_LISTEN     3
 169 #define CS_DATA       4
 170     enum oid_proto protocol;  /* what application protocol are we talking? */
 171     int (*f_look)(COMSTACK handle);
 172     int (*f_put)(COMSTACK handle, char *buf, int size);
 173     int (*f_get)(COMSTACK handle, char **buf, int *bufsize);
 174     int (*f_more)(COMSTACK handle);
 175     int (*f_connect)(COMSTACK handle, void *address);
 176     int (*f_rcvconnect)(COMSTACK handle);
 177     int (*f_bind)(COMSTACK handle, void *address, int mode);
 178 #define CS_CLIENT 0
 179 #define CS_SERVER 1
 180     int (*f_listen)(COMSTACK handle, char *addrp, int *addrlen);
 181     COMSTACK (*f_accept)(COMSTACK handle);
 182     int (*f_close)(COMSTACK handle);
 183     char *(*f_addrstr)(COMSTACK handle);
 184     void *(*f_straddr)(COMSTACK handle, const char *str);
 185 };
 186
 187 #define cs_put(handle, buf, size) ((*(handle)->f_put)(handle, buf, size))
 188 #define cs_get(handle, buf, size) ((*(handle)->f_get)(handle, buf, size))
 189 #define cs_more(handle) ((*(handle)->f_more)(handle))
 190 #define cs_connect(handle, address) ((*(handle)->f_connect)(handle, address))
 191 #define cs_rcvconnect(handle) ((*(handle)->f_rcvconnect)(handle))
 192 #define cs_bind(handle, ad, mo) ((*(handle)->f_bind)(handle, ad, mo))
 193 #define cs_listen(handle, ap, al) ((*(handle)->f_listen)(handle, ap, al))
 194 #define cs_accept(handle) ((*(handle)->f_accept)(handle))
 195 #define cs_close(handle) ((*(handle)->f_close)(handle))
 196 #define cs_create(type, blocking, proto) ((*type)(-1, blocking, proto))
 197 #define cs_createbysocket(sock, type, blocking, proto) \
 198         ((*type)(sock, blocking, proto))
 199 #define cs_type(handle) ((handle)->type)
 200 #define cs_fileno(handle) ((handle)->iofile)
 201 #define cs_stackerr(handle) ((handle)->stackerr)
 202 #define cs_getstate(handle) ((handle)->getstate)
 203 #define cs_errno(handle) ((handle)->cerrno)
 204 #define cs_getproto(handle) ((handle)->protocol)
 205 #define cs_addrstr(handle) ((*(handle)->f_addrstr)(handle))
 206 #define cs_straddr(handle, str) ((*(handle)->f_straddr)(handle, str))
 207
 208 YAZ_EXPORT const char *cs_strerror(COMSTACK h);
 209 YAZ_EXPORT const char *cs_errmsg(int n);
 210
 211 /*
 212  * error management.
 213  */
 214
 215 #define CSNONE     0
 216 #define CSYSERR    1
 217 #define CSOUTSTATE 2
 218 #define CSNODATA   3
 219 #define CSWRONGBUF 4
 220
 221 /* backwards compatibility */
 222 #define CS_SR     PROTO_SR
 223 #define CS_Z3950  PROTO_Z3950
 224
 225 #ifdef __cplusplus
 226 }
 227 #endif
 228
 229 #endif