Change wording ot YAZ license the 'Revised BSD License'. YAZ has used a
[yaz-moved-to-github.git] / include / yaz / soap.h
1 /*
2  * Copyright (c) 1995-2006, 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: soap.h,v 1.11 2006-10-09 21:02:41 adam Exp $ */
28
29 /*
30  * Copyright (C) 1995-2005, Index Data ApS
31  * See the file LICENSE for details.
32  *
33  * $Id: soap.h,v 1.11 2006-10-09 21:02:41 adam Exp $
34  */
35 /**
36  * \file soap.h
37  * \brief Header for SOAP
38  */
39
40 #ifndef YAZ_SOAP_H
41 #define YAZ_SOAP_H
42
43 #include <yaz/odr.h>
44
45 YAZ_BEGIN_CDECL
46
47 typedef struct {
48     char *fault_code;
49     char *fault_string;
50     char *details;
51 } Z_SOAP_Fault;
52
53 typedef struct {
54     int no;
55     char *ns;
56     void *p;
57 } Z_SOAP_Generic;
58
59 #define Z_SOAP_fault 1
60 #define Z_SOAP_generic 2
61 #define Z_SOAP_error 3
62 typedef struct {
63     int which;
64     union {
65         Z_SOAP_Fault   *fault;
66         Z_SOAP_Generic *generic;
67         Z_SOAP_Fault   *soap_error;
68     } u;
69     const char *ns;
70 } Z_SOAP;
71
72 typedef int (*Z_SOAP_fun)(ODR o, void * ptr, void **handler_data,
73                          void *client_data, const char *ns);
74 typedef struct {
75     char *ns;
76     void *client_data;
77     Z_SOAP_fun f;
78 } Z_SOAP_Handler;
79
80 YAZ_EXPORT int z_soap_codec(ODR o, Z_SOAP **pp, 
81                             char **content_buf, int *content_len,
82                             Z_SOAP_Handler *handlers);
83 YAZ_EXPORT int z_soap_codec_enc(ODR o, Z_SOAP **pp, 
84                                 char **content_buf, int *content_len,
85                                 Z_SOAP_Handler *handlers,
86                                 const char *encoding);
87 YAZ_EXPORT int z_soap_codec_enc_xsl(ODR o, Z_SOAP **pp, 
88                                     char **content_buf, int *content_len,
89                                     Z_SOAP_Handler *handlers,
90                                     const char *encoding,
91                                     const char *stylesheet);
92
93 YAZ_EXPORT int z_soap_error(ODR o, Z_SOAP *p,
94                             const char *fault_code, const char *fault_string,
95                             const char *details);
96
97 YAZ_END_CDECL
98 #endif
99 /*
100  * Local variables:
101  * c-basic-offset: 4
102  * indent-tabs-mode: nil
103  * End:
104  * vim: shiftwidth=4 tabstop=8 expandtab
105  */
106