CurrencyConvertor: How to Use gSOAP and Webservices, Part One

• Download Demo - 42.1 KB
• Download Source Files - 219.6 KB

Introduction

In this article, I explain how to build a web service client from a WSDL file. I am releasing this project to help those who wish to begin to use a web service with gSOAP. I won't, however, be explaining about XML Serialization, Transient Types, Memory Management, etc.

I split the article into two parts for easier learning and better understanding. In Part One, I will explain how to get the class from the WSDL file to be used in Visual C++ 6. In Part Two, I show you how to use the classes generated with gSOAP.

To begin, you will want:

• gSoap Toolkit - Download gSoap Toolkit for Windows and unzip it in a directory. You can download it form various sites. I used the site SourceForge and I downloaded the last release: gsoap_win32_2.7.8c.zip
• WSDL - Download the "WSDL Schema Location" and save it with a WSDL extension. I used this WSDL; you can use another like CryptoService, DotGetLocator, etc.

Info: I used a free web service from WebserviceX.NET. If their server is busy and you get the the error "service unavailable," see if it's working here. After downloading the file, you have to build a C++ class from the WSDL file. Go to the gSoap directory and open the bin sub-folder, something like this: D:\gsoap-win32-2.7\bin. Here, you find two executable files:

• wsdl2h.exe allows you do bindings in a C/C++ header file (*.h) from the WSDL file you downloaded before. (intermediate header)
• soapcpp2.exe allows you to build a class with C++ formatting from the intermediate header.

WSDL Importer: Generate the File with C++ Bindings

Copy the WSDL to this directory and run wsdl2h.exe like this:

wsdl2h -o WSCurrencyConv.h CurrencyConvertor.wsdl 

In the shell, you'll see some warning (ignore this) and at the end "To complete the process, compile with: soapcpp2 WSCurrencyConv.h". If all works fine, you'll see a new file in the directory that will be WSCurrencyConv.h (or the name you write at the command line).

N.B. You shouldn't have problems, but if you do, check the name and path you entered and try again.

gSOAP Compiler: Generate the Proxy and XML Serialization Routines in Source-code Format

Run soapcpp2.exe like this:

soapcpp2 -ID:\gsoap-win32-2.7\Import WSCurrencyConv.h

To run this executable, you need to set the path for the gSOAP import, something like this: D:\gsoap-win32-2.7\import. This is similar to what I did before with:

-ID:\gsoap-win32-2.7\Import

The second parameter is the file *.h you entered the first time with wsdl2h. If it works, you'll see in the last line "Compilation successful". Now in the directory, you'll see a few new files.

N.B. You shouldn't have problems, but if you do, check that the path for the import file exists. Otherwise, you can copy all the files in the import directory to the bin directory and try again.

The new files will be:

• CurrencyConvertorSoap.ConversionRate.req.xml
• CurrencyConvertorSoap.ConversionRate.res.xml
• CurrencyConvertorSoap.nsmap
• soapC.cpp
• soapClient.cpp
• soapClientLib.cpp
• soapCurrencyConvertorSoapObject.h
• soapCurrencyConvertorSoapProxy.h
• soapH.h
• soapServer.cpp
• soapServerLib.cpp
• soapStub.h

Using the Visual C++

Now you have all you want to begin deploying your application with Visual C++.

Include Self-generated Code into Visual C++ Projects:

1. You need to include in your application the files below:
   • soapC.cpp
   • soapH.h
   • soapClient.cpp
   • soapStub.h
   • CurrencyConvertorSoap.nsmap
   • soapCurrencyConvertorSoapProxy.h
   • stdsoap2.h (This file in D:\gsoap-win32-2.7\import is the same for all the SW)
   • stdsoap2.cpp (This file in D:\gsoap-win32-2.7\import is the same for all the SW)
2. Set the no precompiler header for the CPP files before:
   • Go to Project Settings (Alt-F7)
   • Change the Settings for all configurations
   • Select the CPP file before adding to the project (soapC.cpp, soapClient.cpp, stdsoap2.cpp)
   • Go to the C++ tab, select the category "Precompiled headers" and select the radio button "Not using precompiled headers"
   
3. Set the Namespace, select the file stdafx.cpp and include the file CurrencyConvertorSoap.nsmap with this line:
   • #include "CurrencyConvertorSoap.nsmap"
4. Link Ws2_32.lib to the project for use the Windows Sockets 2 API:
   • Go to Project Settings (Alt-F7)
   • Change the Settings for all configurations
   • Go to tab Link, category General, and add Ws2_32.lib to the Objcet/Library modules
   

The Project is ready to communicate with the WS. You have all the classes you need to begin.

N.B You could get this warning (shown below), but don't worry and go ahead. This warning is derived from the self-generated class with gSOAP; gSOAP doesn't check the maximum characters.

Points of Interest

I read many books online. I find that there are numerous mistakes and that all the examples are unusable. These books may have all you want to know in order to pass a university test, but there is too much information to begin a project. Irritated, I did this project to let you to begin to write a WS client.

History

• 20 Mar 2007: Second release - Article update
• 12 Jul 2006: First release

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)