Collapse all Symbian^3 Product Developer Library

RNSmlDMCallbackSession Class Reference

class RNSmlDMCallbackSession : public RSessionBase

RNSmlDMCallbackSession is Symbian OS client session for connecting to DM callback server which handles the tree database. The tree database can be used via this client interface.

Since

Inherits from

RNSmlDMCallbackSession
- RSessionBase
  - RHandleBase

Public Member Functions
	RNSmlDMCallbackSession()
	~RNSmlDMCallbackSession()
IMPORT_C TInt	AddMappingInfoL(TUint32, const TDesC8 &, const TDesC8 &)
IMPORT_C TBool	CheckAclL(const TDesC8 &, TNSmlDmCmdType)
IMPORT_C TBool	CheckDynamicAclL(const TDesC8 &, TNSmlDmCmdType, CNSmlDmMgmtTree *)
IMPORT_C void	Close()
IMPORT_C TInt	CommitAtomic()
IMPORT_C TInt	Connect()
IMPORT_C TInt	DefaultACLsToChildrenL(const TDesC8 &, CBufBase &)
IMPORT_C TInt	DefaultACLsToServerL(const TDesC8 &)
IMPORT_C TInt	DeleteAclL(const TDesC8 &)
IMPORT_C TInt	EraseServerIdL(const TDesC8 &)
IMPORT_C TInt	GetAclL(const TDesC8 &, CBufBase &, TBool)
IMPORT_C HBufC8 *	GetLuidAllocL(TUint32, const TDesC8 &)
IMPORT_C void	GetUriSegListL(TUint32, const TDesC8 &, CArrayFixFlat< TSmlDmMappingInfo > &)
IMPORT_C TInt	RemoveMappingInfoL(TUint32, const TDesC8 &, TBool)
IMPORT_C TInt	RenameMappingL(TUint32, const TDesC8 &, const TDesC8 &)
IMPORT_C TInt	ResourceCount()
IMPORT_C TInt	RollbackAtomic()
IMPORT_C void	SetServerL(const TDesC8 &)
IMPORT_C TInt	StartAtomic()
IMPORT_C TInt	UpdateAclL(const TDesC8 &, const TDesC8 &)
IMPORT_C void	UpdateMappingInfoL(TUint32, const TDesC8 &, CBufBase &)
TVersion	Version(void)

Inherited Functions
	RHandleBase::Attributes()const
	RHandleBase::BTraceId()const
	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)const
	RSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSessionBase::SetReturnedHandle(TInt)
	RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
	RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
	RSessionBase::ShareAuto()
	RSessionBase::ShareProtected()

Inherited Enumerations
	RHandleBase:TAttributes
	RSessionBase:TAttachMode

Private Attributes
TInt	iEnforceCheckdone
RPointerArray< HBufC8 >	iLuids

Inherited Attributes
	RHandleBase::iHandle

Constructor & Destructor Documentation

RNSmlDMCallbackSession()

IMPORT_C

RNSmlDMCallbackSession

(

)

Constructor

~RNSmlDMCallbackSession()

IMPORT_C

~RNSmlDMCallbackSession

(

)

Desstructor

Member Functions Documentation

AddMappingInfoL(TUint32, const TDesC8 &, const TDesC8 &)

IMPORT_C TInt	AddMappingInfoL	(	TUint32	aAdapterId,
			const TDesC8 &	aURI,
			const TDesC8 &	aLuid
		)

Adds new mapping

Parameters

TUint32 aAdapterId	Id of plug-in adapter
const TDesC8 & aURI	URI
const TDesC8 & aLuid	Luid to be mapped to URI

CheckAclL(const TDesC8 &, TNSmlDmCmdType)

IMPORT_C TBool	CheckAclL	(	const TDesC8 &	aURI,
			TNSmlDmCmdType	aCmdType
		)

Check acl to current command.

Parameters

const TDesC8 & aURI	URI
TNSmlDmCmdType aCmdType	Type of command to be checked

CheckDynamicAclL(const TDesC8 &, TNSmlDmCmdType, CNSmlDmMgmtTree *)

IMPORT_C TBool	CheckDynamicAclL	(	const TDesC8 &	aURI,
			TNSmlDmCmdType	aCmdType,
			CNSmlDmMgmtTree *	aMgmtTree
		)

Check ACL rights, default value is used if acl is not available

Note:

This function (as well as RNSmlDMCallbackSession::CheckAclL) will not specify when the URI does not point into an _existing_ node. Then it returns the same code when access to URI is denied.

Parameters

const TDesC8 & aURI	Target URI in command
TNSmlDmCmdType aCmdType	Command type or not
CNSmlDmMgmtTree * aMgmtTree	Management tree, a structure that holds current and valid ddf information

Close()

IMPORT_C void

(

)

Close the session

CommitAtomic()

IMPORT_C TInt

CommitAtomic

(

)

Commits atomic

Connect()

IMPORT_C TInt

Connect

(

)

Connects to server

DefaultACLsToChildrenL(const TDesC8 &, CBufBase &)

IMPORT_C TInt	DefaultACLsToChildrenL	(	const TDesC8 &	aURI,
			CBufBase &	aCurrentList
		)

Set default acls to children which does not have earlier set ACLs

Parameters

const TDesC8 & aURI	URI
CBufBase & aCurrentList	List of children

DefaultACLsToServerL(const TDesC8 &)

IMPORT_C TInt

DefaultACLsToServerL

(

const TDesC8 &

aURI

)

Set default acls to current server

Parameters

const TDesC8 & aURI

URI

DeleteAclL(const TDesC8 &)

IMPORT_C TInt

DeleteAclL

(

const TDesC8 &

aURI

)

Delete acl pointed by URI

Parameters

const TDesC8 & aURI

URI

EraseServerIdL(const TDesC8 &)

IMPORT_C TInt

EraseServerIdL

(

const TDesC8 &

aServerId

)

Erases references to server from acls

Parameters

const TDesC8 & aServerId

Server name to be erased

GetAclL(const TDesC8 &, CBufBase &, TBool)

IMPORT_C TInt	GetAclL	(	const TDesC8 &	aURI,
			CBufBase &	aACL,
			TBool	aInherited = ETrue
		)

Get acl pointed by URI. Two phase operation, the length is get first, then the acl data itself

Parameters

const TDesC8 & aURI	URI
CBufBase & aACL	Buffer for writing the result ACL
TBool aInherited = ETrue	If true, the inherited value is searhed

GetLuidAllocL(TUint32, const TDesC8 &)

IMPORT_C HBufC8 *	GetLuidAllocL	(	TUint32	aAdapterId,
			const TDesC8 &	aURI
		)

Gets luid from server. Two phase operation, asks first the length, then data

Parameters

TUint32 aAdapterId	Id of plug-in adapter
const TDesC8 & aURI	URI

GetUriSegListL(TUint32, const TDesC8 &, CArrayFixFlat< TSmlDmMappingInfo > &)

IMPORT_C void	GetUriSegListL	(	TUint32	aAdapterId,
			const TDesC8 &	aURI,
			CArrayFixFlat< TSmlDmMappingInfo > &	aURISegList
		)

Gets uri seg list from server. Two phase operation, asks first the data length, then data itself

Parameters

TUint32 aAdapterId	Id of plug-in adapter
const TDesC8 & aURI	URI
CArrayFixFlat< TSmlDmMappingInfo > & aURISegList	Reference to list where to fill data

RemoveMappingInfoL(TUint32, const TDesC8 &, TBool)

IMPORT_C TInt	RemoveMappingInfoL	(	TUint32	aAdapterId,
			const TDesC8 &	aURI,
			TBool	aChildAlso = ETrue
		)

Remove mapping

Parameters

TUint32 aAdapterId	Id of plug-in adapter
const TDesC8 & aURI	URI
TBool aChildAlso = ETrue	If true, removes also children

RenameMappingL(TUint32, const TDesC8 &, const TDesC8 &)

IMPORT_C TInt	RenameMappingL	(	TUint32	aAdapterId,
			const TDesC8 &	aURI,
			const TDesC8 &	aObject
		)

Rename mapping

Parameters

TUint32 aAdapterId	Id of plug-in adapter
const TDesC8 & aURI	URI
const TDesC8 & aObject	New name (last uri segment)

ResourceCount()

IMPORT_C TInt

ResourceCount

(

)

Not used at the moment

RollbackAtomic()

IMPORT_C TInt

RollbackAtomic

(

)

Rolls back the commansd inside atomic

SetServerL(const TDesC8 &)

IMPORT_C void

SetServerL

(

const TDesC8 &

aServerId

)

Sets server id of current session

Parameters

const TDesC8 & aServerId

Server identifier

StartAtomic()

IMPORT_C TInt

StartAtomic

(

)

Indicates atomic start

UpdateAclL(const TDesC8 &, const TDesC8 &)

IMPORT_C TInt	UpdateAclL	(	const TDesC8 &	aURI,
			const TDesC8 &	aACL
		)

Update acl pointed by URI

Parameters

const TDesC8 & aURI	URI
const TDesC8 & aACL	New ACL info

UpdateMappingInfoL(TUint32, const TDesC8 &, CBufBase &)

IMPORT_C void	UpdateMappingInfoL	(	TUint32	aAdapterId,
			const TDesC8 &	aURI,
			CBufBase &	aCurrentList
		)

Update mappings (clear database in case of getting childlist)

Parameters

TUint32 aAdapterId	Id of plug-in adapter
const TDesC8 & aURI	URI
CBufBase & aCurrentList	Child list from adapter

Version(void)

TVersion

Version

(

void

)

const

Returns version

Parameters

void

Member Data Documentation

TInt iEnforceCheckdone

TInt

iEnforceCheckdone

[private]

Memeber variable to know the enforcement check of a particular setting is happened or not

RPointerArray< HBufC8 > iLuids

RPointerArray< HBufC8 >

iLuids

[private]

Luid list when gettiing the luid list