RFavouritesSession Class Reference

#include <mw/favouritessession.h>

class RFavouritesSession : public RSessionBase

Inherits from

RFavouritesSession
- RSessionBase
  - RHandleBase

Public Member Functions
IMPORT_C TInt	Connect()
IMPORT_C TInt	DeleteDatabase(const TDesC &)
IMPORT_C void	ResourceCheck()
IMPORT_C TInt	ResourceCount()
IMPORT_C void	ResourceMark()
void	SendReceive(TInt, const TIpcArgs &, TRequestStatus &)
TInt	SendReceive(TInt, const TIpcArgs &)
TInt	SendReceive(TInt)
IMPORT_C TVersion	Version()
IMPORT_C void	__DbgSetAllocFail(RAllocator::TAllocFail, TInt)

Inherited Attributes
	RHandleBase::iHandle

Inherited Enumerations
	RHandleBase:TAttributes
	RSessionBase:TAttachMode

Inherited Functions
	RHandleBase::Attributes()const
	RHandleBase::BTraceId()const
	RHandleBase::Close()
	RHandleBase::DoExtendedClose()
	RHandleBase::Duplicate(const RThread &,TOwnerType)
	RHandleBase::FullName()const
	RHandleBase::FullName(TDes &)const
	RHandleBase::Handle()const
	RHandleBase::HandleInfo(THandleInfo *)
	RHandleBase::Name()const
	RHandleBase::NotifyDestruction(TRequestStatus &)
	RHandleBase::Open(const TFindHandleBase &,TOwnerType)
	RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
	RHandleBase::RHandleBase()
	RHandleBase::RHandleBase(TInt)
	RHandleBase::SetHandle(TInt)
	RHandleBase::SetHandleNC(TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
	RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
	RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Open(TInt,TOwnerType)
	RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Send(TInt)const
	RSessionBase::Send(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSessionBase::SetReturnedHandle(TInt)
	RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
	RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
	RSessionBase::ShareAuto()
	RSessionBase::ShareProtected()

Detailed Description

RFavouritesSession is the Favourites Engine Session. It represents the connection to the Favourites Engine Server.

Member Function Documentation

Connect ( )

IMPORT_C TInt

Connect

(

)

Connect to Favourites Server.

Since: 0.9

Return Value: Error code.

DeleteDatabase ( const TDesC & )

IMPORT_C TInt

DeleteDatabase

(

const TDesC &

aName

)

Delete database.

Since: 0.9

Parameters
aName	Database name.

Return Value: ErrorCode

ResourceCheck ( )

IMPORT_C void

ResourceCheck

(

)

Check that the number of allocated object through this session matches the same of when the last call to ResourceMark was made.

Since: 0.9

Return Value: void

ResourceCount ( )

IMPORT_C TInt

ResourceCount

(

)

Get number of allocated object through this session.

Since: 0.9

Return Value: void

ResourceMark ( )

IMPORT_C void

ResourceMark

(

)

Start checking the number of allocated object through this session.

Since: 0.9

Return Value: void

SendReceive ( TInt, const TIpcArgs &, TRequestStatus & )

void	SendReceive	(	TInt	aFunction,
			const TIpcArgs &	aArgs,
			TRequestStatus &	aStatus
		)	const [inline]

Reimplemented from RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const

Message passing routine.

Since: 0.9

Parameters
aFunction	Function.
aArgs	Arguments.
aStatus	Request status.

SendReceive ( TInt, const TIpcArgs & )

TInt	SendReceive	(	TInt	aFunction,
			const TIpcArgs &	aArgs
		)	const [inline]

Reimplemented from RSessionBase::SendReceive(TInt,const TIpcArgs &)const

Message passing routine.

Since: 0.9

Parameters
aFunction	Function.
aArgs	Arguments.

Return Value: Error code.

SendReceive ( TInt )

TInt

SendReceive

(

TInt

aFunction

)

const [inline]

Reimplemented from RSessionBase::SendReceive(TInt)const

Message passing routine.

Since: 0.9

Parameters
aFunction	Function.

Return Value: Error code.

Version ( )

IMPORT_C TVersion

Version

(

)

[static]

Get version.

Since: 0.9

Return Value: Version.

__DbgSetAllocFail ( RAllocator::TAllocFail, TInt )

IMPORT_C void	__DbgSetAllocFail	(	RAllocator::TAllocFail	aType,
			TInt	aRate
		)

Simulate a heap allocation failure for server heap. Has empty implementation for the UDEB server.

Since: 0.9

Parameters
aType	Type of heap failure simulation.
aRate	Rate of failure.

Return Value: void