TMMFMessageDestination Class Reference

#include <mmf/common/mmfcontrollerframework.h>

Link against: mmfcontrollerframework.lib

class TMMFMessageDestination

Detailed Description

Describes the destination of a message in the controller framework.

The destination is defined by a UID describing the interface and an integer object handle. The controller framework uses this information when it receives a message to decide where to send the message.

The controller plugin and controller proxy use the special constant handles KMMFObjectHandleControllerProxy and KMMFObjectHandleController for efficiency.

Since
7.0s

Constructor & Destructor Documentation

TMMFMessageDestination ( )

IMPORT_CTMMFMessageDestination()

Default constructor.

Assigns a null UID to the interface, and a null handle to the handle.

Since
7.0s

TMMFMessageDestination ( TUid )

IMPORT_CTMMFMessageDestination(TUidaInterfaceId)

Constructor for sending messages to the controller plugin.

Assigns KMMFObjectHandleController to the destination handle.

Since
7.0s
Parameters
aInterfaceIdThe UID of the interface of this message destination.

TMMFMessageDestination ( TUid, TInt )

IMPORT_CTMMFMessageDestination(TUidaInterfaceId,
TIntaDestinationHandle
)

Full constructor.

Since
7.0s
Parameters
aInterfaceIdThe UID of the interface of this message destination.
aDestinationHandleThe handle of the destination object in the controller framework.

TMMFMessageDestination ( const TMMFMessageDestination & )

IMPORT_CTMMFMessageDestination(const TMMFMessageDestination &aOther)

Copy constructor.

Since
7.0s
Parameters
aOtherThe TMMFMessageDestination object to be copied.

Member Function Documentation

DestinationHandle ( )

IMPORT_C TIntDestinationHandle()const

Returns the handle of the destination object in the controller framework.

Since
7.0s
Return Value
The destination handle.

InterfaceId ( )

IMPORT_C TUidInterfaceId()const

Returns the UID of the interface of the message destination.

Since
7.0s
Return Value
The interface UID.

operator== ( const TMMFMessageDestination & )

IMPORT_C TBooloperator==(const TMMFMessageDestination &aOther)const

Compares two destinations.

Since
7.0s
Parameters
aOtherThe object to be compared with this object.
Return Value
A boolean indicating if the objects are the same. ETrue if the objects are the same, EFalse if the objects are different.