CHsCcProviderClient Class Reference

class CHsCcProviderClient : public CActive

Home screen content control server content provider client

       
hsccsrv.lib
Since
S60 v5.0

Inherits from

Public Member Functions
~CHsCcProviderClient ()
IMPORT_C CHsCcProviderClient * NewL ( MHsContentController &)
void NotifyAppListChanged ()
void NotifyViewListChanged ()
void NotifyWidgetListChanged ()
Private Member Functions
CHsCcProviderClient ( MHsContentController &)
void ConstructL ()
void DoCancel ()
void HandleActivateAppReqL ( TUint32 , TUint32 , CCcSrvMsg &)
void HandleActivateViewReqL ( TUint32 , TUint32 , CCcSrvMsg &)
void HandleActiveAppReqL ( TUint32 , TUint32 , CCcSrvMsg &)
void HandleActiveViewReqL ( TUint32 , TUint32 , CCcSrvMsg &)
void HandleAddViewReqL ( TUint32 , TUint32 , CCcSrvMsg &)
void HandleAddWidgetReqL ( TUint32 , TUint32 , CCcSrvMsg &)
void HandleAppListReqL ( TUint32 , TUint32 , CCcSrvMsg &)
void HandleNotSupportedReqL ( TUint32 , TUint32 , CCcSrvMsg &)
void HandleRegisterObserverNtfL ( TUint32 , TUint32 , CCcSrvMsg &)
void HandleRemoveViewReqL ( TUint32 , TUint32 , CCcSrvMsg &)
void HandleRemoveWidgetReqL ( TUint32 , TUint32 , CCcSrvMsg &)
void HandleUnregisterObserverNtfL ( TUint32 , TUint32 , CCcSrvMsg &)
void HandleViewListReqL ( TUint32 , TUint32 , CCcSrvMsg &)
void HandleWidgetListReqL ( TUint32 , TUint32 , CCcSrvMsg &)
void RunL ()
void SendNtfL ( TUint32 )
void SendRespL ( TUint32 , TUint32 , CCcSrvMsg &)
void WaitForApiReqL ()
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()
Inherited Enumerations
CActive:TPriority
Private Attributes
TUint32 iAddress
HBufC8 * iApiData
TPtr8 iApiDataPtr
HBufC8 * iApiHeader
TPtr8 iApiHeaderPtr
MHsContentController & iController
RArray < TUint32 > iObservers
TPckgBuf < TUint32 > iPckgReceiver
TPckgBuf < TUint32 > iPckgSender
RCcClientSession iSession
Inherited Attributes
CActive::iStatus

Constructor & Destructor Documentation

CHsCcProviderClient(MHsContentController &)

CHsCcProviderClient ( MHsContentController & aController ) [private]

Constructor

Parameters

MHsContentController & aController

~CHsCcProviderClient()

~CHsCcProviderClient ( )

Destructor

Member Functions Documentation

ConstructL()

void ConstructL ( ) [private]

Second phase constructor

DoCancel()

void DoCancel ( ) [private, 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

HandleActivateAppReqL(TUint32, TUint32, CCcSrvMsg &)

void HandleActivateAppReqL ( TUint32 aSender,
TUint32 aReceiver,
CCcSrvMsg & aMessage
) [private]

Parameters

TUint32 aSender
TUint32 aReceiver
CCcSrvMsg & aMessage

HandleActivateViewReqL(TUint32, TUint32, CCcSrvMsg &)

void HandleActivateViewReqL ( TUint32 aSender,
TUint32 aReceiver,
CCcSrvMsg & aMessage
) [private]

Parameters

TUint32 aSender
TUint32 aReceiver
CCcSrvMsg & aMessage

HandleActiveAppReqL(TUint32, TUint32, CCcSrvMsg &)

void HandleActiveAppReqL ( TUint32 aSender,
TUint32 aReceiver,
CCcSrvMsg & aMessage
) [private]

Parameters

TUint32 aSender
TUint32 aReceiver
CCcSrvMsg & aMessage

HandleActiveViewReqL(TUint32, TUint32, CCcSrvMsg &)

void HandleActiveViewReqL ( TUint32 aSender,
TUint32 aReceiver,
CCcSrvMsg & aMessage
) [private]

Parameters

TUint32 aSender
TUint32 aReceiver
CCcSrvMsg & aMessage

HandleAddViewReqL(TUint32, TUint32, CCcSrvMsg &)

void HandleAddViewReqL ( TUint32 aSender,
TUint32 aReceiver,
CCcSrvMsg & aMessage
) [private]

Parameters

TUint32 aSender
TUint32 aReceiver
CCcSrvMsg & aMessage

HandleAddWidgetReqL(TUint32, TUint32, CCcSrvMsg &)

void HandleAddWidgetReqL ( TUint32 aSender,
TUint32 aReceiver,
CCcSrvMsg & aMessage
) [private]

Parameters

TUint32 aSender
TUint32 aReceiver
CCcSrvMsg & aMessage

HandleAppListReqL(TUint32, TUint32, CCcSrvMsg &)

void HandleAppListReqL ( TUint32 aSender,
TUint32 aReceiver,
CCcSrvMsg & aMessage
) [private]

Parameters

TUint32 aSender
TUint32 aReceiver
CCcSrvMsg & aMessage

HandleNotSupportedReqL(TUint32, TUint32, CCcSrvMsg &)

void HandleNotSupportedReqL ( TUint32 aSender,
TUint32 aReceiver,
CCcSrvMsg & aMessage
) [private]

Parameters

TUint32 aSender
TUint32 aReceiver
CCcSrvMsg & aMessage

HandleRegisterObserverNtfL(TUint32, TUint32, CCcSrvMsg &)

void HandleRegisterObserverNtfL ( TUint32 aSender,
TUint32 aReceiver,
CCcSrvMsg & aMessage
) [private]

Parameters

TUint32 aSender
TUint32 aReceiver
CCcSrvMsg & aMessage

HandleRemoveViewReqL(TUint32, TUint32, CCcSrvMsg &)

void HandleRemoveViewReqL ( TUint32 aSender,
TUint32 aReceiver,
CCcSrvMsg & aMessage
) [private]

Parameters

TUint32 aSender
TUint32 aReceiver
CCcSrvMsg & aMessage

HandleRemoveWidgetReqL(TUint32, TUint32, CCcSrvMsg &)

void HandleRemoveWidgetReqL ( TUint32 aSender,
TUint32 aReceiver,
CCcSrvMsg & aMessage
) [private]

Parameters

TUint32 aSender
TUint32 aReceiver
CCcSrvMsg & aMessage

HandleUnregisterObserverNtfL(TUint32, TUint32, CCcSrvMsg &)

void HandleUnregisterObserverNtfL ( TUint32 aSender,
TUint32 aReceiver,
CCcSrvMsg & aMessage
) [private]

Parameters

TUint32 aSender
TUint32 aReceiver
CCcSrvMsg & aMessage

HandleViewListReqL(TUint32, TUint32, CCcSrvMsg &)

void HandleViewListReqL ( TUint32 aSender,
TUint32 aReceiver,
CCcSrvMsg & aMessage
) [private]

Parameters

TUint32 aSender
TUint32 aReceiver
CCcSrvMsg & aMessage

HandleWidgetListReqL(TUint32, TUint32, CCcSrvMsg &)

void HandleWidgetListReqL ( TUint32 aSender,
TUint32 aReceiver,
CCcSrvMsg & aMessage
) [private]

Parameters

TUint32 aSender
TUint32 aReceiver
CCcSrvMsg & aMessage

NewL(MHsContentController &)

IMPORT_C CHsCcProviderClient * NewL ( MHsContentController & aController ) [static]

Two-phased constructor.

Parameters

MHsContentController & aController Controller interface

NotifyAppListChanged()

void NotifyAppListChanged ( )

NotifyViewListChanged()

void NotifyViewListChanged ( )

NotifyWidgetListChanged()

void NotifyWidgetListChanged ( )

RunL()

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

SendNtfL(TUint32)

void SendNtfL ( TUint32 aNtf ) [private]

Parameters

TUint32 aNtf

SendRespL(TUint32, TUint32, CCcSrvMsg &)

void SendRespL ( TUint32 aSender,
TUint32 aReceiver,
CCcSrvMsg & aMessage
) [private]

Parameters

TUint32 aSender
TUint32 aReceiver
CCcSrvMsg & aMessage

WaitForApiReqL()

void WaitForApiReqL ( ) [private]

Member Data Documentation

TUint32 iAddress

TUint32 iAddress [private]

Registered address

HBufC8 * iApiData

HBufC8 * iApiData [private]

Received API request data buffer

TPtr8 iApiDataPtr

TPtr8 iApiDataPtr [private]

Pointer to data buffer

HBufC8 * iApiHeader

HBufC8 * iApiHeader [private]

Received API request header buffer

TPtr8 iApiHeaderPtr

TPtr8 iApiHeaderPtr [private]

Pointer to header buffer

MHsContentController & iController

MHsContentController & iController [private]

Homescreen content controller interface

RArray< TUint32 > iObservers

RArray < TUint32 > iObservers [private]

Observers

TPckgBuf< TUint32 > iPckgReceiver

TPckgBuf < TUint32 > iPckgReceiver [private]

receiver of Api request

TPckgBuf< TUint32 > iPckgSender

TPckgBuf < TUint32 > iPckgSender [private]

Sender of Api request

RCcClientSession iSession

RCcClientSession iSession [private]

Session to Homescreen content control server