Fixed bug 655: IP reverse map no longer works. Renamed blocking element

[yaz-moved-to-github.git] / include / yaz / comstack.h

diff --git a/include/yaz/comstack.h b/include/yaz/comstack.h
index 2c87e44..3f8ca64 100644 (file)
--- a/include/yaz/comstack.h
+++ b/include/yaz/comstack.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1995-2001, 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,
@@ -23,41 +23,18 @@
  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  * OF THIS SOFTWARE.
  *
- * $Id: comstack.h,v 1.7 2001-10-22 16:00:04 adam Exp $
+ * $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
 
 #include <yaz/yconfig.h>
-
-#ifndef _VMS_
-
-# ifdef WIN32
-
-#  include <winsock.h>
-
-# else /* #ifdef WIN32 */
-#  include <sys/types.h>
-#  include <sys/time.h>
-#  include <sys/wait.h>
-
-#  include <netinet/in.h>
-#  include <sys/socket.h>
-#  include <netdb.h>
-#  include <arpa/inet.h>
-
-#  ifdef _AIX
-#   include <sys/select.h>
-#  endif
-
-#  ifndef O_BINARY
-#   define O_BINARY 0
-#  endif
-
-# endif
-#endif /* ifndef _VMS_ */
-
 #include <yaz/oid.h>
 #include <yaz/xmalloc.h>
 
@@ -67,7 +44,7 @@ YAZ_BEGIN_CDECL
 
 struct comstack;
 typedef struct comstack *COMSTACK;
-typedef COMSTACK (*CS_TYPE)(int s, int blocking, int protocol, void *vp);
+typedef COMSTACK (*CS_TYPE)(int s, int flags, int protocol, void *vp);
 
 struct comstack
 {
@@ -77,7 +54,7 @@ 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_ST_UNBND      0
 #define CS_ST_IDLE       1
@@ -87,7 +64,7 @@ struct comstack
 #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
@@ -105,13 +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))
@@ -126,7 +104,7 @@ struct comstack
 #define cs_close(handle) ((*(handle)->f_close)(handle))
 #define cs_create(type, blocking, proto) ((*type)(-1, blocking, proto, 0))
 #define cs_createbysocket(sock, type, blocking, proto) \
-       ((*type)(sock, blocking, proto, 0))
+        ((*type)(sock, blocking, proto, 0))
 #define cs_type(handle) ((handle)->type)
 #define cs_fileno(handle) ((handle)->iofile)
 #define cs_stackerr(handle) ((handle)->stackerr)
@@ -137,19 +115,28 @@ struct comstack
 #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_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);
+                                   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
@@ -157,11 +144,24 @@ YAZ_EXPORT COMSTACK cs_create_host(const char *type_and_host,
 #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
 
+#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
+ */
+