CSubConParameterFamily Class Reference

#include <es_sock.h>

Link against: esock.lib

class CSubConParameterFamily : public CBase

Inherits from

CSubConParameterFamily
- CBase

Protected Attributes
RMetaDataEComContainer	iExtensionSets

Public Member Enumerations
enum	TParameterSetType { ERequested, EAcceptable, EGranted, ENumValues }

Public Member Functions
virtual	~CSubConParameterFamily()
IMPORT_C void	AddExtensionSetL(CSubConExtensionParameterSet &, TParameterSetType)
IMPORT_C void	ClearAllParameters(TParameterSetType)
void	CopyFromFamilyL(RParameterFamily &)
void	CopyToFamilyL(RParameterFamily &)
IMPORT_C CSubConExtensionParameterSet *	FindExtensionSet(TUid, TParameterSetType)
IMPORT_C CSubConExtensionParameterSet *	FindExtensionSet(STypeId, TParameterSetType)
IMPORT_C CSubConGenericParameterSet *	GetGenericSet(TParameterSetType)
TUint32	Id()
IMPORT_C TUint	Length()
IMPORT_C TInt	Load(TPtrC8 &)
IMPORT_C CSubConParameterFamily *	LoadL(RSubConParameterBundle &, TPtrC8 &)
IMPORT_C CSubConParameterFamily *	LoadL(CSubConParameterBundle &, TPtrC8 &)
IMPORT_C CSubConParameterFamily *	NewL(RSubConParameterBundle &, TUint32)
IMPORT_C CSubConParameterFamily *	NewL(CSubConParameterBundle &, TUint32)
IMPORT_C void	SetGenericSetL(CSubConGenericParameterSet &, TParameterSetType)
IMPORT_C TInt	Store(TDes8 &)

Protected Member Functions
	CSubConParameterFamily(TUint32)
IMPORT_C void	ConstructL(RSubConParameterBundle &)
IMPORT_C void	ConstructL(CSubConParameterBundle &)
IMPORT_C TInt32	ExtractFamilyAndCreateBufferL(TPtrC8 &, TPtrC8 &)

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()

Detailed Description

Container of RSubConnection parameter sets.

For each Parameter Type (Requested, Acceptable and Granted) it contains one generic and 0..N extended parameter sets.

Note: a CSubConParameterBundle or RSubConParameterBundle object can take ownership of a CSubConParameterFamily object, in this case, when the bundle is destroyed, this family object will also be destroyed (along with any parameter sets that are owned by the family).

THIS API IS DEPRECATED IN FAVOUR OF RParameterFamily

Deprecatedsince v9.6

Member Attribute Documentation

iExtensionSets

RMetaDataEComContainer

iExtensionSets

[protected]

Member Enumeration Documentation

Enum TParameterSetType

Enumerator	Value	Description
ERequested	0
EAcceptable	1
EGranted	2
ENumValues	3

Constructor & Destructor Documentation

CSubConParameterFamily ( TUint32 )

IMPORT_C

CSubConParameterFamily

(

TUint32

aFamilyId

)

[protected, explicit]

Empty sub-connection parameter family constructor

Parameters
aFamilyId	identifier for the specific family type, currently only 4, QoS (KSubConQoSFamily),Authorisation (KSubConAuthorisationFamily), CallDescrParams (KSubConnCallDescrParamsFamily) and ContextDescrParams (KSubConnContextDescrParamsFamily), are defined.

~CSubConParameterFamily ( )

IMPORT_C

~CSubConParameterFamily

(

)

[virtual]

Sub-connection parameter family destructor. It cleans up the arrays deleting all the paarmeter sets it ownes

Member Function Documentation

AddExtensionSetL ( CSubConExtensionParameterSet &, TParameterSetType )

IMPORT_C void	AddExtensionSetL	(	CSubConExtensionParameterSet &	aExtensionSet,
			TParameterSetType	aType
		)

Adds an extension parameter set to a sub-connection parameter set family.

Note: The CSubConParameterFamily object takes ownership of the parameter set that is passed into this method. When the family object is destroyed, any parameter sets owned by this object will also be destroyed.

Exceptions

leaves

with KErrNoMemory in out of memeory conditions.

Parameters
aExtensionSet	Extension Parameter Set to be added to the family (family takes ownership)
aType	The type of the set (requested, acceptable or granted)

ClearAllParameters ( TParameterSetType )

IMPORT_C void

ClearAllParameters

(

TParameterSetType

aType

)

Clears (removes and deletes) all parameter sets with the type specified

Parameters
aType	The type of the set to be deleted(requested, acceptable or granted)

ConstructL ( RSubConParameterBundle & )

IMPORT_C void

ConstructL

(

RSubConParameterBundle &

aBundle

)

[protected]

Set up the sub-connection family with empty sets

Note: The aBundle parameter that is passed into this method will take ownership of the newly created CSubConParameterFamily object. When the bundle is destroyed, this family object will also be destroyed (along with any parameter sets that are owned by the family).

Exceptions

leaves

with KErrNoMemory in out of memory conditions

Parameters
aBundle	Bundle (container) the family is to be added to

ConstructL ( CSubConParameterBundle & )

IMPORT_C void

ConstructL

(

CSubConParameterBundle &

aBundle

)

[protected]

Set up the sub-connection family with empty sets

Exceptions

leaves

with KErrNoMemory in out of memory conditions

Parameters
aBundle	Bundle (container) the family is to be added to

CopyFromFamilyL ( RParameterFamily & )

void

CopyFromFamilyL

(

RParameterFamily &

aSrc

)

Copy the parameters of this CSubConParameterFamily from a RParameterFamily.

Parameters
aSrc	RParameterFamily object to copy from

CopyToFamilyL ( RParameterFamily & )

void

CopyToFamilyL

(

RParameterFamily &

aDest

)

const

Copy the parameters of this CSubConParameterFamily to a RParameterFamily.

Parameters
aDest	RParameterFamily object to copy to

ExtractFamilyAndCreateBufferL ( TPtrC8 &, TPtrC8 & )

IMPORT_C TInt32	ExtractFamilyAndCreateBufferL	(	TPtrC8 &	aBuffer,
			TPtrC8 &	aContainerBuffer
		)	[protected, static]

Used internally to extract the family id for the descriptor storing the serialised version of this object (and others). It also sets up a new buffer that is the section of the original buffer that represents this object only.

Parameters
aBuffer	Source buffer containing mulitple serialised objects (family at the start)
aContainerBuffer	Set up by this method and represents only the serialised data of the family object.

Return Value: the family Id, otherwise leaves with system error code.

FindExtensionSet ( TUid, TParameterSetType )

IMPORT_C CSubConExtensionParameterSet *	FindExtensionSet	(	TUid	aSetId,
			TParameterSetType	aType
		)

Searches a sub-connection parameter family for an extension parameter set. DO NOT USE this form of the method. It is broken. This is only capable of finding extension sets contained within IP Subconnection Provider, and these extension sets have been deprecated.

Parameters
aSetId	Although a TUid, this is the extension class Id
aType	The type of the set from TParameterSetType (ERequested, EAcceptable or EGranted)

Return Value: Pointer to the extension set if found, otherwise a NULL pointer.

FindExtensionSet ( STypeId, TParameterSetType )

IMPORT_C CSubConExtensionParameterSet *	FindExtensionSet	(	STypeId	aSetId,
			TParameterSetType	aType
		)

Searches a sub-connection parameter family for an extension parameter set.

Parameters
aSetId	The STypeId of the extension set
aType	The type of the set from TParameterSetType (ERequested, EAcceptable or EGranted)

Return Value: Pointer to the extension set if found, otherwise a NULL pointer.

GetGenericSet ( TParameterSetType )

IMPORT_C CSubConGenericParameterSet *

GetGenericSet

(

TParameterSetType

aType

)

Accessor for the sub-connection generic parameter set of a family.

Parameters
aType	The type of the set (requested, acceptable or granted)

Return Value: Pointer to the generic set if set, otherwise a NULL pointer.

Id ( )

TUint32

(

)

[inline]

Fetch the identity of the sub-connection parameter family

Length ( )

IMPORT_C TUint

Length

(

)

const

Calculates the length of buffer required to serialise this parameter set family.

Return Value: Length of buffer required.

Load ( TPtrC8 & )

IMPORT_C TInt

Load

(

TPtrC8 &

aDes

)

Instructs this sub-connection family to set its members based on the serialiesd data in the buffer passed.

Parameters
aDes	Buffer containing the serialised family object

Return Value: KErrNone if successful, otherwise system wide error

LoadL ( RSubConParameterBundle &, TPtrC8 & )

IMPORT_C CSubConParameterFamily *	LoadL	(	RSubConParameterBundle &	aBundle,
			TPtrC8 &	aBuffer
		)	[static]

Creates a new sub-connection parameter set family from a buffer containing the serialised object.

Parameters
aBundle	Family container (bundle) that this family is to be added to
aBuffer	Buffer containing the serialised object information

Return Value: a pointer to a sub-connection parameter family if successful, otherwise leaves with system error code.

LoadL ( CSubConParameterBundle &, TPtrC8 & )

IMPORT_C CSubConParameterFamily *	LoadL	(	CSubConParameterBundle &	aBundle,
			TPtrC8 &	aBuffer
		)	[static]

Creates a new sub-connection parameter set family from a buffer containing the serialised object.

Parameters
aBundle	Family container (bundle) that this family is to be added to
aBuffer	Buffer containing the serialised object information

Return Value: a pointer to a sub-connection parameter family if successful, otherwise leaves with system error code.

NewL ( RSubConParameterBundle &, TUint32 )

IMPORT_C CSubConParameterFamily *	NewL	(	RSubConParameterBundle &	aBundle,
			TUint32	aFamilyId
		)	[static]

Creates a new sub-connection parameter set family. This class is used as a container for a number of parameter sets (generic and extension) that make up a family. It is a specific instantiatable class and therefore creates an instance of CSubConParameterFamily without using ECOM.

Parameters
aBundle	Family container (bundle) that this family is to be added to
aFamilyId	identifier for the specific family type, currently only 4, QoS (KSubConQoSFamily),Authorisation (KSubConAuthorisationFamily), CallDescrParams (KSubConnCallDescrParamsFamily) and ContextDescrParams (KSubConnContextDescrParamsFamily), are defined.

Return Value: a pointer to a sub-connection parameter family if successful, otherwise leaves with system error code.

NewL ( CSubConParameterBundle &, TUint32 )

IMPORT_C CSubConParameterFamily *	NewL	(	CSubConParameterBundle &	aBundle,
			TUint32	aFamilyId
		)	[static]

Parameters
aBundle	Family container (bundle) that this family is to be added to.
aFamilyId	identifier for the specific family type, currently only 4, QoS (KSubConQoSFamily),Authorisation (KSubConAuthorisationFamily), CallDescrParams (KSubConnCallDescrParamsFamily) and ContextDescrParams (KSubConnContextDescrParamsFamily), are defined.

Return Value: a pointer to a sub-connection parameter family if successful, otherwise leaves with system error code.

SetGenericSetL ( CSubConGenericParameterSet &, TParameterSetType )

IMPORT_C void	SetGenericSetL	(	CSubConGenericParameterSet &	aGenericSet,
			TParameterSetType	aType
		)

Assigns the generic parameter set of a sub-connection parameter set family.

Exceptions

leaves

with KAlreadyExists if a set is already assigned to the family.

Parameters
aGenericSet	Generic Parameter Set to be assigned to the family (family takes ownership)
aType	The type of the set (requested, acceptable or granted)

Store ( TDes8 & )

IMPORT_C TInt

Store

(

TDes8 &

aDes

)

const

Instructs this sub-connection family to create a serialised version of itself and append it to the buffer that has been passed.

Parameters
aDes	Buffer to append the serialised object to

Return Value: KErrNone if successful, otherwise system wide error (e.g. KErrOverflow if the descriptor is too small) If unsuccessful, there is no guarantee as to the buffer or data stored in it.