Update source headers for 2008. Omit CVS ID keyword subst.
[yaz-moved-to-github.git] / include / yaz / comstack.h
1 /* This file is part of the YAZ toolkit.
2  * Copyright (C) 1995-2008 Index Data.
3  * All rights reserved.
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  *     * Redistributions of source code must retain the above copyright
8  *       notice, this list of conditions and the following disclaimer.
9  *     * Redistributions in binary form must reproduce the above copyright
10  *       notice, this list of conditions and the following disclaimer in the
11  *       documentation and/or other materials provided with the distribution.
12  *     * Neither the name of Index Data nor the names of its contributors
13  *       may be used to endorse or promote products derived from this
14  *       software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 /* $Id: comstack.h,v 1.30 2007-10-09 06:00:55 adam Exp $ */
28
29 /** 
30  * \file comstack.h
31  * \brief Header for COMSTACK
32  */
33
34 #ifndef COMSTACK_H
35 #define COMSTACK_H
36
37 #include <yaz/yconfig.h>
38 #include <yaz/oid_util.h>
39 #include <yaz/xmalloc.h>
40
41 YAZ_BEGIN_CDECL
42
43 #define COMSTACK_DEFAULT_TIMEOUT -1  /* not used yet */
44
45 struct comstack;
46 typedef struct comstack *COMSTACK;
47 typedef COMSTACK (*CS_TYPE)(int s, int flags, int protocol, void *vp);
48
49 struct comstack
50 {
51     CS_TYPE type;
52     int cerrno;     /* current error code of this stack */
53     char *stackerr;/* current lower-layer error string, or null if none */
54     int iofile;    /* UNIX file descriptor for iochannel */
55     int timeout;   /* how long to wait for trailing blocks (ignored for now) */
56     void *cprivate;/* state info for lower stack */
57     int max_recv_bytes;      /* max size of incoming package */
58     int state;     /* current state */
59 #define CS_ST_UNBND      0
60 #define CS_ST_IDLE       1
61 #define CS_ST_INCON      2
62 #define CS_ST_OUTCON     3
63 #define CS_ST_DATAXFER   4
64 #define CS_ST_ACCEPT     5
65 #define CS_ST_CONNECTING 6
66     int newfd;     /* storing new descriptor between listen and accept */
67     int flags;     /* flags, blocking etc.. CS_FLAGS_..  */
68     unsigned io_pending; /* flag to signal read / write op is incomplete */
69     int event;     /* current event */
70 #define CS_NONE       0
71 #define CS_CONNECT    1
72 #define CS_DISCON     2
73 #define CS_LISTEN     3
74 #define CS_DATA       4
75     enum oid_proto protocol;  /* what application protocol are we talking? */
76     int (*f_put)(COMSTACK handle, char *buf, int size);
77     int (*f_get)(COMSTACK handle, char **buf, int *bufsize);
78     int (*f_more)(COMSTACK handle);
79     int (*f_connect)(COMSTACK handle, void *address);
80     int (*f_rcvconnect)(COMSTACK handle);
81     int (*f_bind)(COMSTACK handle, void *address, int mode);
82 #define CS_CLIENT 0
83 #define CS_SERVER 1
84     int (*f_listen)(COMSTACK h, char *raddr, int *addrlen,
85                    int (*check_ip)(void *cd, const char *a, int len, int type),
86                    void *cd);
87     COMSTACK (*f_accept)(COMSTACK handle);
88     int (*f_close)(COMSTACK handle);
89     char *(*f_addrstr)(COMSTACK handle);
90     void *(*f_straddr)(COMSTACK handle, const char *str);
91     int (*f_set_blocking)(COMSTACK handle, int blocking);
92     void *user;       /* user defined data associated with COMSTACK */
93 };
94
95 #define cs_put(handle, buf, size) ((*(handle)->f_put)(handle, buf, size))
96 #define cs_get(handle, buf, size) ((*(handle)->f_get)(handle, buf, size))
97 #define cs_more(handle) ((*(handle)->f_more)(handle))
98 #define cs_connect(handle, address) ((*(handle)->f_connect)(handle, address))
99 #define cs_rcvconnect(handle) ((*(handle)->f_rcvconnect)(handle))
100 #define cs_bind(handle, ad, mo) ((*(handle)->f_bind)(handle, ad, mo))
101 #define cs_listen(handle, ap, al) ((*(handle)->f_listen)(handle, ap, al, 0, 0))
102 #define cs_listen_check(handle, ap, al, cf, cd) ((*(handle)->f_listen)(handle, ap, al, cf, cd))
103 #define cs_accept(handle) ((*(handle)->f_accept)(handle))
104 #define cs_close(handle) ((*(handle)->f_close)(handle))
105 #define cs_create(type, blocking, proto) ((*type)(-1, blocking, proto, 0))
106 #define cs_createbysocket(sock, type, blocking, proto) \
107         ((*type)(sock, blocking, proto, 0))
108 #define cs_type(handle) ((handle)->type)
109 #define cs_fileno(handle) ((handle)->iofile)
110 #define cs_stackerr(handle) ((handle)->stackerr)
111 #define cs_getstate(handle) ((handle)->getstate)
112 #define cs_errno(handle) ((handle)->cerrno)
113 #define cs_getproto(handle) ((handle)->protocol)
114 #define cs_addrstr(handle) ((*(handle)->f_addrstr)(handle))
115 #define cs_straddr(handle, str) ((*(handle)->f_straddr)(handle, str))
116 #define cs_want_read(handle) ((handle)->io_pending & CS_WANT_READ)
117 #define cs_want_write(handle) ((handle)->io_pending & CS_WANT_WRITE)
118 #define cs_set_blocking(handle,blocking) ((handle)->f_set_blocking(handle, blocking))
119                                           
120 #define CS_WANT_READ 1
121 #define CS_WANT_WRITE 2
122
123 YAZ_EXPORT int cs_look (COMSTACK);
124 YAZ_EXPORT const char *cs_strerror(COMSTACK h);
125 YAZ_EXPORT const char *cs_errmsg(int n);
126 YAZ_EXPORT COMSTACK cs_create_host(const char *type_and_host, 
127                                    int blocking, void **vp);
128 YAZ_EXPORT void cs_get_host_args(const char *type_and_host, const char **args);
129 YAZ_EXPORT int cs_complete_auto_head(const char *buf, int len);
130 YAZ_EXPORT int cs_complete_auto(const char *buf, int len);
131 YAZ_EXPORT void *cs_get_ssl(COMSTACK cs);
132 YAZ_EXPORT int cs_set_ssl_ctx(COMSTACK cs, void *ctx);
133 YAZ_EXPORT int cs_set_ssl_certificate_file(COMSTACK cs, const char *fname);
134 YAZ_EXPORT int cs_get_peer_certificate_x509(COMSTACK cs, char **buf, int *len);
135 YAZ_EXPORT void cs_set_max_recv_bytes(COMSTACK cs, int max_recv_bytes);
136 YAZ_EXPORT int completeWAIS(const char *buf, int len);
137
138 /*
139  * error management.
140  */
141                                           
142 #define CSNONE     0
143 #define CSYSERR    1
144 #define CSOUTSTATE 2
145 #define CSNODATA   3
146 #define CSWRONGBUF 4
147 #define CSDENY     5
148 #define CSERRORSSL 6
149 #define CSBUFSIZE  7
150 #define CSLASTERROR CSBUFSIZE  /* must be the value of last CS error */
151
152 /* backwards compatibility */
153 #define CS_SR     PROTO_SR
154 #define CS_Z3950  PROTO_Z3950
155
156 #define CS_FLAGS_BLOCKING 1
157 #define CS_FLAGS_NUMERICHOST 2
158
159 YAZ_END_CDECL
160
161 #endif
162 /*
163  * Local variables:
164  * c-basic-offset: 4
165  * indent-tabs-mode: nil
166  * End:
167  * vim: shiftwidth=4 tabstop=8 expandtab
168  */
169