CMmPhoneBookStoreTsy Class Reference
class CMmPhoneBookStoreTsy : public CSubSessionExtBase
|
CMmPhoneTsy
contains phonebook storage functionality. Extension request handles and parameters are stored as attributes.
Nested Classes and Structures
Public Member Functions
|
|
~CMmPhoneBookStoreTsy
()
|
CMmPhoneBookStoreExtInterface *
|
ActivePBExtension
()
|
void
|
CacheEntriesL
()
|
TInt
|
CancelService
(const
TInt
, const
TTsyReqHandle
)
|
void
|
Complete
(
TInt
,
TInt
)
|
void
|
CompleteCachingL
(
TInt
,
CMmDataPackage
*)
|
void
|
CompleteCountEntries
(
TInt
,
CMmDataPackage
*)
|
void
|
CompleteDeleteAll
(
TInt
,
CMmDataPackage
*)
|
void
|
CompleteDeleteL
(
TInt
,
CMmDataPackage
*)
|
void
|
CompleteGetInfo
(
TInt
)
|
void
|
CompletePBStoreInitializationL
(
TInt
,
CMmDataPackage
*)
|
void
|
CompleteReadL
(
TInt
,
CMmDataPackage
*)
|
void
|
CompleteWriteL
(
TInt
,
CMmDataPackage
*)
|
void
|
ContinueReadL
()
|
void
|
CopyLtsyCacheToCtsyCacheL
(
CArrayPtrSeg
<
CPhoneBookStoreEntry
> *)
|
TInt
|
DeregisterNotification
(const
TInt
)
|
TInt
|
ExtFunc
(const
TTsyReqHandle
, const
TInt
, const
TDataPackage
&)
|
TUint8
|
GetPhonebookType
()
|
void
|
Init
()
|
TBool
|
IsPBInitDone
()
|
CMmPhoneBookStoreTsy
*
|
NewL
(
CMmPhoneTsy
*, const
TDesC
&)
|
TInt
|
NumberOfSlotsL
(const
TInt
)
|
CTelObject
*
|
OpenNewObjectByNameL
(const
TDesC
&)
|
CTelObject
*
|
OpenNewObjectL
(
TDes
&)
|
CMmPhoneTsy
*
|
Phone
()
|
TName
*
|
PhoneBookName
()
|
void
|
ReadEntriesFromArrayL
(
TPBArrayTypeToRead
)
|
TInt
|
RegisterNotification
(const
TInt
)
|
CTelObject::TReqMode
|
ReqModeL
(const
TInt
)
|
void
|
ResetCache
()
|
void
|
ResetCacheReady
()
|
void
|
ResetInitialisationStatus
()
|
TInt
|
SetActivePBExtension
(CMmPhoneBookStoreExtInterface *)
|
void
|
SetPhoneBookType
(const
TDesC
&)
|
void
|
SetTypeOfResponse
(const
TInt
, const
TTsyReqHandle
)
|
void
|
SimIsReady
()
|
Private Member Functions
|
|
CMmPhoneBookStoreTsy
()
|
void
|
CompleteNotifyStoreEvent
(
TInt
)
|
void
|
ConstructL
(const
TDesC
&)
|
TInt
|
CountEntriesL
()
|
TInt
|
DeleteAllL
(const
TTsyReqHandle
)
|
TInt
|
DeleteL
(const
TTsyReqHandle
,
TInt
*)
|
TInt
|
DoExtFuncL
(const
TTsyReqHandle
, const
TInt
, const
TDataPackage
&)
|
TInt
|
FillBufferedDesL
(
CPhoneBookStoreEntry
*)
|
TInt
|
GetInfoCancel
(const
TTsyReqHandle
)
|
TInt
|
GetInfoL
(const
TTsyReqHandle
,
TDes8
*)
|
TInt
|
NotifyStoreEvent
(
RMobilePhoneStore::TMobileStoreEvent
*,
TInt
*)
|
TInt
|
NotifyStoreEventCancel
(const
TTsyReqHandle
)
|
TInt
|
ReadCancel
(const
TTsyReqHandle
)
|
TInt
|
ReadL
(const
TTsyReqHandle
,
RMobilePhoneBookStore::TPBIndexAndNumEntries
*,
TDes8
*,
TBool
)
|
void
|
ReadToCacheL
()
|
void
|
ResetVariables
()
|
TInt
|
SeparatePBDataL
(
TDesC8
*,
CPhoneBookStoreEntry
*)
|
void
|
SetInfo
()
|
void
|
SetMaxNameAndNumLenght
()
|
void
|
UpdateCacheL
(
CPhoneBookStoreEntry
*,
TBool
)
|
TInt
|
WriteByIndexL
(
TInt
)
|
TInt
|
WriteL
(const
TTsyReqHandle
,
TDesC8
*,
TInt
*)
|
Inherited Functions
|
|
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()
|
|
CObject::AccessCount()const
|
|
CObject::CObject()
|
|
CObject::Close()
|
|
CObject::Dec()
|
|
CObject::Extension_(TUint,TAny *&,TAny *)
|
|
CObject::FullName()const
|
|
CObject::Name()const
|
|
CObject::Open()
|
|
CObject::Owner()const
|
|
CObject::SetName(const TDesC *)
|
|
CObject::SetNameL(const TDesC *)
|
|
CObject::SetOwner(CObject *)
|
|
CObject::UniqueID()const
|
|
CObject::~CObject()
|
|
CSubSessionExtBase::CSubSessionExtBase()
|
|
CSubSessionExtBase::CloseSubSessionPreProcessing(CTelSession *,const TInt)
|
|
CSubSessionExtBase::GlobalKernelObjectHandle()
|
|
CSubSessionExtBase::NullMethod1()
|
|
CSubSessionExtBase::OpenPostProcessing(CTelSession *,const )
|
|
CSubSessionExtBase::Service(const RMessage2 &,CReqEntry *)
|
|
CSubSessionExtBase::ServiceExtFunc(const RMessage2 &,CReqEntry *)
|
|
CSubSessionExtBase::~CSubSessionExtBase()
|
|
CTelObject::BufferDes1(const CBuffer *,CBuffer::TWhichSlot)const
|
|
CTelObject::BufferDes1u(const CBuffer *,CBuffer::TWhichSlot)const
|
|
CTelObject::BufferDes2(const CBuffer *,CBuffer::TWhichSlot)const
|
|
CTelObject::BufferDes2u(const CBuffer *,CBuffer::TWhichSlot)const
|
|
CTelObject::CTelObject()
|
|
CTelObject::CancelSubSession(CTelSession *,const TInt)
|
|
CTelObject::CheckAndDestroyDummySubSession()
|
|
CTelObject::CreateDummySession(CTelSession *,const TInt,TBool)
|
|
CTelObject::CreateDummySessionObjectL(CTelSession *)
|
|
CTelObject::DownCallOption(const TInt,TAny *)
|
|
CTelObject::FlowControlResume()
|
|
CTelObject::FlowControlSuspend()
|
|
CTelObject::FlushReqs(CTelSession *,const TInt)
|
|
CTelObject::GeneralReq(const RMessage2 &,CTelSession *,CReqEntry *,TBool)
|
|
CTelObject::GetRequiredPlatSecCaps(const TInt)
|
|
CTelObject::IsPriorityClientReq(TInt)const
|
|
CTelObject::PhoneOwner()const
|
|
CTelObject::Ptr1(const TDes8 *)const
|
|
CTelObject::RemoveDummySubSessionDestroyer()
|
|
CTelObject::ReqCompleted(const TTsyReqHandle,const TInt)
|
|
CTelObject::ResolveError(CTelSession *,const TInt)const
|
|
CTelObject::ServerVersion()const
|
|
CTelObject::SetPhoneOwner(CPhoneBase *)
|
|
CTelObject::TelObjectClose()
|
|
CTelObject::UpCallOption(const TInt,TAny *)
|
|
CTelObject::UpdateAndCompleteIfNecessary(CReqEntry *,TInt)const
|
|
CTelObject::WriteBackAndCompleteBufferedReq(const RMessage2 &,CReqEntry *,TInt)const
|
|
CTelObject::WriteBackAndCompleteReq(CReqEntry *,const TInt)const
|
|
CTelObject::~CTelObject()
|
Private Member Enumerations
|
enum
|
TPBArrayTypeToRead
{
EPBStoreCacheArray
,
EPBStoreReadEntriesArray
}
|
enum
|
TPBRequestTypes
{
EMultimodePhoneBookStoreReqHandleUnknown
,
EMultimodePhoneStoreRead
,
EMultimodePhoneStoreWrite
,
EMultimodePhoneBookStoreRead
,
EMultimodePhoneBookStoreWrite
,
EMultimodePhoneStoreDelete
,
EMultimodePhoneStoreDeleteAll
,
EMultimodePhoneStoreGetInfo
,
EMultimodePhoneStoreNotifyStoreEvent
,
EMmTsyNumOfStorageRequests
}
|
Constructor & Destructor Documentation
CMmPhoneBookStoreTsy()
CMmPhoneBookStoreTsy
|
(
|
)
|
[private]
|
~CMmPhoneBookStoreTsy()
~CMmPhoneBookStoreTsy
|
(
|
)
|
[virtual]
|
Member Functions Documentation
ActivePBExtension()
CMmPhoneBookStoreExtInterface *
|
ActivePBExtension
|
(
|
)
|
[virtual]
|
Gets the active phonebook extension
CacheEntriesL()
This method Activates phonebook entry caching from SIM
CancelService(const TInt, const TTsyReqHandle)
To cancel any extension requests.
Complete(TInt, TInt)
void
|
Complete
|
(
|
TInt
|
aReqHandleType,
|
|
TInt
|
aError
|
|
)
|
[virtual]
|
Calls the needed complete method due timer expiration
Parameters
TInt
aReqHandleType
|
req handle type.
|
TInt
aError
|
error value
|
CompleteCachingL(TInt, CMmDataPackage *)
This method completes caching from SIM to TSY
CompleteCountEntries(TInt, CMmDataPackage *)
This method completes read num of entries by the phonebook type
CompleteDeleteAll(TInt, CMmDataPackage *)
Completes DeleteAll request
CompleteDeleteL(TInt, CMmDataPackage *)
Completes delete -request
CompleteGetInfo(TInt)
void
|
CompleteGetInfo
|
(
|
TInt
|
aResult
|
)
|
[virtual]
|
Completes GetInfo request
Parameters
TInt
aResult
|
Result value
|
CompleteNotifyStoreEvent(TInt)
void
|
CompleteNotifyStoreEvent
|
(
|
TInt
|
aLocation
|
)
|
[private]
|
Completes NotifyStoreEvent request
Parameters
TInt
aLocation
|
index to notify
|
CompletePBStoreInitializationL(TInt, CMmDataPackage *)
void
|
CompletePBStoreInitializationL
|
(
|
TInt
|
aResult,
|
|
CMmDataPackage
*
|
aDataPackage
|
|
)
|
[virtual]
|
Completes Phonebook initialization
CompleteReadL(TInt, CMmDataPackage *)
Completes read -request from SIM and fills descriptor with requested entry.
CompleteWriteL(TInt, CMmDataPackage *)
ConstructL(const TDesC &)
void
|
ConstructL
|
(
|
const
TDesC
&
|
aName
|
)
|
[private]
|
By default Symbian 2nd phase constructor is private.
ContinueReadL()
This method continues Read
CopyLtsyCacheToCtsyCacheL(CArrayPtrSeg< CPhoneBookStoreEntry > *)
This method copies entries from the LTSY cache to CTSYs own version of the cache
CountEntriesL()
TInt
|
CountEntriesL
|
(
|
)
|
[private]
|
This method read num of entries by the phonebook type and it is part of GetInfo functionality
DeleteAllL(const TTsyReqHandle)
Deletes all entries from SIM
DeleteL(const TTsyReqHandle, TInt *)
Deletes an entry from SIM
DeregisterNotification(const TInt)
TInt
|
DeregisterNotification
|
(
|
const
TInt
|
aIpc
|
)
|
[virtual]
|
Deregister given notification
Parameters
const
TInt
aIpc
|
Request IPC number
|
DoExtFuncL(const TTsyReqHandle, const TInt, const TDataPackage &)
Handles extended client requests. Uses TRAP to ensure functioning on memory allocation failure.
Parameters
const
TTsyReqHandle
aTsyReqHandle
|
Request handle
|
const
TInt
aIpc
|
Interprocess communication command identifier (IPC)
|
const
TDataPackage
& aPackage
|
reference to a data package
|
ExtFunc(const TTsyReqHandle, const TInt, const TDataPackage &)
Handles extended client requests
Parameters
const
TTsyReqHandle
aTsyReqHandle
|
The request handle
|
const
TInt
aIpc
|
Request IPC number
|
const
TDataPackage
& aPackage
|
Packaged data from ETel server
|
FillBufferedDesL(CPhoneBookStoreEntry *)
Fill buffered descriptor with data from SIM Server
GetInfoCancel(const TTsyReqHandle)
Cancels get store information
GetInfoL(const TTsyReqHandle, TDes8 *)
Parameters
const
TTsyReqHandle
aTsyReqHandle
|
Request handle
|
TDes8
* aInfo
|
package containing TMobilePhoneBookInfoV1 object
|
GetPhonebookType()
This method returns phonebooktype
Init()
Methods that are inherited from ETel Server base classes Initialisation method
IsPBInitDone()
This method returns is the initialization done
NewL(CMmPhoneTsy *, const TDesC &)
NotifyStoreEvent(RMobilePhoneStore::TMobileStoreEvent *, TInt *)
NotifyStoreEventCancel(const TTsyReqHandle)
Cancels notify store event -request
NumberOfSlotsL(const TInt)
TInt
|
NumberOfSlotsL
|
(
|
const
TInt
|
aIpc
|
)
|
[virtual]
|
To ask the TSY how big buffer it wants.
Parameters
const
TInt
aIpc
|
Request IPC number
|
OpenNewObjectByNameL(const TDesC &)
Creates new PBStore object by name and returns a pointer to it. New instances are created by given name, hence this method is NOT SUPPORTED.
Parameters
const
TDesC
& aName
|
A name of the object to be opened.
|
OpenNewObjectL(TDes &)
Opens extendable sub-sessions. This method is not supported.
Parameters
TDes
& aName
|
A name of the object to be opened.
|
PhoneBookName()
TName
*
|
PhoneBookName
|
(
|
)
|
|
This method returns the name of the phonebook
ReadCancel(const TTsyReqHandle)
ReadEntriesFromArrayL(TPBArrayTypeToRead)
This method reads entries from array to fill client's read buffer
ReadL(const TTsyReqHandle, RMobilePhoneBookStore::TPBIndexAndNumEntries *, TDes8 *, TBool)
Phonebookstorage specific Read -Request
ReadToCacheL()
void
|
ReadToCacheL
|
(
|
)
|
[private]
|
This method starts the new caching request to (U)SIM
RegisterNotification(const TInt)
TInt
|
RegisterNotification
|
(
|
const
TInt
|
aIpc
|
)
|
[virtual]
|
Enables the TSY to "turn on" any regular notification.
Parameters
const
TInt
aIpc
|
Request IPC number
|
ReqModeL(const TInt)
CTelObject::TReqMode
|
ReqModeL
|
(
|
const
TInt
|
aIpc
|
)
|
[virtual]
|
To ask what type of flow control is used for the IPC number.
ResetCache()
void
|
ResetCache
|
(
|
)
|
[virtual]
|
ResetCacheReady()
void
|
ResetCacheReady
|
(
|
)
|
[virtual]
|
This method resets iCacheReady flag
ResetInitialisationStatus()
void
|
ResetInitialisationStatus
|
(
|
)
|
[virtual]
|
This method resets iIsPhonebookInitialized flag
ResetVariables()
void
|
ResetVariables
|
(
|
)
|
[private]
|
This method resets class variables
SeparatePBDataL(TDesC8 *, CPhoneBookStoreEntry *)
This method separates phonebook storage data from byte stream
SetActivePBExtension(CMmPhoneBookStoreExtInterface *)
TInt
|
SetActivePBExtension
|
(
|
CMmPhoneBookStoreExtInterface *
|
aMmPBExt
|
)
|
[virtual]
|
Sets the active phonebook extension
Parameters
CMmPhoneBookStoreExtInterface * aMmPBExt
|
pointer to the new PB extension
|
SetInfo()
void
|
SetInfo
|
(
|
)
|
[private]
|
Sets requested info parameters
SetMaxNameAndNumLenght()
void
|
SetMaxNameAndNumLenght
|
(
|
)
|
[private]
|
Sets maximum name & number length for the current phonebook
SetPhoneBookType(const TDesC &)
void
|
SetPhoneBookType
|
(
|
const
TDesC
&
|
aName
|
)
|
|
Sets PhoneBookType by name parameter
Parameters
const
TDesC
& aName
|
A name of the phonebook to be opened
|
SetTypeOfResponse(const TInt, const TTsyReqHandle)
void
|
SetTypeOfResponse
|
(
|
const
TInt
|
aReqHandleType,
|
|
const
TTsyReqHandle
|
aTsyReqHandle
|
|
)
|
|
Chooses the type of response, automatic or common
Parameters
const
TInt
aReqHandleType
|
req handle type.
|
const
TTsyReqHandle
aTsyReqHandle
|
req handle to be stored.
|
SimIsReady()
This method will be activate by the phone to notify the SIM is ready
UpdateCacheL(CPhoneBookStoreEntry *, TBool)
This method updates cache
WriteByIndexL(TInt)
TInt
|
WriteByIndexL
|
(
|
TInt
|
aIndex
|
)
|
[private]
|
Writes entry by given index, index should be mapped to (U)SIM world
WriteL(const TTsyReqHandle, TDesC8 *, TInt *)
Phonebookstorage specific Write -Request
Parameters
const
TTsyReqHandle
aTsyReqHandle
|
Request handle
|
TDesC8
* aPBData
|
data holding entry to write
|
TInt
* aIndex
|
index to write
|
Member Enumerations Documentation
Enum TPBArrayTypeToRead
Enumerators
EPBStoreCacheArray
|
|
EPBStoreReadEntriesArray
|
|
Enum TPBRequestTypes
Request types used for Phonebook store requests.
Enumerators
EMultimodePhoneBookStoreReqHandleUnknown
|
|
EMultimodePhoneStoreRead
|
|
EMultimodePhoneStoreWrite
|
|
EMultimodePhoneBookStoreRead
|
|
EMultimodePhoneBookStoreWrite
|
|
EMultimodePhoneStoreDelete
|
|
EMultimodePhoneStoreDeleteAll
|
|
EMultimodePhoneStoreGetInfo
|
|
EMultimodePhoneStoreNotifyStoreEvent
|
|
EMmTsyNumOfStorageRequests
|
|
Member Data Documentation
TDes8 * iBufferToRead
TDes8
*
|
iBufferToRead
|
[private]
|
TBool
iCacheReady
TBool
|
iCacheReady
|
[private]
|
CPhoneBookStoreEntry * iDeleteEntry
RMobilePhoneBookStore::TPBIndexAndNumEntries * iIndexAndEntries
TInt
iIndexToRead
TInt
|
iIndexToRead
|
[private]
|
TInt
iInitError
TInt
|
iInitError
|
[private]
|
TBool
iIsPBInitCompleted
TBool
|
iIsPBInitCompleted
|
[private]
|
TBool
iIsUsedEntriesCounted
TBool
|
iIsUsedEntriesCounted
|
[private]
|
TInt
iMaxNumLen
TInt
|
iMaxNumLen
|
[private]
|
TInt
iMaxTextLen
TInt
|
iMaxTextLen
|
[private]
|
CMmPhoneBookStoreExtInterface * iMmPhoneBookStoreExtInterface
CMmPhoneBookStoreExtInterface *
|
iMmPhoneBookStoreExtInterface
|
[private]
|
CMmPhoneTsy * iMmPhoneTsy
RMobilePhoneStore::TMobileStoreEvent
iMobilePhoneBookStoreEvent
TInt
iMultipleReadPosTo
TInt
|
iMultipleReadPosTo
|
[private]
|
TInt * iNotifyPhoneBookStoreEventIndexPtr
TInt
*
|
iNotifyPhoneBookStoreEventIndexPtr
|
[private]
|
TAny * iNotifyPhoneBookStoreEventPtr
TAny
*
|
iNotifyPhoneBookStoreEventPtr
|
[private]
|
TInt
iNumEntriesFilled
TInt
|
iNumEntriesFilled
|
[private]
|
TInt
iNumEntriesToRead
TInt
|
iNumEntriesToRead
|
[private]
|
CArrayPtrSeg< CPhoneBookStoreEntry > * iPBStoreCache
CArrayPtrSeg< CPhoneBookStoreEntry > * iPBStoreReadEntries
RMobilePhoneBookStore::TMobilePhoneBookInfoV1
iPhoneBookInfo
RMobilePhoneBookStore::TMobilePhoneBookInfoV1 * iPhoneBookInfoChanged
TName
iPhoneBookName
TName
|
iPhoneBookName
|
[private]
|
TUint8
iPhoneBookType
TUint8
|
iPhoneBookType
|
[private]
|
TReadRequestStore * iReadReqStore
TPBRequestTypes
iReqHandleType
TBool
iRequestedOnPBRead
TBool
|
iRequestedOnPBRead
|
[private]
|
TInt
iRetFillBufferedDes
TInt
|
iRetFillBufferedDes
|
[private]
|
TTsyReqHandle
iStorageReqHandles
CStorageInfoData * iStoreInfoData
CMmTsyReqHandleStore * iTsyReqHandleStore
TInt
iUsedEntries
TInt
|
iUsedEntries
|
[private]
|
CPhoneBookStoreEntry * iWriteEntry
TInt * iWriteIndexToReturn
TInt
*
|
iWriteIndexToReturn
|
[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.