CRemConInterfaceBase Class Reference

#include <remcon/remconinterfacebase.h>

Link against: remconinterfacebase.lib

class CRemConInterfaceBase : public CBase

Inherits from

CRemConInterfaceBase
- CBase

Public Member Functions
	~CRemConInterfaceBase()
TBool	Bulk()
IMPORT_C TInt	Cancel()
pure virtual TAny *	GetInterfaceIf(TUid)
TUid	InterfaceUid()
TUint	MaxLength()
TBool	Target(TRemConClientType)
TRemConClientType	Type()

Protected Member Functions
	CRemConInterfaceBase(TUid, TUint, CRemConInterfaceSelector &, TRemConClientType)
IMPORT_C void	BaseConstructL()
IMPORT_C void	BaseConstructL(RRemConInterfaceFeatures &)
IMPORT_C void	BaseConstructL(RRemConInterfaceFeatures &, TBool)
IMPORT_C CRemConInterfaceSelector &	InterfaceSelector()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

Base class for outer layer APIs.

Constructor & Destructor Documentation

CRemConInterfaceBase ( TUid, TUint, CRemConInterfaceSelector &, TRemConClientType )

IMPORT_C	CRemConInterfaceBase	(	TUid	aInterfaceUid,
			TUint	aMaxLength,
			CRemConInterfaceSelector &	aInterfaceSelector,
			TRemConClientType	aType
		)	[protected]

Constructor.

Parameters
aInterfaceUid	The UID of the interface.
aMaxLength	The maximum length of any operation-specific data in the interface being registered.
aInterfaceSelector	The interface selector.

~CRemConInterfaceBase ( )

IMPORT_C

~CRemConInterfaceBase

(

)

Destructor

Member Function Documentation

BaseConstructL ( )

IMPORT_C void

BaseConstructL

(

)

[protected]

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

BaseConstructL ( RRemConInterfaceFeatures & )

IMPORT_C void

BaseConstructL

(

RRemConInterfaceFeatures &

aRemConInterfaceFeatures

)

[protected]

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

Parameters
aRemConInterfaceFeatures	Features associocated with the interface

BaseConstructL ( RRemConInterfaceFeatures &, TBool )

IMPORT_C void	BaseConstructL	(	RRemConInterfaceFeatures &	aRemConInterfaceFeatures,
			TBool	aBulkInterface
		)	[protected]

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

Parameters
aRemConInterfaceFeatures	Features associated with the interface
aBulkInterface	Specifies 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.

Return Value: ETrue if this interface is a bulk interface EFalse if this interface is a control interface

Cancel ( )

IMPORT_C TInt

Cancel

(

)

Cancels the currently outstanding asynchronous send request.

Return Value: KErrNone.

GetInterfaceIf ( TUid )

TAny *

GetInterfaceIf

(

TUid

aUid

)

[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.

InterfaceSelector ( )

IMPORT_C CRemConInterfaceSelector &

InterfaceSelector

(

)

[protected]

Accessor for the interface selector.

Return Value: The interface selector.

InterfaceUid ( )

TUid

InterfaceUid

(

)

const

Accessor for the interface's UID.

Return Value: The interface's UID.

MaxLength ( )

TUint

MaxLength

(

)

const

Accessor for the maximum length of operation-specific data in this interface.

Return Value: 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

(

TRemConClientType

aType

)

[static]

Determine whether this is a target or controller interface.

Return Value: ETrue if this interface is a target interface EFalse if this interface is a controller interface

Type ( )

TRemConClientType

Type

(

)

const

Accessor for the type of the interface.

Return Value: The interface type.