Collapse all Symbian^3 Product Developer Library

ChspsRequestClient Class Reference

class ChspsRequestClient : public CActive

Request client

hspsrequestclient.lib

Since: S60 5.0

Inherits from

ChspsRequestClient
- CActive
  - CBase

Public Member Functions
	~ChspsRequestClient()
IMPORT_C void	GethspsResult(ChspsResult &)
IMPORT_C ChspsRequestClient *	NewL(MhspsClientRequestServiceObserver &)
IMPORT_C ChspsRequestClient *	NewLC(MhspsClientRequestServiceObserver &)
IMPORT_C void	SetLogBus(void *)
IMPORT_C ThspsServiceCompletedMessage	hspsAccessResourceFile(const TDesC &, const ThspsConfiguration &, RFile &)
IMPORT_C ThspsServiceCompletedMessage	hspsCancelGetODTUpdate()
IMPORT_C ThspsServiceCompletedMessage	hspsGetODT(TInt, ChspsODT &)
IMPORT_C ThspsServiceCompletedMessage	hspsGetODTUpdate()

Protected Member Functions
void	CallGetOdtInFileL(const ThspsConfiguration &, ChspsODT &)
void	DoCancel()
TInt	RunError(TInt)
void	RunL()
void	UpdatehspsReqNotifParams()
void	UpdatehspsResult()

Private Member Functions
	ChspsRequestClient(MhspsClientRequestServiceObserver &)
void	ConstructL()

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
HBufC8 *	iElement
TBuf8< KMaxHeaderDataLength8 >	iHeaderData
ChspsODT *	iODT
TBool	iODTValid
MhspsClientRequestServiceObserver &	iObserver
TBuf8< KMaxReqNotifDataLength8 >	iReqNotifData
ChspsRequestNotificationParams *	iReqNotifParams
CArrayPtrSeg< ChspsResource > *	iResourceList
ChspsResult *	iResult
TBuf8< KMaxResultDataLength8 >	iResultData
RhspsClientSession	iSession

Inherited Attributes
	CActive::iStatus

Constructor & Destructor Documentation

ChspsRequestClient(MhspsClientRequestServiceObserver &)

ChspsRequestClient

(

MhspsClientRequestServiceObserver &

aObserver

)

[private]

ChspsRequestClient. Performs the first phase of two phase construction.

Parameters

MhspsClientRequestServiceObserver & aObserver

The object to be used to handle updates from the server.

~ChspsRequestClient()

~ChspsRequestClient

(

)

[virtual]

~ChspsRequestClient.

Destructor. Destroys the object and release all memory objects.

Member Functions Documentation

CallGetOdtInFileL(const ThspsConfiguration &, ChspsODT &)

void	CallGetOdtInFileL	(	const ThspsConfiguration &	aConfiguration,
			ChspsODT &	aODT
		)	[protected]

Sends a request to the server, retrieves a file path, internalizes the file and copies resources from the server to client's private folder

Since: S60 5.0

Parameters

const ThspsConfiguration & aConfiguration
ChspsODT & aODT

ConstructL()

void

ConstructL

(

)

[private]

ConstructL. Performs the second phase construction ChspsRequestClient object.

DoCancel()

void

DoCancel

(

)

[protected, virtual]

From CActive, DoCancel. Cancels any outstanding operation.

GethspsResult(ChspsResult &)

IMPORT_C void

GethspsResult

(

ChspsResult &

aResult

)

GethspsResult.

Since: S60 5.0

Parameters

ChspsResult & aResult

is a ChspsResult object containing additional information of query result.

NewL(MhspsClientRequestServiceObserver &)

IMPORT_C ChspsRequestClient *

NewL

(

MhspsClientRequestServiceObserver &

aObserver

)

[static]

NewL. Two-phased constructor. Creates a ChspsClient object using two phase construction, and return a pointer to the created object.

Since: S60 5.0

Parameters

MhspsClientRequestServiceObserver & aObserver

The object to be used to handle updates from the server.

NewLC(MhspsClientRequestServiceObserver &)

IMPORT_C ChspsRequestClient *

NewLC

(

MhspsClientRequestServiceObserver &

aObserver

)

[static]

NewLC. Two-phased constructor. Creates a ChspsRequestClient object using two phase construction, and return a pointer to the created object.

Since: S60 5.0

Parameters

MhspsClientRequestServiceObserver & aObserver

The object to be used to handle updates from the server.

RunError(TInt)

TInt

RunError

(

TInt

aError

)

[protected, virtual]

From CActive Called when asynchronous request has failed

Since: S60 3.1

Parameters

TInt aError

RunL()

void

RunL

(

)

[protected, virtual]

From CActive, RunL. Callback function. Invoked to handle responses from the server.

SetLogBus(void *)

IMPORT_C void

SetLogBus

(

void *

aLogBus

)

Sets a log bus when debugging has been enabled. Empty implementation if non HSPS_LOG_ACTIVE build.

Since: S60 5.0

Parameters

void * aLogBus

Log bus to be set.

UpdatehspsReqNotifParams()

void

UpdatehspsReqNotifParams

(

)

[protected]

UpdatehspsReqNotifParams. Updates iReqNotifParams with latest notification data coming on client request return.

UpdatehspsResult()

void

UpdatehspsResult

(

)

[protected]

UpdatehspsResult. Updates iResult with latest result data coming on client request return.

hspsAccessResourceFile(const TDesC &, const ThspsConfiguration &, RFile &)

IMPORT_C ThspsServiceCompletedMessage	hspsAccessResourceFile	(	const TDesC &	aResourceFileName,
			const ThspsConfiguration &	aConfiguration,
			RFile &	aFile
		)

From MhspsClientRequestService.

Parameters

const TDesC & aResourceFileName
const ThspsConfiguration & aConfiguration
RFile & aFile

hspsCancelGetODTUpdate()

IMPORT_C ThspsServiceCompletedMessage

hspsCancelGetODTUpdate

(

)

From MhspsClientRequestService.

hspsGetODT(TInt, ChspsODT &)

IMPORT_C ThspsServiceCompletedMessage	hspsGetODT	(	TInt	aAppUid,
			ChspsODT &	aODT
		)

From MhspsClientRequestService.

Parameters

TInt aAppUid
ChspsODT & aODT

hspsGetODTUpdate()

IMPORT_C ThspsServiceCompletedMessage

hspsGetODTUpdate

(

)

From MhspsClientRequestService.

Member Data Documentation

HBufC8 * iElement

HBufC8 *

iElement

[private]

TBuf8< KMaxHeaderDataLength8 > iHeaderData

TBuf8< KMaxHeaderDataLength8 >

iHeaderData

[private]

ChspsODT * iODT

ChspsODT *

iODT

[private]

TBool iODTValid

TBool

iODTValid

[private]

MhspsClientRequestServiceObserver & iObserver

MhspsClientRequestServiceObserver &

iObserver

[private]

iObserver, observer which handles updates from the server.

TBuf8< KMaxReqNotifDataLength8 > iReqNotifData

TBuf8< KMaxReqNotifDataLength8 >

iReqNotifData

[private]

ChspsRequestNotificationParams * iReqNotifParams

ChspsRequestNotificationParams *

iReqNotifParams

[private]

CArrayPtrSeg< ChspsResource > * iResourceList

CArrayPtrSeg< ChspsResource > *

iResourceList

[private]

ChspsResult * iResult

ChspsResult *

iResult

[private]

TBuf8< KMaxResultDataLength8 > iResultData

TBuf8< KMaxResultDataLength8 >

iResultData

[private]

RhspsClientSession iSession

RhspsClientSession

iSession

[private]

iSession, the time server session.