Collapse all Symbian^3 Application Developer Library

CATExtCommonBase Class Reference

class CATExtCommonBase : public CBase

AT extension common plugin API

The base class for implementing AT Extension Plugin.

A concrete AT Extension Plugin must implement this class as an ECom plugin, and it must be ready once it has been instantiated.

The interface UID of the plugin resource must use the value defined in atext_interfaceuid.h.

atextcommonbase.lib

Since: S60 v5.0

Inherits from

CATExtCommonBase
- CBase

Public Member Functions
	~CATExtCommonBase ()
void	CancelReceiveModeStatusChange ()
void	CancelReceiveNvramStatusChange ()
TInt	GetMode ( TUint , TUint &)
TInt	GetNvramStatus ( RBuf8 &)
IMPORT_C CATExtCommonBase *	NewL ( TUid , MATExtCommonObserver &, const TDesC8 &)
TInt	ReceiveModeStatusChange ()
TInt	ReceiveNvramStatusChange ()
void	ReportConnectionName (const TDesC8 &)

Protected Member Functions
IMPORT_C TInt	SendModeStatusChange ( TUint )
IMPORT_C TInt	SendNvramStatusChange (const TDesC8 &)

Private Member Functions
IMPORT_C void	SetObserver ( MATExtCommonObserver &)

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()

Private Attributes
TUid	iInstanceUid
MATExtCommonObserver *	iObserver

Constructor & Destructor Documentation

~CATExtCommonBase()

IMPORT_C

~CATExtCommonBase

(

)

[virtual]

Destructor

Member Functions Documentation

CancelReceiveModeStatusChange()

void

CancelReceiveModeStatusChange

(

)

[pure virtual]

Cancels a pending mode receiving request.

Since: S60 5.0

CancelReceiveNvramStatusChange()

void

CancelReceiveNvramStatusChange

(

)

[pure virtual]

Cancels a pending ReceiveNvramStatusChange() NVRAM status change receive request.

Since: S60 5.0

GetMode(TUint, TUint &)

TInt	GetMode	(	TUint	aMask,
			TUint &	aMode
		)	[pure virtual]

Gets current mode status. This is a synchronous version of ReceiveModeStatusChange() and the extension plugin must set aMode parameter to the current mode status before this function returns.

Since: S60 5.0

Parameters

TUint aMask	Mask for current mode
TUint & aMode	Current mode (see explanation in this file)

GetNvramStatus(RBuf8 &)

TInt

GetNvramStatus

(

RBuf8 &

aNvram

)

[pure virtual]

Gets current NVRAM status. This is a synchronous version of ReceiveNvramStatusChange() and the extension plugin must set aNvram parameter to the current NVRAM status before this function returns.

Since: S60 5.0

Parameters

RBuf8 & aNvram

Current NVRAM status. The current settings (delimited by "|") must differ from the Hayes defaults.

NewL(TUid, MATExtCommonObserver &, const TDesC8 &)

IMPORT_C CATExtCommonBase *	NewL	(	TUid	aImplementationUid,
			MATExtCommonObserver &	aObserver,
			const TDesC8 &	aName
		)	[static]

Instantiate the AT Extension Plugin via ECom framework.

Since: S60 5.0

Parameters

TUid aImplementationUid
MATExtCommonObserver & aObserver	The reference of ATEXT interface.
const TDesC8 & aName	Connection name to report to extension plugin

ReceiveModeStatusChange()

TInt

ReceiveModeStatusChange

(

)

[pure virtual]

Receives mode status change. Cancelling of the pending request is done by CancelReceiveModeStatusChange() . The implementation in the extension plugin should be asynchronous.

Since: S60 5.0

ReceiveNvramStatusChange()

TInt

ReceiveNvramStatusChange

(

)

[pure virtual]

Receives NVRAM status change. Cancelling of the pending request is done by CancelReceiveNvramStatusChange() . The implementation in the extension plugin should be asynchronous.

Since: S60 5.0

ReportConnectionName(const TDesC8 &)

void

ReportConnectionName

(

const TDesC8 &

aName

)

[pure virtual]

Reports connection identifier name to the extension plugin.

Since: S60 5.0

Parameters

const TDesC8 & aName

Connection identifier name

SendModeStatusChange(TUint)

IMPORT_C TInt

SendModeStatusChange

(

TUint

aMode

)

[protected]

Called by concrete extension plugin to inform that mode status has changed. Instructs ATEXT to complete client request message for ReceiveModeStatusChange() .

Since: S60 5.0

Parameters

TUint aMode

New mode

SendNvramStatusChange(const TDesC8 &)

IMPORT_C TInt

SendNvramStatusChange

(

const TDesC8 &

aNvram

)

[protected]

Called by concrete extension plugin to inform that NVRAM status has changed. Instructs ATEXT to complete client request message for ReceiveNvramStatusChange() .

Since: S60 5.0

Parameters

const TDesC8 & aNvram

New NVRAM status. The new settings (delimited by "|") must differ from the Hayes defaults.

SetObserver(MATExtCommonObserver &)

IMPORT_C void

SetObserver

(

MATExtCommonObserver &

aObserver

)

[private]

Sets the observer.

Since: S60 5.0

Parameters

MATExtCommonObserver & aObserver

the observer.

Member Data Documentation

TUid iInstanceUid

TUid

iInstanceUid

[private]

UID set by ECOM when the instance is created. Used when the instance is destroyed.

MATExtCommonObserver * iObserver

MATExtCommonObserver *

iObserver

[private]

The reference of ATEXT interface.