Symbian^3 Application Developer Library >

CIMCacheClient Class Reference

class CIMCacheClient : public CBase

CIMCacheClient ClientServer

Inherits from

Public Member Functions
CIMCacheClient ()
~CIMCacheClient ()
void CancelRequestL ( TRequestStatus &, EIMCacheOperations )
TInt Connect ()
TPtr8 GetBufferedDataL ( EIMCacheOperations )
TPtr8 GetChatListL (const TInt &)
TInt GetInformationL ( EIMCacheOperations , TInt , const TDesC &)
TInt GetInformationL ( EIMCacheOperations , TInt )
void RegisterAccessObserverL ( MIMCacheEventHandler &)
void RegisterObserverToServerL ( TRequestStatus &, EIMCacheOperations )
void RegisterUpdateObserverL ( MIMCacheEventHandler &)
TInt StartTransactionL ( EIMCacheOperations )
void StartTransactionL ( EIMCacheOperations , const TDesC &)
void StartTransactionL ( EIMCacheOperations , TInt , const TDesC &)
void StartTransactionL ( EIMCacheOperations , TInt , const TDesC &, const TDesC &)
void UnRegisterAccessObserver ( MIMCacheEventHandler &)
void UnRegisterObserverToServerL ( TRequestStatus &, EIMCacheOperations )
void UnRegisterUpdateObserver ( MIMCacheEventHandler &)
Private Member Functions
TIpcArgs CreateArgumentsL ( TInt , const TDesC &, const TDesC &)
TIpcArgs CreateArgumentsL ( TInt , const TDesC &)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
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 Attributes
CIMCacheAccessEventHandler * iAccessObserver
HBufC8 * iChatBuffer
CIMCacheEventHandler * iUpdateObserver

Constructor & Destructor Documentation

CIMCacheClient()

CIMCacheClient ( )

~CIMCacheClient()

~CIMCacheClient ( )

Member Functions Documentation

CancelRequestL(TRequestStatus &, EIMCacheOperations)

void CancelRequestL ( TRequestStatus & aStatus,
EIMCacheOperations aRight
)

cancels any outstanding requests pending from the server

Parameters

TRequestStatus & aStatus status message to regisetr
EIMCacheOperations aRight

Connect()

TInt Connect ( )

Connect

CreateArgumentsL(TInt, const TDesC &, const TDesC &)

TIpcArgs CreateArgumentsL ( TInt aServiceId,
const TDesC & aText1,
const TDesC & aText2
) [private]

CreateArgumentsL pack the given parameters

Parameters

TInt aServiceId service id to use
const TDesC & aText1
const TDesC & aText2

CreateArgumentsL(TInt, const TDesC &)

TIpcArgs CreateArgumentsL ( TInt aServiceId,
const TDesC & aText
) [private]

CreateArgumentsL pack the given parameters

Parameters

TInt aServiceId service id to use
const TDesC & aText

GetBufferedDataL(EIMCacheOperations)

TPtr8 GetBufferedDataL ( EIMCacheOperations aOperationType )

Gets called when data update is available. Client can then decide wether to use the old one

Parameters

EIMCacheOperations aOperationType

GetChatListL(const TInt &)

TPtr8 GetChatListL ( const TInt & aServiceId = -1 )

to get the list of availabe chats from server

Parameters

const TInt & aServiceId = -1

GetInformationL(EIMCacheOperations, TInt, const TDesC &)

TInt GetInformationL ( EIMCacheOperations aOperationType,
TInt aServiceId,
const TDesC & aBuddyId
)

to get the all unread message count from server

Parameters

EIMCacheOperations aOperationType
TInt aServiceId
const TDesC & aBuddyId

GetInformationL(EIMCacheOperations, TInt)

TInt GetInformationL ( EIMCacheOperations aOperationType,
TInt aServiceId
)

to get the count from server

Parameters

EIMCacheOperations aOperationType operation to perform
TInt aServiceId

RegisterAccessObserverL(MIMCacheEventHandler &)

void RegisterAccessObserverL ( MIMCacheEventHandler & aObserver )

Register to observer converstaionitems data access

Parameters

MIMCacheEventHandler & aObserver the observer interface

RegisterObserverToServerL(TRequestStatus &, EIMCacheOperations)

void RegisterObserverToServerL ( TRequestStatus & aStatus,
EIMCacheOperations aRight
)

Registeres the cache update observer to server

Parameters

TRequestStatus & aStatus status message to regisetr
EIMCacheOperations aRight

RegisterUpdateObserverL(MIMCacheEventHandler &)

void RegisterUpdateObserverL ( MIMCacheEventHandler & aObserver )

Register to observer converstaionitems data updates

Parameters

MIMCacheEventHandler & aObserver the observer interface

StartTransactionL(EIMCacheOperations)

TInt StartTransactionL ( EIMCacheOperations aOperationType )

start the transaction and perform the operation

Parameters

EIMCacheOperations aOperationType

StartTransactionL(EIMCacheOperations, const TDesC &)

void StartTransactionL ( EIMCacheOperations aOperationType,
const TDesC & aText
)

start the transaction and perform the operation

Parameters

EIMCacheOperations aOperationType operation to perform
const TDesC & aText

StartTransactionL(EIMCacheOperations, TInt, const TDesC &)

void StartTransactionL ( EIMCacheOperations aOperationType,
TInt aServiceId,
const TDesC & aText
)

start the transaction and perform the operation

Parameters

EIMCacheOperations aOperationType operation to perform
TInt aServiceId service id to use
const TDesC & aText

StartTransactionL(EIMCacheOperations, TInt, const TDesC &, const TDesC &)

void StartTransactionL ( EIMCacheOperations aOperationType,
TInt aServiceId,
const TDesC & aText1,
const TDesC & aText2
)

start the transaction and perform the operation

Parameters

EIMCacheOperations aOperationType operation to perform
TInt aServiceId service id to use
const TDesC & aText1
const TDesC & aText2

UnRegisterAccessObserver(MIMCacheEventHandler &)

void UnRegisterAccessObserver ( MIMCacheEventHandler & aObserver )

Unregister a converstaionitems data access observer

Parameters

MIMCacheEventHandler & aObserver the observer interface

UnRegisterObserverToServerL(TRequestStatus &, EIMCacheOperations)

void UnRegisterObserverToServerL ( TRequestStatus & aStatus,
EIMCacheOperations aRight
)

unRegisteres the cache update observer to server

Parameters

TRequestStatus & aStatus status message to regisetr
EIMCacheOperations aRight

UnRegisterUpdateObserver(MIMCacheEventHandler &)

void UnRegisterUpdateObserver ( MIMCacheEventHandler & aObserver )

Unregister a converstaionitems data update observer

Parameters

MIMCacheEventHandler & aObserver the observer interface

Member Data Documentation

CIMCacheAccessEventHandler * iAccessObserver

CIMCacheAccessEventHandler * iAccessObserver [private]

HBufC8 * iChatBuffer

HBufC8 * iChatBuffer [private]

CIMCacheEventHandler * iUpdateObserver

CIMCacheEventHandler * iUpdateObserver [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.