CMMFCustomCommandParserBase Class Reference

#include <mmf/common/mmfcontroller.h>

Link against: mmfcontrollerframework.lib

class CMMFCustomCommandParserBase : public CBase, public CBase

Inherits from

Detailed Description

Base class to define the interface of a custom command parser.

In order to facilitate the support of common custom commands by controller plugins, a

custom command parser object can be used. A set of custom command parsers are created

by the controller plugin (one for each interface supported), and added to the custom command

parser manager in the controller framework. The controller plugin must also derive from a set of

concrete interfaces (provided in the form of mixin classes). Then, a custom command supported by

one of the custom command parsers will appear to the controller as a concrete API call, rather than

a call to its own custom command API.

Since
7.0s

Constructor & Destructor Documentation

CMMFCustomCommandParserBase ( TUid )

IMPORT_CCMMFCustomCommandParserBase(TUidaInterfaceId)[protected]

Constructor.

This must be the same as the interface id of the corresponding client

API class. See RMMFCustomCommandsBase.

Since
7.0s
Parameters
aInterfaceIdThe uid of the custom command interface provided by this parser.

~CMMFCustomCommandParserBase ( )

IMPORT_C~CMMFCustomCommandParserBase()

Destructor.

Since
7.0s

Member Function Documentation

HandleRequest ( TMMFMessage & )

voidHandleRequest(TMMFMessage &aMessage)[pure virtual]

Pure virtual method to be implemented by derived classes.

Derived classes must implement the code to decode the message from the client.

Since
7.0s
Parameters
aMessageThe message to be serviced. This message must be completed by the derived class.

InterfaceId ( )

IMPORT_C TUidInterfaceId()

Returns the UID of the custom command interface provided by this parser.

Since
7.0s
Return Value
The interface UID.