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

Constructor & Destructor Documentation

~CATExtCommonBase()

IMPORT_C~CATExtCommonBase()[virtual]

Destructor

Member Functions Documentation

CancelReceiveModeStatusChange()

voidCancelReceiveModeStatusChange()[pure virtual]

Cancels a pending mode receiving request.

Since
S60 5.0

CancelReceiveNvramStatusChange()

voidCancelReceiveNvramStatusChange()[pure virtual]

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

Since
S60 5.0

GetMode(TUint, TUint &)

TInt GetMode(TUintaMask,
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 aMaskMask for current mode
TUint & aModeCurrent 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 & aNvramCurrent NVRAM status. The current settings (delimited by "|") must differ from the Hayes defaults.

NewL(TUid, MATExtCommonObserver &, const TDesC8 &)

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

Instantiate the AT Extension Plugin via ECom framework.

Since
S60 5.0

Parameters

TUid aImplementationUid
MATExtCommonObserver & aObserverThe reference of ATEXT interface.
const TDesC8 & aNameConnection 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 &)

voidReportConnectionName(const TDesC8 &aName)[pure virtual]

Reports connection identifier name to the extension plugin.

Since
S60 5.0

Parameters

const TDesC8 & aNameConnection identifier name

SendModeStatusChange(TUint)

IMPORT_C TIntSendModeStatusChange(TUintaMode)[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 aModeNew mode

SendNvramStatusChange(const TDesC8 &)

IMPORT_C TIntSendNvramStatusChange(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 & aNvramNew NVRAM status. The new settings (delimited by "|") must differ from the Hayes defaults.

SetObserver(MATExtCommonObserver &)

IMPORT_C voidSetObserver(MATExtCommonObserver &aObserver)[private]

Sets the observer.

Since
S60 5.0

Parameters

MATExtCommonObserver & aObserverthe 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.