Collapse all Symbian^3 Product Developer Library

CHWRMHapticsPluginService Class Reference

class CHWRMHapticsPluginService : public CBase

Plugin interface class to be implemented by adaptation. Responsible for invoking the adaptation implementation of each command and cancelling the command.

Since: S60 5.1

Inherits from

CHWRMHapticsPluginService
- CBase

Public Member Functions
	~CHWRMHapticsPluginService()
void	CancelCommandL(TUint8, TInt)
IMPORT_C CHWRMHapticsPluginService *	NewL(TUid, MHWRMHapticsPluginCallback *)
void	ProcessCommandL(TInt, TUint8, TDesC8 &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Protected Attributes
TUid	iDestructorIDKey
MHWRMHapticsPluginCallback *	iResponseCallback

Constructor & Destructor Documentation

~CHWRMHapticsPluginService()

IMPORT_C

~CHWRMHapticsPluginService

(

)

[virtual]

Destructor

Member Functions Documentation

CancelCommandL(TUint8, TInt)

void	CancelCommandL	(	TUint8	aTransId,
			TInt	aCommandId
		)	[pure virtual]

Method to cancel a particular command. The corresponding ProcessResponseL will not be called for cancelled commands, whether cancel was successful or not.

Parameters

TUint8 aTransId	Transaction ID
TInt aCommandId	Command ID to optionally double check with the transaction ID

NewL(TUid, MHWRMHapticsPluginCallback *)

IMPORT_C CHWRMHapticsPluginService *	NewL	(	TUid	aImplementationUid,
			MHWRMHapticsPluginCallback *	aResponseCallback
		)	[static]

Instantiation method. Uses ECom to find correct instance.

Parameters

TUid aImplementationUid	Determines the plugin to be instantiated.
MHWRMHapticsPluginCallback * aResponseCallback	Pointer to plugin callback handler.

ProcessCommandL(TInt, TUint8, TDesC8 &)

void	ProcessCommandL	(	TInt	aCommandId,
			TUint8	aTransId,
			TDesC8 &	aData
		)	[pure virtual]

Method to invoke a particular command in the plugin. Response to method is returned via separate ProcessResponseL callback. Call to ProcessResponseL is done after the call to ProcessCommandL returns. Plugin must be able to handle another ProcessCommandL before ProcessResponseL is called for previous call(s) (i.e. multiple clients are attempting to access resource simultaneously). If ProcessCommandL leaves, no corresponding ProcessResponseL is expected.

Parameters

TInt aCommandId	Command ID
TUint8 aTransId	Transaction ID. Unique Id allocated by the issuer of this command that is used to distinguish which response relates to which command. Also used in CancelCommandL to distinguish which command is cancelled.
TDesC8 & aData	Data associated with command. Data package contents are defined by command. Some commands require no data and pass empty buffer as aData;

Member Data Documentation

TUid iDestructorIDKey

TUid

iDestructorIDKey

[protected]

Destructor identifier to be used with ECom framework.

MHWRMHapticsPluginCallback * iResponseCallback

MHWRMHapticsPluginCallback *

iResponseCallback

[protected]

Callback pointer to be used with responses to commands. Not owned.