Collapse all Symbian^3 Product Developer Library

MLiwInterface Class Reference

class MLiwInterface

A type of variant class to execute a set of service command operations on an interface. The service provider should implement MLiwInterface to group set of related operations and offer them as service commands to the consumers.

To maintain its internal state across the execution of service commands and enable invocation of operations directly on the interface, service providers may offer an interface.

ServiceHandler.lib

TLiwVariant

Public Member Functions
void	Close()
void	ExecuteCmdL(const TDesC8 &, const CLiwGenericParamList &, CLiwGenericParamList &, TUint, MLiwNotifyCallback *)

Member Functions Documentation

Close()

void

(

)

[pure virtual]

The service provider should provide a concrete implementation for this method. The internal state of the service provider implemeting MLiwInterface can be reset within this method. The consumer application should call this method if there are no more service commands to be executed on the interface.

ExecuteCmdL(const TDesC8 &, const CLiwGenericParamList &, CLiwGenericParamList &, TUint, MLiwNotifyCallback *)

void	ExecuteCmdL	(	const TDesC8 &	aCmdName,
			const CLiwGenericParamList &	aInParamList,
			CLiwGenericParamList &	aOutParamList,
			TUint	aCmdOptions = 0,
			MLiwNotifyCallback *	aCallback = 0
		)	[pure virtual]

The consumer application should call this method to execute a service command directly on the interface. The service provider should provide a concrete implementation for the supported service command aCmdName. The consumer application should fill in the necessary parameters in aInParamList.

TLiwServiceCmdOptions CLiwGenericParamList MLiwNotifyCallback

Parameters

const TDesC8 & aCmdName	the name of the service command which the consumer wants to invoke
const CLiwGenericParamList & aInParamList	the input parameter list, can be empty list
CLiwGenericParamList & aOutParamList	the output parameter list, can be empty lis. The service provider can use the output parameter list to fill in necessary return values
TUint aCmdOptions = 0	Options for the command, see TLiwServiceCmdOptions in LiwCommon.hrh.
MLiwNotifyCallback * aCallback = 0	callback to be registered by consumer application