Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 115 lines (90 sloc) 3.166 kb
1e7a122 @vinoski some man page cleanup/repair
vinoski authored
1 .TH YAWS_SOAP_LIB "5" "" "" "Yaws Soap API" -*- nroff -*-
b5f7c7a Adding a new man page for the yaws_soap_lib module. Also, added enabl…
Tobbe Tornquist authored
2 .SH NAME
3 yaws_soap_lib \- api for the yaws soap-functionality
4 .SH SYNOPSIS
5 .B yaws_soap_lib:Function(...)
6
7 .SH DESCRIPTION
8
9 .PP
1e7a122 @vinoski some man page cleanup/repair
vinoski authored
10 This is the Yaws API available for dealing with SOAP.
b5f7c7a Adding a new man page for the yaws_soap_lib module. Also, added enabl…
Tobbe Tornquist authored
11
12 .SH API
13
14 .TP
15 \fcall(WsdlURL, Operation, ListOfData)\fR
16 This function takes an ('http' or 'file' URL to a WSDL file,
7811247 @vinoski whitespace cleanup
vinoski authored
17 an Operation (i.e. Function) to be called and a list of
b5f7c7a Adding a new man page for the yaws_soap_lib module. Also, added enabl…
Tobbe Tornquist authored
18 data to that the Operation takes as input argument.
19 Note: that this function makes the assumption that the
20 record used for the body, has the same name as the Operation.
21 For example, if the Operation is named "GetTime", then the
22 record it assumed to be named 'p:GetTime', where 'p' is the
23 default prefix used.
24
25 .TP
26 \fcall(Wsdl, Operation, ListOfData)\fR
27 Takes a Wsdl structure, as returned from the initModel/1 function,
28 instead of an URL. Else, it works just like the other call/3 function.
29
30 .TP
31 \fcall(Wsdl, Operation, ListOfData)\fR
32 Takes a Wsdl structure, as returned from the initModel/1 function,
33 instead of an URL. Else, it works just like the other call/3 function.
34
35 .TP
36 \fcall(Wsdl, Operation, HeaderMsg, BodyMsg)\fR
37 The Wsdl and Operation arguments works just as for the call/3 function.
38 The HeaderMsg and BodyMsg can be either a record, representing a message,
39 or a list of such records. The records can be generated by the write_hrl/2
40 function.
41
42 .TP
43 \fcall(Wsdl, Operation, Port, Service, HeaderMsg, BodyMsg)\fR
44 The Wsdl, Operation, HeaderMsg and BodyMsg argument works as for
45 the call/4 function. The Port and Service argument is used for pointing
46 out the particular definitions of the corresponding entries in the WSDl
47 specification used.
48
49 .TP
50 \fis_wsdl(Wsdl)\fR
51 Returns true if the Wsdl argument is a Wsdl structure, as returned from
52 the initModel/1 function.
53
54 .TP
55 \fwsdl_model(Wsdl)\fR
56 Returns the Model.
57
58 .TP
59 \fwsdl_operations(Wsdl)\fR
60 Returns a list of Operations.
61
62 .TP
63 \fwsdl_op_service(Wsdl)\fR
64 Returns the Service.
65
66 .TP
67 \fwsdl_op_port(Operation)\fR
68 Returns the port.
69
70 .TP
71 \fwsdl_op_operation(Operation) -> Op.\fR
72 Returns the operation.
73
74 .TP
75 \fwsdl_op_binding(Operation) -> Binding.\fR
76 Returns the binding.
77
78 .TP
79 \fwsdl_op_address(Operation) -> Address.\fR
80 Returns the address.
81
82 .TP
83 \fwsdl_op_action(Operation)\fR
84 Returns the action.
85
86
87 .TP
88 \finitModel(WsdlURL)\fR
89 Takes an URL pointing to an WSDL file. This function will
90 retrieve the file, parse it and return a Wsdl structure that
91 is used as argument to many of the other functions in this module.
92 It will use the default prefix 'p' for the elements/attributes of
93 the target namespace.
94
95 .TP
96 \finitModel(WsdlURL, Prefix)\fR
97 Works as the initModel/1 function but takes another prefix to be used.
98
99 .TP
100 \fwriteHrl(WsdlURL, HrlFilename)\fR
101 Takes an URL pointing to an WSDL file. Will produce a file containing
102 erlang records that corresponds to the elements and datatypes in the
103 WSDL file. This '.hrl' file can then be included in your own Erlang code,
104 for easy manipulation of the SOAP data.
105
106 .TP
107 \fwriteHrl(WsdlURL, HrlFilename, Prefix)\fR
108 Works as the writeHrl/2 function but takes another prefix to be used.
109
110
111 .SH AUTHOR
112 Written by Torbjorn Tornkvist
113 .SH "SEE ALSO"
114 .BR yaws.conf (5)
Something went wrong with that request. Please try again.