SOAP::METHOD Class Reference

An instance of a method call on the server side This provides access to the parameters passed and contains the virtual method for the actual method. More...

#include <mi32/soapserver.h>

Inheritance diagram for SOAP::METHOD:

[legend]

List of all members.

Classes
struct	PARM
Public Types
enum	TYPE { TYPE_String, TYPE_Double, TYPE_Integer, TYPE_XML }
Public Member Functions
virtual	~METHOD ()
const char *	GetName () const
ERRVALUE	ProcessRequest (HTTPCLIENT::INSTANCEDATA *This, const VALUES &parms, VALUES &retval)
Protected Member Functions
	METHOD (OBJECT_DEFINITION obj, const char name)
ERRVALUE	AddParameter (const char *name, VALUES::TYPE type, bool bIsOptional)
ERRVALUE	AddRetVal (const char *name, VALUES::TYPE type, bool bIsOptional)
Private Member Functions
void	CreateWSDLBindingOperationNode (const char ObjectName, XMLNODE bindingNode) const
void	CreateWSDLMessageNodes (XMLNODE *definitionsNode) const
void	CreateWSDLPortTypeOperationNode (XMLNODE *portTypeNode) const
virtual ERRVALUE	v_ProcessRequest (HTTPCLIENT::INSTANCEDATA *This, const VALUES &parms, VALUES &retval)=0
Private Attributes
const char *	m_name
SIMPLE_ARRAY< PARM >	m_OutReply
SIMPLE_ARRAY< PARM >	m_Parms

Detailed Description

An instance of a method call on the server side This provides access to the parameters passed and contains the virtual method for the actual method.

Member Enumeration Documentation

enum SOAP::METHOD::TYPE

Enumerator:

TYPE_String
TYPE_Double
TYPE_Integer
TYPE_XML	Arbitrary XML content.

Constructor & Destructor Documentation

virtual SOAP::METHOD::~METHOD ( ) [virtual]

SOAP::METHOD::METHOD	(	OBJECT_DEFINITION *	obj,
		const char *	name
	)			`[protected]`

Constructor.

To make things easier to keep track of, METHODs should be declared as members of the OBJECT_DEFINITION-derived class that they're methods for. Then when initializing them in the constructor for the OBJECT_DEFINITION, you can just pass "this" for obj

Parameters:

	obj	The object that this is a method of
	name	Method name (must be string constant)

Member Function Documentation

ERRVALUE SOAP::METHOD::AddParameter	(	const char *	name,
		VALUES::TYPE	type,
		bool	bIsOptional
	)			`[protected]`

Add a parameter to the method.

This is generally called by the derived class' constructor

Parameters:

name

Parameter name (Note, use string constants)

ERRVALUE SOAP::METHOD::AddRetVal	(	const char *	name,
		VALUES::TYPE	type,
		bool	bIsOptional
	)			`[protected]`

Add a return value to the method.

This is generally called by the derived class' constructor

Parameters:

name

Return value name (Note, use string constants)

void SOAP::METHOD::CreateWSDLBindingOperationNode	(	const char *	ObjectName,
		XMLNODE *	bindingNode
	)			const `[private]`

void SOAP::METHOD::CreateWSDLMessageNodes ( XMLNODE * definitionsNode ) const [private]

void SOAP::METHOD::CreateWSDLPortTypeOperationNode ( XMLNODE * portTypeNode ) const [private]

const char* SOAP::METHOD::GetName ( ) const

ERRVALUE SOAP::METHOD::ProcessRequest	(	HTTPCLIENT::INSTANCEDATA *	This,
		const VALUES &	parms,
		VALUES &	retval
	)

Parameters:

	parms	Parameters passed
	retval	Return values

virtual ERRVALUE SOAP::METHOD::v_ProcessRequest	(	HTTPCLIENT::INSTANCEDATA *	This,
		const VALUES &	parms,
		VALUES &	retval
	)			`[private, pure virtual]`

The actual processing is done here.

Returns:: 0 to send a normal response back to the client (unless the method is defined as having no response). Returning an error code < 0 will send a SOAPFALT back to the client

Parameters: