CRemConInterfaceBase Class Reference

class CRemConInterfaceBase : public CBase

Base class for outer layer APIs.

Inherits from

  • CRemConInterfaceBase

Constructor & Destructor Documentation

CRemConInterfaceBase(TUid, TUint, CRemConInterfaceSelector &, TRemConClientType)

IMPORT_CCRemConInterfaceBase(TUidaInterfaceUid,
TUintaMaxLength,
CRemConInterfaceSelector &aInterfaceSelector,
TRemConClientTypeaType
)[protected]

Constructor.

Parameters

TUid aInterfaceUidThe UID of the interface.
TUint aMaxLengthThe maximum length of any operation-specific data in the interface being registered.
CRemConInterfaceSelector & aInterfaceSelectorThe interface selector.
TRemConClientType aType

~CRemConInterfaceBase()

IMPORT_C~CRemConInterfaceBase()

Destructor

Member Functions Documentation

BaseConstructL()

IMPORT_C voidBaseConstructL()[protected]

Must be called by concrete types at construction time. Registers the interface with the interface selector.

BaseConstructL(RRemConInterfaceFeatures &)

IMPORT_C voidBaseConstructL(RRemConInterfaceFeatures &aRemConInterfaceFeatures)[protected]

Must be called by concrete types at construction time. Registers the interface with the interface selector.

Parameters

RRemConInterfaceFeatures & aRemConInterfaceFeaturesFeatures associocated with the interface

BaseConstructL(RRemConInterfaceFeatures &, TBool)

IMPORT_C voidBaseConstructL(RRemConInterfaceFeatures &aRemConInterfaceFeatures,
TBoolaBulkInterface
)[protected]

Must be called by concrete types at construction time. Registers the interface with the interface selector.

Parameters

RRemConInterfaceFeatures & aRemConInterfaceFeaturesFeatures associated with the interface
TBool aBulkInterfaceSpecifies whether this interface is a control or bulk interface Only available for use by Outer Layer interfaces.

Bulk()

TBool Bulk()const

Determine whether this is a bulk or control interface. ETrue if this interface is a bulk interface EFalse if this interface is a control interface

Cancel()

IMPORT_C TIntCancel()

Cancels the currently outstanding asynchronous send request. KErrNone.

GetInterfaceIf(TUid)

TAny *GetInterfaceIf(TUidaUid)[pure virtual]

Called by the interface selector to get a pointer to an object which implements the interface API with UID aUid. This is a mechanism for allowing future change to the interface API without breaking BC in existing (non-updated) interfaces.

Parameters

TUid aUid

InterfaceSelector()

IMPORT_C CRemConInterfaceSelector &InterfaceSelector()[protected]

Accessor for the interface selector. The interface selector.

InterfaceUid()

TUid InterfaceUid()const

Accessor for the interface's UID. The interface's UID.

MaxLength()

TUint MaxLength()const

Accessor for the maximum length of operation-specific data in this interface. The size in bytes of a buffer needed to hold the largest single payload of operation-associated data in this interface.

Target(TRemConClientType)

TBool Target(TRemConClientTypeaType)[static]

Determine whether this is a target or controller interface. ETrue if this interface is a target interface EFalse if this interface is a controller interface

Parameters

TRemConClientType aType

Type()

TRemConClientType Type()const

Accessor for the type of the interface. The interface type.

Member Data Documentation

CRemConInterfaceBaseExtension * iExtension

CRemConInterfaceBaseExtension *iExtension[private]

Extension instance for RemCon Interface Base.

CRemConInterfaceSelector & iInterfaceSelector

CRemConInterfaceSelector &iInterfaceSelector[private]

TUid iInterfaceUid

TUid iInterfaceUid[private]

The UID of the concrete (derived) interface.

TUint iMaxLength

TUint iMaxLength[private]

Max length of operation-specific data in this interface.

const TRemConClientType iType

const TRemConClientTypeiType[private]

The type of the interface- controller or target.