Collapse all Symbian^3 Application Developer Library

RCbsMcnSession Class Reference

class RCbsMcnSession : public RSessionBase

This class represents a MCN session to the CBS server.

Inherits from

RCbsMcnSession
- RSessionBase
  - RHandleBase

Public Member Functions
	RCbsMcnSession ()
	~RCbsMcnSession ()
void	ClearSubscriptionsL ()
void	Close ()
TInt	Connect ()
TInt	GetCellInfo ( TDes &)
TInt	GetInfoMessage ( TDes &, const TInt )
void	ReadMcnMessage ( TRequestStatus &, TPckg < TCbsMcnMessage > &)
TInt	ReadMcnMessageCancel ()
void	RegisterL (const CMcnTopicArray &)
TVersion	Version ()

Private Member Functions
	RCbsMcnSession (const RCbsMcnSession &)
RCbsMcnSession &	operator= (const RCbsMcnSession &)

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
TBool	iConnected
RMcnSubSession	iSubSession

Inherited Attributes
	RHandleBase::iHandle

Constructor & Destructor Documentation

RCbsMcnSession()

RCbsMcnSession

(

)

Constructor

RCbsMcnSession(const RCbsMcnSession &)

RCbsMcnSession

(

const RCbsMcnSession &

)

[private]

Parameters

const RCbsMcnSession &

~RCbsMcnSession()

~RCbsMcnSession

(

)

Destructor

Member Functions Documentation

ClearSubscriptionsL()

void

ClearSubscriptionsL

(

)

Clears all topic subscriptions of this session in CbsServer.

Leaves if server reports an error.

Close()

void

(

)

Closes the connection with CbsServer.

Connect()

TInt

Connect

(

)

Establishes a connection with CbsServer.

GetCellInfo(TDes &)

TInt

GetCellInfo

(

TDes &

aMcnMessage

)

const

Retrieves the current MCN message from CBS server. An arriving MCN message always overwrites the previous one in CBS server, no buffering is done.

Parameters

TDes & aMcnMessage

Returns the current MCN message.

GetInfoMessage(TDes &, const TInt)

TInt	GetInfoMessage	(	TDes &	aMessage,
			const TInt	aTopicNumber
		)	const

Retrieves the current info message from CBS server.

Parameters

TDes & aMessage	Returns the current info message from the specified topic.
const TInt aTopicNumber	Number of the topic that the msg belongs to.

ReadMcnMessage(TRequestStatus &, TPckg< TCbsMcnMessage > &)

void	ReadMcnMessage	(	TRequestStatus &	aStatus,
			TPckg < TCbsMcnMessage > &	aMcnPckg
		)

Request next subscribed MCN message to be delivered to this session. Passed to the subsession object.

The delivered message will be copied into aBuffer.

Parameters

TRequestStatus & aStatus	Request status, indicates the result of the operation.
TPckg < TCbsMcnMessage > & aMcnPckg	MCN message package, includes msg and parameters

ReadMcnMessageCancel()

TInt

ReadMcnMessageCancel

(

)

Cancels an outstanding request. Passed to the subsession object.

RegisterL(const CMcnTopicArray &)

void

RegisterL

(

const CMcnTopicArray &

aArray

)

Subscribes topics given in aArray. Passed to the subsession object.

For leave reasons, see RMcnSubSession .

Parameters

const CMcnTopicArray & aArray

Subscribed topics.

Version()

TVersion

Version

(

)

const

Returns version information of this dll.

operator=(const RCbsMcnSession &)

RCbsMcnSession &

operator=

(

const RCbsMcnSession &

)

[private]

Parameters

const RCbsMcnSession &

Member Data Documentation

TBool iConnected

TBool

iConnected

[private]

RMcnSubSession iSubSession

RMcnSubSession

iSubSession

[private]