Collapse all Symbian^3 Application Developer Library

CRemConStatusApiController Class Reference

class CRemConStatusApiController : public CRemConInterfaceBase

A controller which sends Status API commands.

Inherits from

CRemConStatusApiController
- CRemConInterfaceBase
  - CBase

Public Member Functions
	~CRemConStatusApiController ()
IMPORT_C CRemConStatusApiController *	NewL ( CRemConInterfaceSelector &, MRemConStatusApiControllerObserver &)
IMPORT_C void	SubunitInfo ( TRequestStatus &, TUint &)
IMPORT_C void	UnitInfo ( TRequestStatus &, TUint &)

Private Member Functions
	CRemConStatusApiController ( CRemConInterfaceSelector &, MRemConStatusApiControllerObserver &)
TAny *	GetInterfaceIf ( TUid )
void	MrcibNewMessage ( TUint , const TDesC8 &)
void	Panic ( TStatusApiPanic )
void	ReadCommandDataToInt (const TDesC8 &, TInt , TInt , TInt &)
void	SetSubunitInfoResponseData (const TDesC8 &, TInt &, TInt &, TPtrC8 &)
void	SetUnitInfoResponseData (const TDesC8 &, TInt &, TInt &, TInt &, TInt &)

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()
	CRemConInterfaceBase::BaseConstructL()
	CRemConInterfaceBase::BaseConstructL(RRemConInterfaceFeatures &)
	CRemConInterfaceBase::BaseConstructL(RRemConInterfaceFeatures &,TBool)
	CRemConInterfaceBase::Bulk()const
	CRemConInterfaceBase::CRemConInterfaceBase(TUid,TUint,CRemConInterfaceSelector &,TRemConClientType)
	CRemConInterfaceBase::Cancel()
	CRemConInterfaceBase::InterfaceSelector()
	CRemConInterfaceBase::InterfaceUid()const
	CRemConInterfaceBase::MaxLength()const
	CRemConInterfaceBase::Target(TRemConClientType)
	CRemConInterfaceBase::Type()const
	CRemConInterfaceBase::~CRemConInterfaceBase()

Private Member Enumerations
enum	TStatusApiPanic { EStatusApiCommandDataSectionTooLong }

Private Attributes
MRemConStatusApiControllerObserver &	iObserver
RBuf8	iOutData

Constructor & Destructor Documentation

CRemConStatusApiController(CRemConInterfaceSelector &, MRemConStatusApiControllerObserver &)

CRemConStatusApiController	(	CRemConInterfaceSelector &	aInterfaceSelector,
		MRemConStatusApiControllerObserver &	aObserver
	)	[private]

Constructs this interface.

Parameters

CRemConInterfaceSelector & aInterfaceSelector	An interface selector for use with this interface.
MRemConStatusApiControllerObserver & aObserver	An observer to be notified of responses to commands issued to this interface.

~CRemConStatusApiController()

IMPORT_C

~CRemConStatusApiController

(

)

Destructor.

Member Functions Documentation

GetInterfaceIf(TUid)

TAny *

GetInterfaceIf

(

TUid

aUid

)

[private, virtual]

Gets a pointer to a specific interface version.

Parameters

TUid aUid

MrcibNewMessage(TUint, const TDesC8 &)

void	MrcibNewMessage	(	TUint	aOperationId,
			const TDesC8 &	aData
		)	[private]

New message from RemCon.

Parameters

TUint aOperationId
const TDesC8 & aData

NewL(CRemConInterfaceSelector &, MRemConStatusApiControllerObserver &)

IMPORT_C CRemConStatusApiController *	NewL	(	CRemConInterfaceSelector &	aInterfaceSelector,
			MRemConStatusApiControllerObserver &	aObserver
		)	[static]

Creates new Status Api Controller.

Parameters

CRemConInterfaceSelector & aInterfaceSelector	An interface selector for use with this interface.
MRemConStatusApiControllerObserver & aObserver	An observer to be notified of responses to commands issued to this interface.

Panic(TStatusApiPanic)

void

Panic

(

TStatusApiPanic

aPanic

)

[private, static]

Utility Status Converter panic function.

Parameters

TStatusApiPanic aPanic

The panic number.

ReadCommandDataToInt(const TDesC8 &, TInt, TInt, TInt &)

void	ReadCommandDataToInt	(	const TDesC8 &	aCommandData,
			TInt	aOffset,
			TInt	aLength,
			TInt &	aValue
		)	[private]

Reads command data from the buffer to an int.

Parameters

const TDesC8 & aCommandData	The buffer from which to read the data.
TInt aOffset	The offset within aCommandData read from.
TInt aLength	The length of data to read. This must not be more than 4.
TInt & aValue	On return, the value of the specified data section.

SetSubunitInfoResponseData(const TDesC8 &, TInt &, TInt &, TPtrC8 &)

void	SetSubunitInfoResponseData	(	const TDesC8 &	aCommandData,
			TInt &	aPage,
			TInt &	aExtension,
			TPtrC8 &	aPageData
		)	[private]

Parses command data from the buffer.

Parameters

const TDesC8 & aCommandData	The buffer from which to read the data.
TInt & aPage	On return, the page
TInt & aExtension	On return, the extension
TPtrC8 & aPageData	On return, the page data

SetUnitInfoResponseData(const TDesC8 &, TInt &, TInt &, TInt &, TInt &)

void	SetUnitInfoResponseData	(	const TDesC8 &	aCommandData,
			TInt &	aVendorId,
			TInt &	aUnit,
			TInt &	aUnitType,
			TInt &	aExtendedUnitType
		)	[private]

Parses command data from the buffer.

Parameters

const TDesC8 & aCommandData	The buffer from which to read the data.
TInt & aVendorId	On return, the vendor id
TInt & aUnit	On return, the unit
TInt & aUnitType	On return, the unit type
TInt & aExtendedUnitType	On return, the extended unit type

SubunitInfo(TRequestStatus &, TUint &)

IMPORT_C void	SubunitInfo	(	TRequestStatus &	aStatus,
			TUint &	aNumRemotes
		)

Issue SubUnitInfo command. Only one command per controller session can be outstanding at any one time.

Parameters

TRequestStatus & aStatus	Status to be completed with the result of issuing this command.
TUint & aNumRemotes	On completion, the number of remotes this command was issued to.

UnitInfo(TRequestStatus &, TUint &)

IMPORT_C void	UnitInfo	(	TRequestStatus &	aStatus,
			TUint &	aNumRemotes
		)

Issue UnitInfo command. Only one command per controller session can be outstanding at any one time.

Parameters

TRequestStatus & aStatus	Status to be completed with the result of issuing this command.
TUint & aNumRemotes	On completion, the number of remotes this command was issued to.

Member Enumerations Documentation

Enum TStatusApiPanic

Enumerators

EStatusApiCommandDataSectionTooLong

Member Data Documentation

MRemConStatusApiControllerObserver & iObserver

MRemConStatusApiControllerObserver &

iObserver

[private]

RBuf8 iOutData

RBuf8

iOutData

[private]