Symbian^3 Product Developer Library >

CCchService Class Reference

class CCchService : public CBase
CCchService declaration. CCH service connectivity plug-in API.
Since
S60 3.2

Inherits from

Public Member Functions
~CCchService()
voidDisableServiceL(const TServiceSelection &)
voidEnableServiceL(const TServiceSelection &)
voidEnableServiceL(const TServiceSelection &, TUint)
TInt FreeService(const TServiceSelection &)
TInt GetConnectionParameter(const TServiceSelection &, TCchConnectionParameter, TInt &)
TInt GetConnectionParameter(const TServiceSelection &, TCchConnectionParameter, RBuf &)
voidGetServiceInfoL(const TServiceSelection &, RBuf &)
TInt GetServiceNetworkInfo(TServiceConnectionInfo &)
TInt GetServiceState(const TServiceSelection &, TCCHSubserviceState &)
TBool IsAvailableL(const TServiceSelection &, const RArray< TUint32 > &)
TBool IsReserved(const TServiceSelection &)
CCchService *NewL(TUid, MCchServiceObserver &)
TInt ReserveService(const TServiceSelection &)
TInt SetConnectionParameter(const TServiceSelection &, TCchConnectionParameter, TInt)
TInt SetConnectionParameter(const TServiceSelection &, TCchConnectionParameter, const TDesC &)
TInt SetIapId(const TServiceSelection &, TUint)
TInt SetSnapId(const TServiceSelection &, TUint)
Protected Member Functions
CCchService()
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Public Attributes
TUid iInstanceKey

Constructor & Destructor Documentation

CCchService()

CCchService()[protected, inline]

~CCchService()

~CCchService()[inline, virtual]

Member Functions Documentation

DisableServiceL(const TServiceSelection &)

voidDisableServiceL(const TServiceSelection &aServiceSelection)[pure virtual]
Client disables service.
Since
S60 3.2

Parameters

const TServiceSelection & aServiceSelectionSelected service, ID and type

EnableServiceL(const TServiceSelection &)

voidEnableServiceL(const TServiceSelection &aServiceSelection)[pure virtual]
Client enables service. CCHService implementation should use MCCHServiceObserver for service state notifications.
Since
S60 3.2

Parameters

const TServiceSelection & aServiceSelectionSelected service, ID and type

EnableServiceL(const TServiceSelection &, TUint)

voidEnableServiceL(const TServiceSelection &aServiceSelection,
TUintaIapId
)[pure virtual]
Client enables service. CCHService implementation should use MCCHServiceObserver for service state notifications.
Since
S60 3.2

Parameters

const TServiceSelection & aServiceSelectionSelected service, ID and type
TUint aIapId

FreeService(const TServiceSelection &)

TInt FreeService(const TServiceSelection &aServiceSelection)[pure virtual]
Frees the exclusive service reservation
Since
S60 3.2

Parameters

const TServiceSelection & aServiceSelectionSelected service, ID and type

GetConnectionParameter(const TServiceSelection &, TCchConnectionParameter, TInt &)

TInt GetConnectionParameter(const TServiceSelection &aServiceSelection,
TCchConnectionParameteraParameter,
TInt &aValue
)const [pure virtual]
Returns the connection parameters
Since
S60 3.2.3

Parameters

const TServiceSelection & aServiceSelectionSelected service, ID and type
TCchConnectionParameter aParameterConnection parameter of the service
TInt & aValueValue of the parameter

GetConnectionParameter(const TServiceSelection &, TCchConnectionParameter, RBuf &)

TInt GetConnectionParameter(const TServiceSelection &aServiceSelection,
TCchConnectionParameteraParameter,
RBuf &aValue
)const [pure virtual]
Returns the connection parameters
Since
S60 3.2.3

Parameters

const TServiceSelection & aServiceSelectionSelected service, ID and type
TCchConnectionParameter aParameterConnection parameter of the service
RBuf & aValueValue of the parameter

GetServiceInfoL(const TServiceSelection &, RBuf &)

voidGetServiceInfoL(const TServiceSelection &aServiceSelection,
RBuf &aBuffer
)const [pure virtual]
Get service specifics information about service and protocol
Since
S60 3.2

Parameters

const TServiceSelection & aServiceSelectionSelected service, ID and type
RBuf & aBuffer

GetServiceNetworkInfo(TServiceConnectionInfo &)

TInt GetServiceNetworkInfo(TServiceConnectionInfo &aConnectionInfo)const [pure virtual]
Get service network information.
Since
S60 3.2

Parameters

TServiceConnectionInfo & aConnectionInfoSelected service, ID and type, used SNAP id (should be set as null if not in use), used IAP id (should be set as null if not in use), SNAP locked indicator

GetServiceState(const TServiceSelection &, TCCHSubserviceState &)

TInt GetServiceState(const TServiceSelection &aServiceSelection,
TCCHSubserviceState &aState
)const [pure virtual]
Get service state information.
Since
S60 3.2

Parameters

const TServiceSelection & aServiceSelectionSelected service, ID and type
TCCHSubserviceState & aStateCurrent service state.

IsAvailableL(const TServiceSelection &, const RArray< TUint32 > &)

TBool IsAvailableL(const TServiceSelection &aServiceSelection,
const RArray< TUint32 > &aIapIdArray
)const [pure virtual]
Client checks is the service available by the IAP id array. CCHService implementation should return ETrue if service is registrable by the (some) IAP, array contains.
Since
S60 3.2

Parameters

const TServiceSelection & aServiceSelectionSelected service, ID and type
const RArray< TUint32 > & aIapIdArrayId array of the currently available iaps.

IsReserved(const TServiceSelection &)

TBool IsReserved(const TServiceSelection &aServiceSelection)const [pure virtual]
Is the service reserved
Since
S60 3.2

Parameters

const TServiceSelection & aServiceSelectionSelected service, ID and type

NewL(TUid, MCchServiceObserver &)

CCchService *NewL(TUidaImplementationUid,
MCchServiceObserver &aCCHObserver
)[static, inline]

Parameters

TUid aImplementationUid
MCchServiceObserver & aCCHObserver

ReserveService(const TServiceSelection &)

TInt ReserveService(const TServiceSelection &aServiceSelection)[pure virtual]
Reserves the service for exclusive use
Since
S60 3.2

Parameters

const TServiceSelection & aServiceSelectionSelected service, ID and type

SetConnectionParameter(const TServiceSelection &, TCchConnectionParameter, TInt)

TInt SetConnectionParameter(const TServiceSelection &aServiceSelection,
TCchConnectionParameteraParameter,
TIntaValue
)[pure virtual]
Sets the connection parameters
Since
S60 3.2.3

Parameters

const TServiceSelection & aServiceSelectionSelected service, ID and type
TCchConnectionParameter aParameterConnection parameter of the service
TInt aValueValue of the parameter

SetConnectionParameter(const TServiceSelection &, TCchConnectionParameter, const TDesC &)

TInt SetConnectionParameter(const TServiceSelection &aServiceSelection,
TCchConnectionParameteraParameter,
const TDesC &aValue
)[pure virtual]
Sets the connection parameters
Since
S60 3.2.3

Parameters

const TServiceSelection & aServiceSelectionSelected service, ID and type
TCchConnectionParameter aParameterConnection parameter of the service
const TDesC & aValueValue of the parameter

SetIapId(const TServiceSelection &, TUint)

TInt SetIapId(const TServiceSelection &aServiceSelection,
TUintaIapId
)[pure virtual]
Set IAP id for service.
Since
S60 3.2

Parameters

const TServiceSelection & aServiceSelectionSelected service, ID and type
TUint aIapId

SetSnapId(const TServiceSelection &, TUint)

TInt SetSnapId(const TServiceSelection &aServiceSelection,
TUintaSnapId
)[pure virtual]
Set SNAP id for service.
Since
S60 3.2

Parameters

const TServiceSelection & aServiceSelectionSelected service, ID and type
TUint aSnapId

Member Data Documentation

TUid iInstanceKey

TUid iInstanceKey

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.