Symbian^3 Application Developer Library >

RCbsTopicCollection Class Reference

class RCbsTopicCollection : public RSubSessionBase

This represents the client-side subsession to retrieve information from topic collections.

Inherits from

Public Member Functions
RCbsTopicCollection ()
TInt Close ()
void GetTopicCount ( TInt &)
TInt GetTopicInfo ( TInt , TCbsTopicInfo &)
TBool HasNextTopic ()
TInt NextTopic ( TCbsTopicInfo &)
void NotifyOnChange ( TRequestStatus &)
void NotifyOnChangeCancel ()
TInt Open ( RCbs &)
void Start ()
Private Member Functions
RCbsTopicCollection (const RCbsTopicCollection &)
TInt TopicInList ( TInt , TBool &)
RCbsTopicCollection & operator= (const RCbsTopicCollection &)
Inherited Functions
RSubSessionBase::CloseSubSession(TInt)
RSubSessionBase::CreateAutoCloseSubSession(RSessionBase &,TInt,const TIpcArgs &)
RSubSessionBase::CreateSubSession(const RSessionBase &,TInt)
RSubSessionBase::CreateSubSession(const RSessionBase &,TInt,const TIpcArgs &)
RSubSessionBase::RSubSessionBase()
RSubSessionBase::Send(TInt)const
RSubSessionBase::Send(TInt,const TIpcArgs &)const
RSubSessionBase::SendReceive(TInt)const
RSubSessionBase::SendReceive(TInt,TRequestStatus &)const
RSubSessionBase::SendReceive(TInt,const TIpcArgs &)const
RSubSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
RSubSessionBase::Session()const
RSubSessionBase::SubSessionHandle()const
Private Attributes
TInt iIterator

Constructor & Destructor Documentation

RCbsTopicCollection()

RCbsTopicCollection ( )

Constructor.

RCbsTopicCollection(const RCbsTopicCollection &)

RCbsTopicCollection ( const RCbsTopicCollection & ) [private]

Parameters

const RCbsTopicCollection &

Member Functions Documentation

Close()

TInt Close ( )

Closes the subsession.

GetTopicCount(TInt &)

void GetTopicCount ( TInt & aCount )

Returns the total amount of topic information the topic collection contains.

Parameters

TInt & aCount It will contain the amount.

GetTopicInfo(TInt, TCbsTopicInfo &)

TInt GetTopicInfo ( TInt aIndex,
TCbsTopicInfo & aInfo
)

Returns a topic information structure.

Parameters

TInt aIndex It is index to the topic info.
TCbsTopicInfo & aInfo It will contain the information.

HasNextTopic()

TBool HasNextTopic ( )

Returns ETrue, if there is a topic not accessed with NextTopic()

NextTopic(TCbsTopicInfo &)

TInt NextTopic ( TCbsTopicInfo & aInfo )

Returns the next topic in the topic collection skipping all topics with a topic number matching a topic already listed in the current topic list. This function will return KErrNotFound if the collection is tried to access beyond the end of the list. Otherwise the error code will be the same returned by GetTopicInfo() .

Parameters

TCbsTopicInfo & aInfo The topic information will be stored here.

NotifyOnChange(TRequestStatus &)

void NotifyOnChange ( TRequestStatus & aStatus )

Notifies the client next time when topic collection changes.

Parameters

TRequestStatus & aStatus It will be changed when topic collection changes.

NotifyOnChangeCancel()

void NotifyOnChangeCancel ( )

Cancels the pending request to notify.

Open(RCbs &)

TInt Open ( RCbs & aServer )

Creates a subsession to the server.

Note that the method must be called before any other method can be used.

Parameters

RCbs & aServer The base session.

Start()

void Start ( )

Resets the iterator. Must be called prior any call to HasNextTopic() or NextTopic() !

TopicInList(TInt, TBool &)

TInt TopicInList ( TInt aIndex,
TBool & aInList
) [private]

Returns information whether the topic was in topic list.

Parameters

TInt aIndex Topic index
TBool & aInList Was the topic in the list

operator=(const RCbsTopicCollection &)

RCbsTopicCollection & operator= ( const RCbsTopicCollection & ) [private]

Parameters

const RCbsTopicCollection &

Member Data Documentation

TInt iIterator

TInt iIterator [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.