This documentation is archived and is not being maintained.

SOAP Client Archetype 

Classes that conform to the SOAP client archetype can be used to send SOAP messages to a server when used with SPROXY-generated proxy classes.

Implementation

To implement a class conforming to this archetype, provide the following features:

Method Description

CleanupClient

Clear the data members used to hold state about the current request and response.

Constructor

The constructor should accept a string identifying the location of the SOAP server.

GetClientError

Return the status code for the current request.

GetClientReader

Return a pointer to the ISAXXMLReader interface used to read the SOAP response. A typical implementation will just create a SAXXMLReader30 object.

GetReadStream

Return a pointer to the IStream interface of the response stream.

GetWriteStream

Return a pointer to the IWriteStream interface of the request stream.

SendRequest

Send the SOAP message contained in the stream returned by GetWriteStream to the server.

SetClientError

Set the status code for the current request.

Existing Implementations

These classes conform to this archetype:

Class Description

CSoapMSXMLInetClient

This class provides client access to XML Web services using the Microsoft XML 3.0 ServerXMLHTTP object.

CSoapSocketClientT

This class provides client access to XML Web services using sockets.

CSoapWininetClient

This class provides client access to XML Web services using the WinInet API.

Note that the SOAPTransport Sample provides a number of other classes that conform to the SOAP client archetype. All supported ATL Server client classes communicate using HTTP, but the SOAP client classes in that sample can communicate using sockets over any port, Microsoft Message Queue, or the file system.

Use

These template parameters expect the class to conform to this archetype:

Parameter name Used by

TClient

SPROXY-generated proxy class.

Show: