Fixed bug 655: IP reverse map no longer works. Renamed blocking element
[yaz-moved-to-github.git] / include / yaz / comstack.h
index 4221e4c..3f8ca64 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1995-1998, Index Data.
+ * Copyright (C) 1995-2006, Index Data ApS
  *
  * Permission to use, copy, modify, distribute, and sell this software and
  * its documentation, in whole or in part, for any purpose, is hereby granted,
  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  * OF THIS SOFTWARE.
  *
- * $Log: comstack.h,v $
- * Revision 1.1  1999-11-30 13:47:11  adam
- * Improved installation. Moved header files to include/yaz.
- *
- * Revision 1.22  1998/06/22 11:32:37  adam
- * Added 'conditional cs_listen' feature.
- *
- * Revision 1.21  1998/05/20 09:52:39  adam
- * Removed 'dead' definition.
- *
- * Revision 1.20  1998/05/18 13:06:55  adam
- * Changed the way attribute sets are handled by the retriaval module.
- * Extended Explain conversion / schema.
- * Modified server and client to work with ASN.1 compiled protocol handlers.
- *
- * Revision 1.19  1997/09/29 07:16:14  adam
- * Array cs_errlist no longer global.
- *
- * Revision 1.18  1997/09/17 12:10:31  adam
- * YAZ version 1.4.
- *
- * Revision 1.17  1997/09/01 08:49:47  adam
- * New windows NT/95 port using MSV5.0. To export DLL functions the
- * YAZ_EXPORT modifier was added. Defined in yconfig.h.
- *
- * Revision 1.16  1997/05/14 06:53:37  adam
- * C++ support.
- *
- * Revision 1.15  1996/07/06 19:58:32  quinn
- * System headerfiles gathered in yconfig
- *
- * Revision 1.14  1996/02/10  12:23:41  quinn
- * Enable inetd operations fro TCP/IP stack
- *
- * Revision 1.13  1995/11/01  13:54:33  quinn
- * Minor adjustments
- *
- * Revision 1.12  1995/10/30  12:41:27  quinn
- * Added hostname lookup for server.
- *
- * Revision 1.11  1995/09/29  17:12:01  quinn
- * Smallish
- *
- * Revision 1.10  1995/09/29  17:01:48  quinn
- * More Windows work
- *
- * Revision 1.9  1995/09/28  10:12:36  quinn
- * Windows-support changes
- *
- * Revision 1.8  1995/09/27  15:02:46  quinn
- * Modified function heads & prototypes.
- *
- * Revision 1.7  1995/06/19  12:38:24  quinn
- * Reorganized include-files. Added small features.
- *
- * Revision 1.6  1995/05/30  10:54:51  quinn
- * Added some backwards compatibility to the comstack (CS_SR->PROTO_SR)
- *
- * Revision 1.5  1995/05/29  08:11:31  quinn
- * Moved oid from odr/asn to util.
- *
- * Revision 1.4  1995/05/16  08:50:29  quinn
- * License, documentation, and memory fixes
- *
- * Revision 1.3  1995/04/20  15:12:44  quinn
- * Cosmetic
- *
- * Revision 1.2  1995/04/17  11:28:17  quinn
- * Smallish
- *
- * Revision 1.1  1995/03/30  09:39:40  quinn
- * Moved .h files to include directory
- *
- * Revision 1.11  1995/03/27  08:36:05  quinn
- * Some work on nonblocking operation in xmosi.c and rfct.c.
- * Added protocol parameter to cs_create()
- *
- * Revision 1.10  1995/03/20  09:47:12  quinn
- * Added server-side support to xmosi.c
- * Fixed possible problems in rfct
- * Other little mods
- *
- * Revision 1.9  1995/03/15  15:36:27  quinn
- * Mods to support nonblocking I/O
- *
- * Revision 1.8  1995/03/14  17:00:07  quinn
- * Bug-fixes - added tracing info to tcpip.c
- *
- * Revision 1.7  1995/03/14  10:28:35  quinn
- * Adding server-side support to tcpip.c and fixing bugs in nonblocking I/O
- *
- * Revision 1.6  1995/03/07  16:29:45  quinn
- * Various fixes.
- *
- * Revision 1.5  1995/03/07  10:39:31  quinn
- * Added cs_fileno
- *
- * Revision 1.4  1995/03/06  16:49:29  adam
- * COMSTACK type inspection possible with cs_type.
- *
- * Revision 1.3  1995/02/14  11:54:48  quinn
- * Beginning to add full CCL.
- *
- * Revision 1.2  1995/02/10  18:58:10  quinn
- * Fixed tcpip_get (formerly tcpip_read).
- * Turned tst (cli) into a proper, event-driven thing.
- *
- * Revision 1.1  1995/02/09  15:51:51  quinn
- * Works better now.
- *
+ * $Id: comstack.h,v 1.23 2006-09-06 15:01:53 adam Exp $
+ */
+
+/** 
+ * \file comstack.h
+ * \brief Header for COMSTACK
  */
 
 #ifndef COMSTACK_H
 #define COMSTACK_H
 
-#define YNETINCLUDE
 #include <yaz/yconfig.h>
 #include <yaz/oid.h>
 #include <yaz/xmalloc.h>
 
-#ifdef __cplusplus
-extern "C" {
-#endif
+YAZ_BEGIN_CDECL
 
 #define COMSTACK_DEFAULT_TIMEOUT -1  /* not used yet */
 
 struct comstack;
 typedef struct comstack *COMSTACK;
-typedef COMSTACK (*CS_TYPE)(int s, int blocking, int protocol);
+typedef COMSTACK (*CS_TYPE)(int s, int flags, int protocol, void *vp);
 
 struct comstack
 {
@@ -161,15 +54,18 @@ struct comstack
     int iofile;    /* UNIX file descriptor for iochannel */
     int timeout;   /* how long to wait for trailing blocks (ignored for now) */
     void *cprivate;/* state info for lower stack */
-    int more;      /* connection has extra data in buffer */
+    int max_recv_bytes;      /* max size of incoming package */
     int state;     /* current state */
-#define CS_UNBND      0
-#define CS_IDLE       1
-#define CS_INCON      2
-#define CS_OUTCON     3
-#define CS_DATAXFER   4
+#define CS_ST_UNBND      0
+#define CS_ST_IDLE       1
+#define CS_ST_INCON      2
+#define CS_ST_OUTCON     3
+#define CS_ST_DATAXFER   4
+#define CS_ST_ACCEPT     5
+#define CS_ST_CONNECTING 6
     int newfd;     /* storing new descriptor between listen and accept */
-    int blocking;  /* is this link (supposed to be) blocking? */
+    int flags;     /* flags, blocking etc.. CS_FLAGS_..  */
+    unsigned io_pending; /* flag to signal read / write op is incomplete */
     int event;     /* current event */
 #define CS_NONE       0
 #define CS_CONNECT    1
@@ -186,12 +82,14 @@ struct comstack
 #define CS_CLIENT 0
 #define CS_SERVER 1
     int (*f_listen)(COMSTACK h, char *raddr, int *addrlen,
-                  int (*check_ip)(void *cd, const char *a, int len, int type),
-                  void *cd);
+                   int (*check_ip)(void *cd, const char *a, int len, int type),
+                   void *cd);
     COMSTACK (*f_accept)(COMSTACK handle);
     int (*f_close)(COMSTACK handle);
     char *(*f_addrstr)(COMSTACK handle);
     void *(*f_straddr)(COMSTACK handle, const char *str);
+    int (*f_set_blocking)(COMSTACK handle, int blocking);
+    void *user;       /* user defined data associated with COMSTACK */
 };
 
 #define cs_put(handle, buf, size) ((*(handle)->f_put)(handle, buf, size))
@@ -204,9 +102,9 @@ struct comstack
 #define cs_listen_check(handle, ap, al, cf, cd) ((*(handle)->f_listen)(handle, ap, al, cf, cd))
 #define cs_accept(handle) ((*(handle)->f_accept)(handle))
 #define cs_close(handle) ((*(handle)->f_close)(handle))
-#define cs_create(type, blocking, proto) ((*type)(-1, blocking, proto))
+#define cs_create(type, blocking, proto) ((*type)(-1, blocking, proto, 0))
 #define cs_createbysocket(sock, type, blocking, proto) \
-       ((*type)(sock, blocking, proto))
+        ((*type)(sock, blocking, proto, 0))
 #define cs_type(handle) ((handle)->type)
 #define cs_fileno(handle) ((handle)->iofile)
 #define cs_stackerr(handle) ((handle)->stackerr)
@@ -215,27 +113,55 @@ struct comstack
 #define cs_getproto(handle) ((handle)->protocol)
 #define cs_addrstr(handle) ((*(handle)->f_addrstr)(handle))
 #define cs_straddr(handle, str) ((*(handle)->f_straddr)(handle, str))
+#define cs_want_read(handle) ((handle)->io_pending & CS_WANT_READ)
+#define cs_want_write(handle) ((handle)->io_pending & CS_WANT_WRITE)
+#define cs_set_blocking(handle,blocking) ((handle)->f_set_blocking(handle, blocking))
+                                          
+#define CS_WANT_READ 1
+#define CS_WANT_WRITE 2
 
+YAZ_EXPORT int cs_look (COMSTACK);
 YAZ_EXPORT const char *cs_strerror(COMSTACK h);
 YAZ_EXPORT const char *cs_errmsg(int n);
-
+YAZ_EXPORT COMSTACK cs_create_host(const char *type_and_host, 
+                                   int blocking, void **vp);
+YAZ_EXPORT void cs_get_host_args(const char *type_and_host, const char **args);
+YAZ_EXPORT int cs_complete_auto(const unsigned char *buf, int len);
+YAZ_EXPORT void *cs_get_ssl(COMSTACK cs);
+YAZ_EXPORT int cs_set_ssl_ctx(COMSTACK cs, void *ctx);
+YAZ_EXPORT int cs_set_ssl_certificate_file(COMSTACK cs, const char *fname);
+YAZ_EXPORT int cs_get_peer_certificate_x509(COMSTACK cs, char **buf, int *len);
+YAZ_EXPORT void cs_set_max_recv_bytes(COMSTACK cs, int max_recv_bytes);
+                                          
 /*
  * error management.
  */
-
+                                          
 #define CSNONE     0
 #define CSYSERR    1
 #define CSOUTSTATE 2
 #define CSNODATA   3
 #define CSWRONGBUF 4
 #define CSDENY     5
+#define CSERRORSSL 6
+#define CSBUFSIZE  7
+#define CSLASTERROR CSBUFSIZE  /* must be the value of last CS error */
 
 /* backwards compatibility */
 #define CS_SR     PROTO_SR
 #define CS_Z3950  PROTO_Z3950
 
-#ifdef __cplusplus
-}
-#endif
+#define CS_FLAGS_BLOCKING 1
+#define CS_FLAGS_NUMERICHOST 2
+
+YAZ_END_CDECL
 
 #endif
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+