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