Symbian^3 Application Developer Library >

RCCHClient Class Reference

class RCCHClient : public RSubSessionBase
RCCHClient declaration. A CCH sub-session object. This sub-session provides the functionality for CCH. cchclient.lib
Since
S60 3.2

Inherits from

Public Member Functions
RCCHClient ()
~RCCHClient ()
IMPORT_C void Close ()
IMPORT_C void DisableService (const TServiceSelection &, TRequestStatus &)
IMPORT_C void DisableServiceCancel ()
IMPORT_C void EnableService (const TServiceSelection &, TRequestStatus &, TBool )
IMPORT_C void EnableServiceCancel ()
IMPORT_C TInt FreeService (const TServiceSelection &)
IMPORT_C void GetConnectionInfo (const TServiceSelection &, TPckgBuf < TServiceConnectionInfo > &, TRequestStatus &)
IMPORT_C void GetConnectionInfoCancel ()
IMPORT_C TInt GetServiceInfo (const TServiceSelection &, TDes &)
IMPORT_C TInt GetServiceState (const TServiceSelection &, TCCHSubserviceState &)
IMPORT_C void GetServicesCancel ()
IMPORT_C void GetServicesL ( CArrayFixFlat < TCCHService > &, TRequestStatus &)
IMPORT_C void GetServicesL (const TServiceSelection &, CArrayFixFlat < TCCHService > &, TRequestStatus &)
IMPORT_C TBool IsReserved (const TServiceSelection &)
IMPORT_C TInt Open (const RCCHServer &)
IMPORT_C void RegisterToServer ( TRequestStatus &)
IMPORT_C void RegisterToServerCancel ()
IMPORT_C TInt ReserveService (const TServiceSelection &)
IMPORT_C void SetConnectionInfo (const TPckgBuf < TServiceConnectionInfo > &, TRequestStatus &)
IMPORT_C void SetConnectionInfoCancel ()
IMPORT_C void SubscribeToEvents (const TServiceSelection &, TPckgBuf < TServiceStatus > &, TRequestStatus &)
IMPORT_C void SubscribeToEventsCancel ()
Private Member Functions
RCCHClient (const RCCHClient &)
RCCHClient & operator= (const RCCHClient &)
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
TPtr8 * iService

Constructor & Destructor Documentation

RCCHClient()

IMPORT_C RCCHClient ( )

C++ default constructor

RCCHClient(const RCCHClient &)

RCCHClient ( const RCCHClient & ) [private]

Parameters

const RCCHClient &

~RCCHClient()

IMPORT_C ~RCCHClient ( ) [virtual]

Destructor.

Member Functions Documentation

Close()

IMPORT_C void Close ( )
Close sub-session to CCH server
Since
S60 3.2

DisableService(const TServiceSelection &, TRequestStatus &)

IMPORT_C void DisableService ( const TServiceSelection & aServiceSelection,
TRequestStatus & aReqStatus
) const
Client disables service. All sub-services under the service are disabled.
Since
S60 3.2

Parameters

const TServiceSelection & aServiceSelection Which service's or type of subservices client wants to disable, aServiceSelection's iServiceId and iType are compulsory
TRequestStatus & aReqStatus KErrNone if successful, otherwise another of the system-wide error codes.

DisableServiceCancel()

IMPORT_C void DisableServiceCancel ( ) const
Cancel disable service request.
Since
S60 3.2

EnableService(const TServiceSelection &, TRequestStatus &, TBool)

IMPORT_C void EnableService ( const TServiceSelection & aServiceSelection,
TRequestStatus & aReqStatus,
TBool aConnectivityCheck = EFalse
) const
Enable services. All sub-services under the service are enabled.
Since
S60 3.2

Parameters

const TServiceSelection & aServiceSelection Which service's or type of subservices client wants to enable, aServiceSelection's iServiceId and iType are compulsory
TRequestStatus & aReqStatus KErrNone if successful, otherwise another of the system-wide error codes.
TBool aConnectivityCheck = EFalse If value is True Connectivity Plug-in will make test call to check is the connection truly working.

EnableServiceCancel()

IMPORT_C void EnableServiceCancel ( ) const
Cancel enable services request.
Since
S60 3.2

FreeService(const TServiceSelection &)

IMPORT_C TInt FreeService ( const TServiceSelection & aServiceSelection )
Client asks to free the exclusive service reservation.
Since
S60 3.2

Parameters

const TServiceSelection & aServiceSelection Which service client wants to free. aServiceSelection's iServiceId and iType are compulsory

GetConnectionInfo(const TServiceSelection &, TPckgBuf< TServiceConnectionInfo > &, TRequestStatus &)

IMPORT_C void GetConnectionInfo ( const TServiceSelection & aServiceSelection,
TPckgBuf < TServiceConnectionInfo > & aServiceConnInfo,
TRequestStatus & aReqStatus
) const
Client ask connection information of subservice of a certain service.
Since
S60 3.2

Parameters

const TServiceSelection & aServiceSelection Service which client wants to get connection information, aServiceSelection's iServiceId and iType are compulsory
TPckgBuf < TServiceConnectionInfo > & aServiceConnInfo On completion contains selected service's connection information
TRequestStatus & aReqStatus KErrNone if successful, otherwise another of the system-wide error codes.

GetConnectionInfoCancel()

IMPORT_C void GetConnectionInfoCancel ( ) const
Cancel get connection information request.
Since
S60 3.2

GetServiceInfo(const TServiceSelection &, TDes &)

IMPORT_C TInt GetServiceInfo ( const TServiceSelection & aServiceSelection,
TDes & aBuffer
) const
Get service specifics information about service and protocol
Since
S60 3.2

Parameters

const TServiceSelection & aServiceSelection Which service's or type of subservices client wants get service information, aServiceSelection's iServiceId and iType are compulsory
TDes & aBuffer On completion contains selected service's protocol information, aBuffer's max length is in KCCHMaxProtocolNameLength which is defined in CCHClientServer.h-file

GetServiceState(const TServiceSelection &, TCCHSubserviceState &)

IMPORT_C TInt GetServiceState ( const TServiceSelection & aServiceSelection,
TCCHSubserviceState & aState
) const
Client asks for the state of service or subservice of a certain service. To perform operation quickly, network scan is not performed.
Since
S60 3.2

Parameters

const TServiceSelection & aServiceSelection Which service's state client wants to get. aServiceSelection's iServiceId and iType are compulsory
TCCHSubserviceState & aState On completion contains selected service's state.

GetServicesCancel()

IMPORT_C void GetServicesCancel ( ) const
Cancel get services request.
Since
S60 3.2

GetServicesL(CArrayFixFlat< TCCHService > &, TRequestStatus &)

IMPORT_C void GetServicesL ( CArrayFixFlat < TCCHService > & aServices,
TRequestStatus & aReqStatus
)
Get services. Client queries for all services and sub-services, network scan is performed.
Since
S60 3.2

Parameters

CArrayFixFlat < TCCHService > & aServices On completion contains all services and subservices
TRequestStatus & aReqStatus KErrNone if successful, otherwise another of the system-wide error codes

GetServicesL(const TServiceSelection &, CArrayFixFlat< TCCHService > &, TRequestStatus &)

IMPORT_C void GetServicesL ( const TServiceSelection & aServiceSelection,
CArrayFixFlat < TCCHService > & aServices,
TRequestStatus & aReqStatus
)
Get services. Client queries for certain services or type of subservices, network scan is not performed.
Since
S60 3.2

Parameters

const TServiceSelection & aServiceSelection Which service's or type of subservices client wants to get, if aServiceSelection iServiceId is zero and iType is ECCHUnknown then all services are selected
CArrayFixFlat < TCCHService > & aServices On completion contains all selected service and subservices
TRequestStatus & aReqStatus KErrNone if successful, otherwise another of the system-wide error codes.

IsReserved(const TServiceSelection &)

IMPORT_C TBool IsReserved ( const TServiceSelection & aServiceSelection ) const
Returns service's reservation status.
Since
S60 3.2

Parameters

const TServiceSelection & aServiceSelection Which service's reference count client wants to get. aServiceSelection's iServiceId and iType are compulsory

Open(const RCCHServer &)

IMPORT_C TInt Open ( const RCCHServer & aRCCHServer )
Opens a new sub-session to CCH within an existing session.
Since
S60 3.2

Parameters

const RCCHServer & aRCCHServer Open CCH session

RegisterToServer(TRequestStatus &)

IMPORT_C void RegisterToServer ( TRequestStatus & aReqStatus ) const
Register to server If CCH server crashes, Symbian will complete this message with KErrServerTerminated, CCH client is possible to create new handle to CCH server
Since
S60 5.0

Parameters

TRequestStatus & aReqStatus KErrNone if successful, otherwise another of the system-wide error codes

RegisterToServerCancel()

IMPORT_C void RegisterToServerCancel ( ) const
Cancel register server request
Since
S60 5.0

ReserveService(const TServiceSelection &)

IMPORT_C TInt ReserveService ( const TServiceSelection & aServiceSelection )
Client asks for exclusive reservation of the service e.g. to block ALR during a VoIP call
Since
S60 3.2

Parameters

const TServiceSelection & aServiceSelection Which service client wants to reserve. aServiceSelection's iServiceId and iType are compulsory

SetConnectionInfo(const TPckgBuf< TServiceConnectionInfo > &, TRequestStatus &)

IMPORT_C void SetConnectionInfo ( const TPckgBuf < TServiceConnectionInfo > & aServiceConnInfo,
TRequestStatus & aReqStatus
)
Client set's connection information of sub-service of a certain service.
Since
S60 3.2

Parameters

const TPckgBuf < TServiceConnectionInfo > & aServiceConnInfo Service where client wants to set connection information. Note that iSNAPLocked is read only.
TRequestStatus & aReqStatus KErrNone if successful, otherwise another of the system-wide error codes.

SetConnectionInfoCancel()

IMPORT_C void SetConnectionInfoCancel ( ) const
Cancel set connection information request.
Since
S60 3.2

SubscribeToEvents(const TServiceSelection &, TPckgBuf< TServiceStatus > &, TRequestStatus &)

IMPORT_C void SubscribeToEvents ( const TServiceSelection & aServiceSelection,
TPckgBuf < TServiceStatus > & aServiceStatus,
TRequestStatus & aReqStatus
) const
Subscribe to specific service events, if any service's subservices status has changed, CCH sends notify to the client.
Since
S60 3.2

Parameters

const TServiceSelection & aServiceSelection Which service's or type of subservices client wants to be notified, if aServiceSelection iServiceId is zero and iType is ECCHUnknown then all subservice events are selected
TPckgBuf < TServiceStatus > & aServiceStatus On completion contains selected service's status
TRequestStatus & aReqStatus KErrNone if successful, otherwise another of the system-wide error codes

SubscribeToEventsCancel()

IMPORT_C void SubscribeToEventsCancel ( ) const
Cancel all subscribe event request.
Since
S60 3.2

operator=(const RCCHClient &)

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

Parameters

const RCCHClient &

Member Data Documentation

TPtr8 * iService

TPtr8 * iService [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.