CMMFCustomCommandParserBase Class Reference

class CMMFCustomCommandParserBase : public CBase

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

Inherits from

  • CMMFCustomCommandParserBase

Constructor & Destructor Documentation

CMMFCustomCommandParserBase(TUid)

IMPORT_C CMMFCustomCommandParserBase ( TUid aInterfaceId ) [protected]

Constructor.

Since
7.0s

Parameters

TUid aInterfaceId The uid of the custom command interface provided by this parser. This must be the same as the interface id of the corresponding client API class. See RMMFCustomCommandsBase.

~CMMFCustomCommandParserBase()

IMPORT_C ~CMMFCustomCommandParserBase ( )

Destructor.

Since
7.0s

Member Functions Documentation

HandleRequest(TMMFMessage &)

void HandleRequest ( 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

TMMFMessage & aMessage The message to be serviced. This message must be completed by the derived class.

InterfaceId()

IMPORT_C TUid InterfaceId ( )

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

Since
7.0s

Member Data Documentation

TUid iInterfaceId

TUid iInterfaceId [private]

The uid of the custom command interface provided by this parser.