Collapse all Symbian^3 Application Developer Library

RCcClientSession Class Reference

class RCcClientSession : public RSessionBase

Content control server client side session

hsccsrv.lib

Since: S60 v5.0

Inherits from

RCcClientSession
- RSessionBase
  - RHandleBase

Protected Member Functions
IMPORT_C TInt	CancelReq ( TPckgBuf < TInt > &)
IMPORT_C void	Close ()
IMPORT_C TInt	Connect ()
IMPORT_C TInt	GetMsgData ( TPckgBuf < TUint32 > &, TPtr8 &)
IMPORT_C TInt	RegisterObserver ( TPckgBuf < TUint32 > &, TPckgBuf < TUint32 > &)
IMPORT_C TInt	RegisterProvider ( TPckgBuf < TUint32 > &, TPckgBuf < TUint32 > &)
IMPORT_C TInt	Send ( TInt , TPckgBuf < TUint32 > &, TPckgBuf < TUint32 > &, TPckgBuf < TUint32 > &, TPtr8 &)
IMPORT_C void	WaitForApiNtf ( TPckgBuf < TUint32 > &, TPckgBuf < TUint32 > &, TPckgBuf < TUint32 > &, TPtr8 &, TRequestStatus &)
IMPORT_C void	WaitForApiReq ( TPckgBuf < TUint32 > &, TPckgBuf < TUint32 > &, TPckgBuf < TUint32 > &, TPtr8 &, TRequestStatus &)

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

Inherited Attributes
	RHandleBase::iHandle

Member Functions Documentation

CancelReq(TPckgBuf< TInt > &)

IMPORT_C TInt

CancelReq

(

TPckgBuf < TInt > &

aFunction

)

[protected]

Cancels outstanding async request

Since: S60 5.0

Parameters

TPckgBuf < TInt > & aFunction

Canceled function

Close()

IMPORT_C void

(

)

[protected]

Close.

Since: S60 5.0

Connect()

IMPORT_C TInt

Connect

(

)

[protected]

Connect.

Since: S60 5.0

GetMsgData(TPckgBuf< TUint32 > &, TPtr8 &)

IMPORT_C TInt	GetMsgData	(	TPckgBuf < TUint32 > &	aTrId,
			TPtr8 &	aBuf
		)	[protected]

Reads message data

Since: S60 5.0

Parameters

TPckgBuf < TUint32 > & aTrId	Transaction id
TPtr8 & aBuf	Data buffer

RegisterObserver(TPckgBuf< TUint32 > &, TPckgBuf< TUint32 > &)

IMPORT_C TInt	RegisterObserver	(	TPckgBuf < TUint32 > &	aProvider,
			TPckgBuf < TUint32 > &	aAddress
		)	[protected]

Registers content control API observer

Since: S60 5.0

Parameters

TPckgBuf < TUint32 > & aProvider	Provider id
TPckgBuf < TUint32 > & aAddress	Registered address of observer

RegisterProvider(TPckgBuf< TUint32 > &, TPckgBuf< TUint32 > &)

IMPORT_C TInt	RegisterProvider	(	TPckgBuf < TUint32 > &	aProvider,
			TPckgBuf < TUint32 > &	aAddress
		)	[protected]

Registers content control API provider

Since: S60 5.0

Parameters

TPckgBuf < TUint32 > & aProvider	Provider id
TPckgBuf < TUint32 > & aAddress	Registered address of service provider

Send(TInt, TPckgBuf< TUint32 > &, TPckgBuf< TUint32 > &, TPckgBuf< TUint32 > &, TPtr8 &)

IMPORT_C TInt	Send	(	TInt	aFunction,
			TPckgBuf < TUint32 > &	aProvider,
			TPckgBuf < TUint32 > &	aSender,
			TPckgBuf < TUint32 > &	aReceiver,
			TPtr8 &	aBuf
		)	[protected]

Sends API request/response to Home screen content control server

Since: S60 5.0

Parameters

TInt aFunction	IPC function EHsCcApiReq/EHsCcApiResp
TPckgBuf < TUint32 > & aProvider	Provider id
TPckgBuf < TUint32 > & aSender	Sender of Api request
TPckgBuf < TUint32 > & aReceiver	Service provider
TPtr8 & aBuf	Message buffer: in: service request out: service response header

WaitForApiNtf(TPckgBuf< TUint32 > &, TPckgBuf< TUint32 > &, TPckgBuf< TUint32 > &, TPtr8 &, TRequestStatus &)

IMPORT_C void	WaitForApiNtf	(	TPckgBuf < TUint32 > &	aProvider,
			TPckgBuf < TUint32 > &	aSender,
			TPckgBuf < TUint32 > &	aReceiver,
			TPtr8 &	aBuf,
			TRequestStatus &	aStatus
		)	[protected]

Starts receiving API notifications

Since: S60 5.0

Parameters

TPckgBuf < TUint32 > & aProvider	Provider id
TPckgBuf < TUint32 > & aSender	Sender of Api request
TPckgBuf < TUint32 > & aReceiver	Service provider
TPtr8 & aBuf	Message buffer for received API notification header
TRequestStatus & aStatus	Completion status for IPC request

WaitForApiReq(TPckgBuf< TUint32 > &, TPckgBuf< TUint32 > &, TPckgBuf< TUint32 > &, TPtr8 &, TRequestStatus &)

IMPORT_C void	WaitForApiReq	(	TPckgBuf < TUint32 > &	aProvider,
			TPckgBuf < TUint32 > &	aSender,
			TPckgBuf < TUint32 > &	aReceiver,
			TPtr8 &	aBuf,
			TRequestStatus &	aStatus
		)	[protected]

Starts receiving API requests

Since: S60 5.0

Parameters

TPckgBuf < TUint32 > & aProvider	Provider id
TPckgBuf < TUint32 > & aSender	Sender of Api request
TPckgBuf < TUint32 > & aReceiver	Service provider
TPtr8 & aBuf	Message buffer for received API request header
TRequestStatus & aStatus	Completion status for IPC request