Class CMMFCustomCommandParserBase

class CMMFCustomCommandParserBase : public CBase;

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.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

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

Members

Defined in CMMFCustomCommandParserBase:

• CMMFCustomCommandParserBase(TUid)Constructor.
• HandleRequest(TMMFMessage &)Pure virtual method to be implemented by derived classes.
• InterfaceId()Returns the UID of the custom command interface provided by this parser.
• ~CMMFCustomCommandParserBase()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C ~CMMFCustomCommandParserBase();

Description

Destructor.

protected: IMPORT_C CMMFCustomCommandParserBase(TUid aInterfaceId);

Description

Constructor.

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.

virtual void HandleRequest(TMMFMessage &aMessage)=0;

Description

Pure virtual method to be implemented by derived classes.

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

Parameters

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

IMPORT_C TUid InterfaceId();

Description

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

Return value

TUid The interface UID.