My Project
Public Member Functions | List of all members
ParaEngine::INPLWebService Class Referenceabstract

NPL interface of a XML Web service client proxy. More...

#include <IParaWebService.h>

Public Member Functions

virtual const char * Invoke (const char *OperationName, const char *msg)=0
 Invokes an XML Web service method synchronously using SOAP. More...
 
virtual void InvokeAsync (const char *OperationName, const char *msg, const char *sCallBackCode)=0
 Invokes the specified method asynchronously. More...
 
virtual const char * GetURL ()=0
 Gets or sets the base URL of the XML Web service the client is requesting. More...
 
virtual void Abort ()=0
 Abort cancels a synchronous XML Web service request. More...
 

Detailed Description

NPL interface of a XML Web service client proxy.

Member Function Documentation

§ Abort()

virtual void ParaEngine::INPLWebService::Abort ( )
pure virtual

Abort cancels a synchronous XML Web service request.

Since a synchronous request will block the thread until the response has been processed you must call Abort from a separate thread.

§ GetURL()

virtual const char* ParaEngine::INPLWebService::GetURL ( )
pure virtual

Gets or sets the base URL of the XML Web service the client is requesting.

§ Invoke()

virtual const char* ParaEngine::INPLWebService::Invoke ( const char *  OperationName,
const char *  msg 
)
pure virtual

Invokes an XML Web service method synchronously using SOAP.

Parameters
OperationNameif this is NULL or "", the name "Activate" is assumed.
msgNPL sCode, which must be a "msg" variable. e.g. msg={op="add", x=1, y=1};
Returns
: NPL sCode, which is a "msg" variable. e.g. msg={result=2};"

§ InvokeAsync()

virtual void ParaEngine::INPLWebService::InvokeAsync ( const char *  OperationName,
const char *  msg,
const char *  sCallBackCode 
)
pure virtual

Invokes the specified method asynchronously.

Parameters
OperationNameif this is NULL or "", the name "Activate" is assumed.
msgNPL sCode, which must be a "msg" variable. e.g. msg={op="add", x=1, y=1};
sCallBackCodecode to be executed upon return. The returning NPL code from the web service is executed before the sCallBackCode.

The documentation for this class was generated from the following file: