CDialogProcessor Class Reference

class CDialogProcessor : public CActive

CDialogProcessor

Interface between the agent and the dialog server. One per CAgentController object and it itself uses the CAgentController object to return results of dialogs to state machine. Also uses a CScriptEngD to return results of PCT read to the script engine. Has a CDialogDestroyPCTNotification to request that a notification is sent when the PCT is destroyed. Has an RGenConAgentDialogServer - class with fixed API to be implemented by dialog server.

Inherits from

Public Member Functions
~CDialogProcessor()
IMPORT_C voidAuthenticate(MDialogProcessorObserver &, TDes &, TDes &, TBool)
IMPORT_C voidCancelEverything()
IMPORT_C voidClosePct()
IMPORT_C voidDestroyPctNotification(MDialogProcessorObserver &)
IMPORT_C voidLogin(MDialogProcessorObserver &, TDes &, TDes &, TBool)
IMPORT_C CDialogProcessor *NewL(TInt)
IMPORT_C TIntOpenPct()
IMPORT_C voidQoSWarning(MDialogProcessorObserver &)
IMPORT_C voidReadPct(MDialogProcessorObserver &, TDes &)
IMPORT_C voidReconnect(MDialogProcessorObserver &)
IMPORT_C voidSelectConnection(MDialogProcessorObserver &, const TConnectionPrefs &)
IMPORT_C voidSelectConnection(MDialogProcessorObserver &, const TConnectionPrefs &, TInt)
IMPORT_C voidSelectModemAndLocation(MDialogProcessorObserver &)
IMPORT_C voidWarnNewConnection(MDialogProcessorObserver &, const TConnectionPrefs &, const TDesC *, const TIspConnectionNames *, TInt)
IMPORT_C TIntWritePct(const TDesC &)
Private Member Functions
CDialogProcessor(TInt)
voidCompleteDestroyPctNotification(TInt)
voidConstructL()
voidDoCancel()
voidRunL()
voidSetActive(MDialogProcessorObserver &, TDPState)
Inherited Functions
CActive::CActive(TInt)
CActive::Cancel()
CActive::Deque()
CActive::Extension_(TUint,TAny *&,TAny *)
CActive::IsActive()const
CActive::IsAdded()const
CActive::Priority()const
CActive::RunError(TInt)
CActive::SetActive()
CActive::SetPriority(TInt)
CActive::~CActive()
CBase::CBase()
CBase::Delete(CBase *)
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 Member Enumerations
enumTDPState {
ENoState = 0, ESelectConnection, EWarnNewConnection, ESelectModemAndLocation, ELogin, EAuthentication, EReconnect, EReadPct, EQoSWarning
}
Inherited Enumerations
CActive:TPriority
Private Attributes
MDialogProcessorObserver *iCurrentObserver
CDialogDestroyPCTNotification *iDestroyPctNotification
RGenConAgentDialogServer iDlgServ
MDialogProcessorObserver *iPctDestructionObserver
TBool iQoSWarningResponse
TBool iReconResponse
TConnectionSettings iSettings
TDPState iState
TBool iWarnNewConnectResponse
Inherited Attributes
CActive::iStatus

Constructor & Destructor Documentation

CDialogProcessor(TInt)

CDialogProcessor(TIntaPriority)[private]

Parameters

TInt aPriority

~CDialogProcessor()

IMPORT_C~CDialogProcessor()

Member Functions Documentation

Authenticate(MDialogProcessorObserver &, TDes &, TDes &, TBool)

IMPORT_C voidAuthenticate(MDialogProcessorObserver &aObserver,
TDes &aUsername,
TDes &aPassword,
TBoolaIsReconnect
)

Parameters

MDialogProcessorObserver & aObserver
TDes & aUsername
TDes & aPassword
TBool aIsReconnect

CancelEverything()

IMPORT_C voidCancelEverything()

Should always call this rather than Cancel() if using PCT

ClosePct()

IMPORT_C voidClosePct()

CompleteDestroyPctNotification(TInt)

voidCompleteDestroyPctNotification(TIntaStatus)[private]

Parameters

TInt aStatus

ConstructL()

voidConstructL()[private]

DestroyPctNotification(MDialogProcessorObserver &)

IMPORT_C voidDestroyPctNotification(MDialogProcessorObserver &aObserver)

Parameters

MDialogProcessorObserver & aObserver

DoCancel()

voidDoCancel()[private, virtual]

From CActive

Login(MDialogProcessorObserver &, TDes &, TDes &, TBool)

IMPORT_C voidLogin(MDialogProcessorObserver &aObserver,
TDes &aUsername,
TDes &aPassword,
TBoolaIsReconnect
)

Parameters

MDialogProcessorObserver & aObserver
TDes & aUsername
TDes & aPassword
TBool aIsReconnect

NewL(TInt)

IMPORT_C CDialogProcessor *NewL(TIntaPriority = CActive::EPriorityStandard)[static]

Parameters

TInt aPriority = CActive::EPriorityStandard

OpenPct()

IMPORT_C TIntOpenPct()

QoSWarning(MDialogProcessorObserver &)

IMPORT_C voidQoSWarning(MDialogProcessorObserver &aObserver)

Parameters

MDialogProcessorObserver & aObserver

ReadPct(MDialogProcessorObserver &, TDes &)

IMPORT_C voidReadPct(MDialogProcessorObserver &aObserver,
TDes &aData
)

Parameters

MDialogProcessorObserver & aObserver
TDes & aData

Reconnect(MDialogProcessorObserver &)

IMPORT_C voidReconnect(MDialogProcessorObserver &aObserver)

Parameters

MDialogProcessorObserver & aObserver

RunL()

voidRunL()[private, virtual]

Handles an active object's request completion event.

A derived class must provide an implementation to handle the completed request. If appropriate, it may issue another request.

The function is called by the active scheduler when a request completion event occurs, i.e. after the active scheduler's WaitForAnyRequest() function completes.

Before calling this active object's RunL() function, the active scheduler has:

1. decided that this is the highest priority active object with a completed request

2. marked this active object's request as complete (i.e. the request is no longer outstanding)

RunL() runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls RunError() to handle the leave.

Note that once the active scheduler's Start() function has been called, all user code is run under one of the program's active object's RunL() or RunError() functions.

CActiveScheduler::Start CActiveScheduler::Error CActiveScheduler::WaitForAnyRequest TRAPD

SelectConnection(MDialogProcessorObserver &, const TConnectionPrefs &)

IMPORT_C voidSelectConnection(MDialogProcessorObserver &aObserver,
const TConnectionPrefs &aPrefs
)

Call from the agent controller (which require a response)

Parameters

MDialogProcessorObserver & aObserver
const TConnectionPrefs & aPrefs

SelectConnection(MDialogProcessorObserver &, const TConnectionPrefs &, TInt)

IMPORT_C voidSelectConnection(MDialogProcessorObserver &aObserver,
const TConnectionPrefs &aPrefs,
TIntaLastError
)

Parameters

MDialogProcessorObserver & aObserver
const TConnectionPrefs & aPrefs
TInt aLastError

SelectModemAndLocation(MDialogProcessorObserver &)

IMPORT_C voidSelectModemAndLocation(MDialogProcessorObserver &aObserver)

Parameters

MDialogProcessorObserver & aObserver

SetActive(MDialogProcessorObserver &, TDPState)

voidSetActive(MDialogProcessorObserver &aObserver,
TDPStateaState
)[private]

Parameters

MDialogProcessorObserver & aObserver
TDPState aState

WarnNewConnection(MDialogProcessorObserver &, const TConnectionPrefs &, const TDesC *, const TIspConnectionNames *, TInt)

IMPORT_C voidWarnNewConnection(MDialogProcessorObserver &aObserver,
const TConnectionPrefs &aPrefs,
const TDesC *aNewIapName,
const TIspConnectionNames *aNewConnectionNames,
TIntaLastError
)

Call from the states (which require a response)

Parameters

MDialogProcessorObserver & aObserver
const TConnectionPrefs & aPrefs
const TDesC * aNewIapName
const TIspConnectionNames * aNewConnectionNames
TInt aLastError

WritePct(const TDesC &)

IMPORT_C TIntWritePct(const TDesC &aData)

Parameters

const TDesC & aData

Member Enumerations Documentation

Enum TDPState

Enumerators

ENoState = 0
ESelectConnection
EWarnNewConnection
ESelectModemAndLocation
ELogin
EAuthentication
EReconnect
EReadPct
EQoSWarning

Member Data Documentation

MDialogProcessorObserver * iCurrentObserver

MDialogProcessorObserver *iCurrentObserver[private]

CDialogDestroyPCTNotification * iDestroyPctNotification

CDialogDestroyPCTNotification *iDestroyPctNotification[private]

RGenConAgentDialogServer iDlgServ

RGenConAgentDialogServer iDlgServ[private]

MDialogProcessorObserver * iPctDestructionObserver

MDialogProcessorObserver *iPctDestructionObserver[private]

TBool iQoSWarningResponse

TBool iQoSWarningResponse[private]

TBool iReconResponse

TBool iReconResponse[private]

TConnectionSettings iSettings

TConnectionSettings iSettings[private]

TDPState iState

TDPState iState[private]

TBool iWarnNewConnectResponse

TBool iWarnNewConnectResponse[private]