CImConnect Class Reference

class CImConnect : public CActive

Inherits from

Public Member Functions
~CImConnect ()
IMPORT_C RConnection & GetConnection ()
IMPORT_C TInt GetIAPBearer ( TUint32 &)
IMPORT_C TInt GetIAPValue ( TUint32 &)
IMPORT_C TInt GetLastSocketActivityTimeout ( TUint32 &)
IMPORT_C TInt GetRConnectionName ( TName &)
CImConnect * NewL (const CImIAPPreferences &, CImTextServerSession &)
IMPORT_C CImConnect * NewL (const CImIAPPreferences &, RSocketServ &)
IMPORT_C TInt Progress ( TNifProgress &)
void SecondaryStartL ( CImTextServerSession *)
IMPORT_C void StartL ( TRequestStatus &)
Protected Member Functions
void DoCancel ()
TInt RunError ( TInt )
void RunL ()
Private Member Functions
CImConnect (const CImIAPPreferences &, CImTextServerSession *, RSocketServ *)
void CheckAndConnectL ()
void ConnectL ()
void ConnectWithIAPListL ()
void ConnectWithSNAP ()
Inherited Functions
CActive::CActive(TInt)
CActive::Cancel()
CActive::Deque()
CActive::Extension_(TUint,TAny *&,TAny *)
CActive::IsActive()const
CActive::IsAdded()const
CActive::Priority()const
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()
Inherited Enumerations
CActive:TPriority
Private Attributes
TInt iAttempt
RConnection iConn
const CImIAPPreferences & iIAPPreferences
CStoreableOverrideSettings * iOverrides
TCommDbMultiConnPref iPrefs
TRequestStatus * iReportStatus
RSocketServ * iSocketServerHandle
CImTextServerSession * iTextSession
Inherited Attributes
CActive::iStatus

Constructor & Destructor Documentation

CImConnect(const CImIAPPreferences &, CImTextServerSession *, RSocketServ *)

CImConnect ( const CImIAPPreferences & aIAPPreferences,
CImTextServerSession * aTextSession,
RSocketServ * aSocketServerHandle
) [private]

Parameters

const CImIAPPreferences & aIAPPreferences
CImTextServerSession * aTextSession
RSocketServ * aSocketServerHandle

~CImConnect()

~CImConnect ( )

Member Functions Documentation

CheckAndConnectL()

void CheckAndConnectL ( ) [private]

ConnectL()

void ConnectL ( ) [private]

ConnectWithIAPListL()

void ConnectWithIAPListL ( ) [private]

ConnectWithSNAP()

void ConnectWithSNAP ( ) [private]

DoCancel()

void DoCancel ( ) [protected, virtual]

Implements cancellation of an outstanding request.

This function is called as part of the active object's Cancel() .

It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous service provider's cancel is expected to act immediately.

DoCancel() must not wait for event completion; this is handled by Cancel() .

CActive::Cancel

GetConnection()

IMPORT_C RConnection & GetConnection ( )
Intended Usage : Returns RConnection
Since
8.0

GetIAPBearer(TUint32 &)

IMPORT_C TInt GetIAPBearer ( TUint32 & aBearer )
Intended Usage : Returns the IAP bearer
Since
8.0

Parameters

TUint32 & aBearer is a return argument containing the bearer if it exists

GetIAPValue(TUint32 &)

IMPORT_C TInt GetIAPValue ( TUint32 & aIap )
Intended Usage : Returns the IAP value
Since
8.0

Parameters

TUint32 & aIap

GetLastSocketActivityTimeout(TUint32 &)

IMPORT_C TInt GetLastSocketActivityTimeout ( TUint32 & aTimeout )
Intended Usage : Returns the last socket activity timeout value
Since
9.1
Post-condition
aTimeout will be filled with the timeout value

Parameters

TUint32 & aTimeout is a return argument containing the timeout if it was found

GetRConnectionName(TName &)

IMPORT_C TInt GetRConnectionName ( TName & aName )
Intended Usage : On return, the unique name of the RConnection .
Since
9.1

Parameters

TName & aName

NewL(const CImIAPPreferences &, CImTextServerSession &)

CImConnect * NewL ( const CImIAPPreferences & aIAPPreferences,
CImTextServerSession & aTextSession
) [static]

Parameters

const CImIAPPreferences & aIAPPreferences
CImTextServerSession & aTextSession

NewL(const CImIAPPreferences &, RSocketServ &)

IMPORT_C CImConnect * NewL ( const CImIAPPreferences & aIAPPreferences,
RSocketServ & aSocketServerHandle
) [static]

Parameters

const CImIAPPreferences & aIAPPreferences
RSocketServ & aSocketServerHandle

Progress(TNifProgress &)

IMPORT_C TInt Progress ( TNifProgress & aProgress )
Intended Usage : Returns progress of the connection
Since
8.0

Parameters

TNifProgress & aProgress

RunError(TInt)

TInt RunError ( TInt aError ) [protected, virtual]

Parameters

TInt aError

RunL()

void RunL ( ) [protected, 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

SecondaryStartL(CImTextServerSession *)

void SecondaryStartL ( CImTextServerSession * aPrimaryTextServerSession )
Intended Usage : Attaches the existing RConnection .
Since
9.2

Parameters

CImTextServerSession * aPrimaryTextServerSession is set on secondary session

StartL(TRequestStatus &)

IMPORT_C void StartL ( TRequestStatus & aStatus )

Parameters

TRequestStatus & aStatus

Member Data Documentation

TInt iAttempt

TInt iAttempt [private]

RConnection iConn

RConnection iConn [private]

const CImIAPPreferences & iIAPPreferences

const CImIAPPreferences & iIAPPreferences [private]

CStoreableOverrideSettings * iOverrides

CStoreableOverrideSettings * iOverrides [private]

TCommDbMultiConnPref iPrefs

TCommDbMultiConnPref iPrefs [private]

TRequestStatus * iReportStatus

TRequestStatus * iReportStatus [private]

RSocketServ * iSocketServerHandle

RSocketServ * iSocketServerHandle [private]

CImTextServerSession * iTextSession

CImTextServerSession * iTextSession [private]