Update source headers for 2008. Omit CVS ID keyword subst.
[yaz-moved-to-github.git] / include / yaz / soap.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: soap.h,v 1.13 2007-01-03 08:42:14 adam Exp $ */
28
29 /**
30  * \file soap.h
31  * \brief Header for SOAP
32  */
33
34 #ifndef YAZ_SOAP_H
35 #define YAZ_SOAP_H
36
37 #include <yaz/odr.h>
38
39 YAZ_BEGIN_CDECL
40
41 typedef struct {
42     char *fault_code;
43     char *fault_string;
44     char *details;
45 } Z_SOAP_Fault;
46
47 typedef struct {
48     int no;
49     char *ns;
50     void *p;
51 } Z_SOAP_Generic;
52
53 #define Z_SOAP_fault 1
54 #define Z_SOAP_generic 2
55 #define Z_SOAP_error 3
56 typedef struct {
57     int which;
58     union {
59         Z_SOAP_Fault   *fault;
60         Z_SOAP_Generic *generic;
61         Z_SOAP_Fault   *soap_error;
62     } u;
63     const char *ns;
64 } Z_SOAP;
65
66 typedef int (*Z_SOAP_fun)(ODR o, void * ptr, void **handler_data,
67                          void *client_data, const char *ns);
68 typedef struct {
69     char *ns;
70     void *client_data;
71     Z_SOAP_fun f;
72 } Z_SOAP_Handler;
73
74 YAZ_EXPORT int z_soap_codec(ODR o, Z_SOAP **pp, 
75                             char **content_buf, int *content_len,
76                             Z_SOAP_Handler *handlers);
77 YAZ_EXPORT int z_soap_codec_enc(ODR o, Z_SOAP **pp, 
78                                 char **content_buf, int *content_len,
79                                 Z_SOAP_Handler *handlers,
80                                 const char *encoding);
81 YAZ_EXPORT int z_soap_codec_enc_xsl(ODR o, Z_SOAP **pp, 
82                                     char **content_buf, int *content_len,
83                                     Z_SOAP_Handler *handlers,
84                                     const char *encoding,
85                                     const char *stylesheet);
86
87 YAZ_EXPORT int z_soap_error(ODR o, Z_SOAP *p,
88                             const char *fault_code, const char *fault_string,
89                             const char *details);
90
91 YAZ_END_CDECL
92 #endif
93 /*
94  * Local variables:
95  * c-basic-offset: 4
96  * indent-tabs-mode: nil
97  * End:
98  * vim: shiftwidth=4 tabstop=8 expandtab
99  */
100