How to use gSOAP with Qt for Web Service Client: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
No edit summary
(Simplify punctuation)
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:Developing_with_Qt]]<br />[[Category:HowTo]]<br />[toc align_right=&quot;yes&amp;quot; depth=&quot;3&amp;quot;]
 
[[Category:Developing_with_Qt]]
[[Category:HowTo]]
 


= Overview =
= Overview =
Line 7: Line 10:
== Preparation ==
== Preparation ==


* Download and unzip the &quot;gSOAP package&amp;quot;:http://sourceforge.net/projects/gsoap2/.
* Download and unzip the [http://sourceforge.net/projects/gsoap2/ gSOAP package].


gSOAP package contains pre-built tools in the &lt;code&amp;gt;gsoap/bin&amp;lt;/code&amp;gt; directory.
gSOAP package contains pre-built tools in the '''gsoap/bin''' directory.


* &lt;code&amp;gt;wsdl2h&amp;lt;/code&amp;gt; schema importer
* <code>wsdl2h</code> schema importer
* &lt;code&amp;gt;soap2cpp&amp;lt;/code&amp;gt; stub/skeleton generator.
* <code>soap2cpp</code> stub/skeleton generator.


You require &lt;code&amp;gt;.wsdl&amp;lt;/code&amp;gt; and &lt;code&amp;gt;.xsd&amp;lt;/code&amp;gt; files of the web service to generate a c++ stub.
You require <code>.wsdl</code> and <code>.xsd</code> files of the web service to generate a c++ stub.


== Modify your project ==
== Modify your project ==


* First use &lt;code&amp;gt;wsdl2h&amp;lt;/code&amp;gt; on a .wsdl file to generate a .h file, then use &lt;code&amp;gt;soap2cpp&amp;lt;/code&amp;gt; on the generated .h file to generate .h and .cpp files to be included in your Qt project.
* First use <tt>wsdl2h</tt> on a .wsdl file to generate a .h file, then use <tt>soap2cpp</tt> on the generated .h file to generate .h and .cpp files to be included in your Qt project.
* Before using &lt;code&amp;gt;wsdl2h&amp;lt;/code&amp;gt; you have to modify the &lt;code&amp;gt;typemap.dat&amp;lt;/code&amp;gt; file, this file is present in &lt;code&amp;gt;gsoap/ws&amp;lt;/code&amp;gt; directory. Add a line in this file defining the namespace of your web service. Give any name to &lt;code&amp;gt;namespace&amp;lt;/code&amp;gt; and copy string from your .wsdl file following the tag.
* Before using <tt>wsdl2h</tt> you have to modify the <tt>typemap.dat</tt> file, this file is present in <tt>gsoap/ws</tt> directory. Add a line in this file defining the namespace of your web service. Give any name to <tt>namespace</tt> and copy string from your .wsdl file following the tag.


<code>&lt;definitions targetNamespace=http://something&amp;gt;<code>
<code><definitions targetNamespace=http://something></code>


Add this line to &lt;code&amp;gt;typemap.dat&amp;lt;/code&amp;gt; file:
Add this line to <tt>typemap.dat</tt> file:


</code>Anything =”http://something”</code>
<code>Anything ="http://something"</code>


* Now run &lt;code&amp;gt;wsdl2h&amp;lt;/code&amp;gt; on .wsdl and .xsd files (from command prompt)
* Now run <tt>wsdl2h</tt> on .wsdl and .xsd files (from command prompt)


<code>wsdl2h –s -t&amp;lt;path of typemap.dat&amp;gt; –o &lt;name of generated .h file e.g chatpp.h&amp;gt; &lt;path and name of .wsdl file&amp;gt;<code>
<code>wsdl2h –s -t<path of typemap.dat> –o <name of generated .h file e.g chatpp.h> <path and name of .wsdl file></code>


(note .xsd file should be in same directory as .wsdl file)
(note .xsd file should be in same directory as .wsdl file)


* Then use &lt;code&amp;gt;soapcpp2&amp;lt;/code&amp;gt; on generated .h file &amp;#40;we assume that name of generated file is chatapp.h&amp;amp;#41;
* Then use <tt>soapcpp2</tt> on generated .h file (we assume that name of generated file is chatapp.h)


</code>soapcpp2 –i chatpp.h</code>
<code>soapcpp2 –i chatpp.h</code>


this will generate multiple files
this will generate multiple files


<code>soapstub.h<br />soapH.h<br />soapC.cpp<br />soapchatappProxy.h<br />soapchatappProxy.cpp<br />chatapp.nsmap<br />soapchatappsetvice.h<br />soapchatappservice.cpp</code>
<code>soapstub.h
soapH.h
soapC.cpp
soapchatappProxy.h
soapchatappProxy.cpp
chatapp.nsmap
soapchatappsetvice.h
soapchatappservice.cpp</code>


and an xml file for each method in defined in .wsdl file.
and an xml file for each method in defined in .wsdl file.
Line 45: Line 55:
* now add
* now add


<code>soapstub.h<br />soapH.h<br />soapchatappProxy.h</code>
<code>soapstub.h
soapH.h
soapchatappProxy.h</code>


as headers in to your qt project and then add
as headers in to your qt project and then add


<code>soapC.cpp<br />soapchatppProxy.cpp</code>
<code>soapC.cpp
soapchatppProxy.cpp</code>


as source
as source


* add include path of yor generated file in .pro file of your qt project or simply copy all of generated files to your project directory. Also add path of “libws2_32.a” in your .pro file I my case it is as under
* add include path of yor generated file in .pro file of your qt project or simply copy all of generated files to your project directory. Also add path of "libws2_32.a" in your .pro file I my case it is as under


<code>LIBS += C:/NokiaQTSDK/mingw/lib/libws2_32.a<code>
<code>LIBS += C:/NokiaQTSDK/mingw/lib/libws2_32.a</code>


* also add stdsoap2.h and stdsoap2.cpp from gsoap directory as header and source in your project.
* also add stdsoap2.h and stdsoap2.cpp from gsoap directory as header and source in your project.

Latest revision as of 13:21, 23 August 2015


Overview

gSOAP is a portable development toolkit for C and C++ XML Web services and XML data bindings. It supports XML auto-serialization of C/C++ data. Includes WSDL/XSD schema binding tools, stub/skeleton compiler, Web server, SOAP/XML/MIME streaming, XML-RPC. Here is how to use it to build a web service client in Qt.

Preparation

gSOAP package contains pre-built tools in the gsoap/bin directory.

  • wsdl2h
    
    schema importer
  • soap2cpp
    
    stub/skeleton generator.

You require

.wsdl

and

.xsd

files of the web service to generate a c++ stub.

Modify your project

  • First use wsdl2h on a .wsdl file to generate a .h file, then use soap2cpp on the generated .h file to generate .h and .cpp files to be included in your Qt project.
  • Before using wsdl2h you have to modify the typemap.dat file, this file is present in gsoap/ws directory. Add a line in this file defining the namespace of your web service. Give any name to namespace and copy string from your .wsdl file following the tag.
<definitions targetNamespace=http://something>

Add this line to typemap.dat file:

Anything ="http://something"
  • Now run wsdl2h on .wsdl and .xsd files (from command prompt)
wsdl2h s -t<path of typemap.dat> o <name of generated .h file e.g chatpp.h> <path and name of .wsdl file>

(note .xsd file should be in same directory as .wsdl file)

  • Then use soapcpp2 on generated .h file (we assume that name of generated file is chatapp.h)
soapcpp2 i chatpp.h

this will generate multiple files

soapstub.h
soapH.h
soapC.cpp
soapchatappProxy.h
soapchatappProxy.cpp
chatapp.nsmap
soapchatappsetvice.h
soapchatappservice.cpp

and an xml file for each method in defined in .wsdl file.

  • now add
soapstub.h
soapH.h
soapchatappProxy.h

as headers in to your qt project and then add

soapC.cpp
soapchatppProxy.cpp

as source

  • add include path of yor generated file in .pro file of your qt project or simply copy all of generated files to your project directory. Also add path of "libws2_32.a" in your .pro file I my case it is as under
LIBS += C:/NokiaQTSDK/mingw/lib/libws2_32.a
  • also add stdsoap2.h and stdsoap2.cpp from gsoap directory as header and source in your project.
  • now include chatapp.nsmap and chatappProxy.h in your main.cpp.
  • make an object of chatappProxy and use it to communicate with webservice.

above method worked for me while using gsoap with NokiaQtSDk on windows xp.