Updated.
[yaz-moved-to-github.git] / include / comstack.h
index 59ed215..13f7369 100644 (file)
@@ -1,10 +1,79 @@
 /*
- * Copyright (C) 1994, Index Data I/S 
- * All rights reserved.
- * Sebastian Hammer, Adam Dickmeiss
+ * Copyright (c) 1995, Index Data.
+ *
+ * Permission to use, copy, modify, distribute, and sell this software and
+ * its documentation, in whole or in part, for any purpose, is hereby granted,
+ * provided that:
+ *
+ * 1. This copyright and permission notice appear in all copies of the
+ * software and its documentation. Notices of copyright or attribution
+ * which appear at the beginning of any file must remain unchanged.
+ *
+ * 2. The name of Index Data or the individual authors may not be used to
+ * endorse or promote products derived from this software without specific
+ * prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
+ * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
+ * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
+ * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
+ * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
+ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+ * OF THIS SOFTWARE.
  *
  * $Log: comstack.h,v $
- * Revision 1.3  1995-04-20 15:12:44  quinn
+ * 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
 #ifndef COMSTACK_H
 #define COMSTACK_H
 
-#include <dmalloc.h>
+#define YNETINCLUDE
+#include <yconfig.h>
+#include <oid.h>
+#include <xmalloc.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
 
-#define COMSTACK_DEFAULT_TIMEOUT -1
+#define COMSTACK_DEFAULT_TIMEOUT -1  /* not used yet */
 
 struct comstack;
 typedef struct comstack *COMSTACK;
-typedef COMSTACK (*CS_TYPE)(int blocking, int protocol);
+typedef COMSTACK (*CS_TYPE)(int s, int blocking, int protocol);
 
 struct comstack
 {
     CS_TYPE type;
-    int errno;     /* current error code of this stack */
+    int cerrno;     /* current error code of this stack */
     char *stackerr;/* current lower-layer error string, or null if none */
     int iofile;    /* UNIX file descriptor for iochannel */
-    int timeout;   /* how long to wait for trailing blocks */          
-    void *private; /* state info for lower stack */
+    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 state;     /* current state */
 #define CS_UNBND      0
@@ -86,9 +162,7 @@ struct comstack
 #define CS_DISCON     2
 #define CS_LISTEN     3
 #define CS_DATA       4
-    int protocol;  /* what application protocol are we talking? */
-#define CS_Z3950      0
-#define CS_SR         1
+    enum oid_proto protocol;  /* what application protocol are we talking? */
     int (*f_look)(COMSTACK handle);
     int (*f_put)(COMSTACK handle, char *buf, int size);
     int (*f_get)(COMSTACK handle, char **buf, int *bufsize);
@@ -101,6 +175,8 @@ struct comstack
     int (*f_listen)(COMSTACK handle, char *addrp, int *addrlen);
     COMSTACK (*f_accept)(COMSTACK handle);
     int (*f_close)(COMSTACK handle);
+    char *(*f_addrstr)(COMSTACK handle);
+    void *(*f_straddr)(COMSTACK handle, const char *str);
 };
 
 #define cs_put(handle, buf, size) ((*(handle)->f_put)(handle, buf, size))
@@ -112,15 +188,20 @@ struct comstack
 #define cs_listen(handle, ap, al) ((*(handle)->f_listen)(handle, ap, al))
 #define cs_accept(handle) ((*(handle)->f_accept)(handle))
 #define cs_close(handle) ((*(handle)->f_close)(handle))
-#define cs_create(type, blocking, proto) ((*type)(blocking, proto))
+#define cs_create(type, blocking, proto) ((*type)(-1, blocking, proto))
+#define cs_createbysocket(sock, type, blocking, proto) \
+       ((*type)(sock, blocking, proto))
 #define cs_type(handle) ((handle)->type)
 #define cs_fileno(handle) ((handle)->iofile)
 #define cs_stackerr(handle) ((handle)->stackerr)
 #define cs_getstate(handle) ((handle)->getstate)
-#define cs_errno(handle) ((handle)->errno)
+#define cs_errno(handle) ((handle)->cerrno)
 #define cs_getproto(handle) ((handle)->protocol)
+#define cs_addrstr(handle) ((*(handle)->f_addrstr)(handle))
+#define cs_straddr(handle, str) ((*(handle)->f_straddr)(handle, str))
 
-const char *cs_strerror(COMSTACK h);
+YAZ_EXPORT const char *cs_strerror(COMSTACK h);
+YAZ_EXPORT const char *cs_errmsg(int n);
 
 /*
  * error management.
@@ -132,6 +213,12 @@ const char *cs_strerror(COMSTACK h);
 #define CSNODATA   3
 #define CSWRONGBUF 4
 
-extern char *cs_errlist[];
+/* backwards compatibility */
+#define CS_SR     PROTO_SR
+#define CS_Z3950  PROTO_Z3950
+
+#ifdef __cplusplus
+}
+#endif
 
 #endif