Symbian^3 Product 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 voidClose()
IMPORT_C voidDisableService(const TServiceSelection &, TRequestStatus &)
IMPORT_C voidDisableServiceCancel()
IMPORT_C voidEnableService(const TServiceSelection &, TRequestStatus &, TBool)
IMPORT_C voidEnableServiceCancel()
IMPORT_C TIntFreeService(const TServiceSelection &)
IMPORT_C voidGetConnectionInfo(const TServiceSelection &, TPckgBuf< TServiceConnectionInfo > &, TRequestStatus &)
IMPORT_C voidGetConnectionInfoCancel()
IMPORT_C TIntGetServiceInfo(const TServiceSelection &, TDes &)
IMPORT_C TIntGetServiceState(const TServiceSelection &, TCCHSubserviceState &)
IMPORT_C voidGetServicesCancel()
IMPORT_C voidGetServicesL(CArrayFixFlat< TCCHService > &, TRequestStatus &)
IMPORT_C voidGetServicesL(const TServiceSelection &, CArrayFixFlat< TCCHService > &, TRequestStatus &)
IMPORT_C TBoolIsReserved(const TServiceSelection &)
IMPORT_C TIntOpen(const RCCHServer &)
IMPORT_C voidRegisterToServer(TRequestStatus &)
IMPORT_C voidRegisterToServerCancel()
IMPORT_C TIntReserveService(const TServiceSelection &)
IMPORT_C voidSetConnectionInfo(const TPckgBuf< TServiceConnectionInfo > &, TRequestStatus &)
IMPORT_C voidSetConnectionInfoCancel()
IMPORT_C voidSubscribeToEvents(const TServiceSelection &, TPckgBuf< TServiceStatus > &, TRequestStatus &)
IMPORT_C voidSubscribeToEventsCancel()
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_CRCCHClient()

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 voidClose()
Close sub-session to CCH server
Since
S60 3.2

DisableService(const TServiceSelection &, TRequestStatus &)

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

Parameters

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

DisableServiceCancel()

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

EnableService(const TServiceSelection &, TRequestStatus &, TBool)

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

Parameters

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

EnableServiceCancel()

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

FreeService(const TServiceSelection &)

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

Parameters

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

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

IMPORT_C voidGetConnectionInfo(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 & aServiceSelectionService which client wants to get connection information, aServiceSelection's iServiceId and iType are compulsory
TPckgBuf< TServiceConnectionInfo > & aServiceConnInfoOn completion contains selected service's connection information
TRequestStatus & aReqStatusKErrNone if successful, otherwise another of the system-wide error codes.

GetConnectionInfoCancel()

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

GetServiceInfo(const TServiceSelection &, TDes &)

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

Parameters

const TServiceSelection & aServiceSelectionWhich service's or type of subservices client wants get service information, aServiceSelection's iServiceId and iType are compulsory
TDes & aBufferOn 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 TIntGetServiceState(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 & aServiceSelectionWhich service's state client wants to get. aServiceSelection's iServiceId and iType are compulsory
TCCHSubserviceState & aStateOn completion contains selected service's state.

GetServicesCancel()

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

GetServicesL(CArrayFixFlat< TCCHService > &, TRequestStatus &)

IMPORT_C voidGetServicesL(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 > & aServicesOn completion contains all services and subservices
TRequestStatus & aReqStatusKErrNone if successful, otherwise another of the system-wide error codes

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

IMPORT_C voidGetServicesL(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 & aServiceSelectionWhich 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 > & aServicesOn completion contains all selected service and subservices
TRequestStatus & aReqStatusKErrNone if successful, otherwise another of the system-wide error codes.

IsReserved(const TServiceSelection &)

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

Parameters

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

Open(const RCCHServer &)

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

Parameters

const RCCHServer & aRCCHServerOpen CCH session

RegisterToServer(TRequestStatus &)

IMPORT_C voidRegisterToServer(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 & aReqStatusKErrNone if successful, otherwise another of the system-wide error codes

RegisterToServerCancel()

IMPORT_C voidRegisterToServerCancel()const
Cancel register server request
Since
S60 5.0

ReserveService(const TServiceSelection &)

IMPORT_C TIntReserveService(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 & aServiceSelectionWhich service client wants to reserve. aServiceSelection's iServiceId and iType are compulsory

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

IMPORT_C voidSetConnectionInfo(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 > & aServiceConnInfoService where client wants to set connection information. Note that iSNAPLocked is read only.
TRequestStatus & aReqStatusKErrNone if successful, otherwise another of the system-wide error codes.

SetConnectionInfoCancel()

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

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

IMPORT_C voidSubscribeToEvents(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 & aServiceSelectionWhich 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 > & aServiceStatusOn completion contains selected service's status
TRequestStatus & aReqStatusKErrNone if successful, otherwise another of the system-wide error codes

SubscribeToEventsCancel()

IMPORT_C voidSubscribeToEventsCancel()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.