zeus::IRemoteMethodCall Class Reference

#include <IRemoteMethodCall.hpp>

Inheritance diagram for zeus::IRemoteMethodCall:

List of all members.

Public Member Functions
virtual void MQUALIFIER	addParameter (IZVariant &rParam)=0
virtual void MQUALIFIER	getMethodName (IString &rName) const =0
virtual Retval MQUALIFIER	getParameterByName (const IString &rName, IZVariant *&rpParam) const =0
virtual Retval MQUALIFIER	getParameter (Int iIndex, IZVariant *&rpParam) const =0
virtual Int MQUALIFIER	getParameterCount () const =0
virtual Retval MQUALIFIER	getReturnValue (IZVariant *&rpParam) const =0
virtual void MQUALIFIER	setMethodName (const IString &rName)=0
virtual void MQUALIFIER	setReturnValue (IZVariant &rParam)=0

---

Detailed Description

Interface declaration of the remote method call. A remote method call is a serializable object which contains arguments and the return value of method call. This method call object will be sent over network to invoke a real method call on a remote object.

---

Member Function Documentation

virtual void MQUALIFIER zeus::IRemoteMethodCall::addParameter

(

IZVariant &

rParam )

[pure virtual]

Adds a new parameter to the list.

Note:

: The param variant must be created on the heap (with new)

Parameters:

rParam

: new parameter (name and value)

Implemented in zeus::TRemoteMethodCall.

virtual void MQUALIFIER zeus::IRemoteMethodCall::getMethodName

(

IString &

rName )

const [pure virtual]

Gets the name of the method

Parameters:

rName

: method name

Implemented in zeus::TRemoteMethodCall.

virtual Retval MQUALIFIER zeus::IRemoteMethodCall::getParameter	(	Int	iIndex,
		IZVariant *&	rpParam
	)		const [pure virtual]

returns a indexed parameter of the method call (name and value pair)

Parameters:

iIndex	: Index of the parameter
rpParam	: return parameter

Return values:

RET_NOERROR	: Parameter returned
RET_REQUEST_FAILED	: No parameter found on index

Implemented in zeus::TRemoteMethodCall.

virtual Retval MQUALIFIER zeus::IRemoteMethodCall::getParameterByName	(	const IString &	rName,
		IZVariant *&	rpParam
	)		const [pure virtual]

returns a named parameter of the method call (name and value pair)

Parameters:

rName	: Name of the parameter
rpParam	: return parameter

Return values:

RET_NOERROR	: Parameter returned
RET_REQUEST_FAILED	: No parameter found on index

Implemented in zeus::TRemoteMethodCall.

virtual Int MQUALIFIER zeus::IRemoteMethodCall::getParameterCount

(

)

const [pure virtual]

Returns the number of parameters

Implemented in zeus::TRemoteMethodCall.

virtual Retval MQUALIFIER zeus::IRemoteMethodCall::getReturnValue

(

IZVariant *&

rpParam )

const [pure virtual]

Gets the return value of the method

Parameters:

rpParam

: Return value to be get

Return values:

RET_NOERROR	: Return value returned
RET_REQUEST_FAILED	: No return value available
RET_INVALID_PARAMETER	: Invalid parameter received

Implemented in zeus::TRemoteMethodCall.

virtual void MQUALIFIER zeus::IRemoteMethodCall::setMethodName

(

const IString &

rName )

[pure virtual]

sets a new method name

Parameters:

rName

: New name

Implemented in zeus::TRemoteMethodCall.

virtual void MQUALIFIER zeus::IRemoteMethodCall::setReturnValue

(

IZVariant &

rParam )

[pure virtual]

Sets the return value of the method

Parameters:

rParam

: Return value to be set

Implemented in zeus::TRemoteMethodCall.

---

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

• IRemoteMethodCall.hpp