Class CSubConParameterFamily

class CSubConParameterFamily : public CBase;

Description

Container of RSubConnection parameter sets.

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

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CSubConParameterFamily - Container of RSubConnection parameter sets

Members

Defined in CSubConParameterFamily:
AddExtensionSetL(), ClearAllParameters(), EAcceptable, EGranted, ENumValues, ERequested, FindExtensionSet(), FindExtensionSet(), GetGenericSet(), Id(), Length(), Load(), LoadL(), LoadL(), NewL(), NewL(), SetGenericSetL(), Store(), TParameterSetType, ~CSubConParameterFamily()

Inherited from CBase:
Delete(), Extension_(), operator new()

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

Description

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

RSubConParameterBundle &aBundle Family container (bundle) that this family is to be added to TUint32 aFamilyId identifier for the specific family type, currently only 2, QoS (KSubConQoSFamily) and Authorisation (KSubConAuthorisationFamily), are defined.

Return value

CSubConParameterFamily * a pointer to a sub-connection parameter family if successful, otherwise leaves with system error code.

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

Description

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

CSubConParameterBundle &aBundle Family container (bundle) that this family is to be added to TUint32 aFamilyId

Return value

CSubConParameterFamily * a pointer to a sub-connection parameter family if successful, otherwise leaves with system error code.

virtual IMPORT_C ~CSubConParameterFamily();

Description

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

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

Description

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

Parameters

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

Return value

CSubConParameterFamily * a pointer to a sub-connection parameter family if successful, otherwise leaves with system error code.

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

Description

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

Parameters

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

Return value

CSubConParameterFamily * a pointer to a sub-connection parameter family if successful, otherwise leaves with system error code.

IMPORT_C void SetGenericSetL(CSubConGenericParameterSet &aGenericSet, TParameterSetType aType);

Description

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

Parameters

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

Leave codes

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

IMPORT_C void AddExtensionSetL(CSubConExtensionParameterSet &aExtensionSet, TParameterSetType aType);

Description

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

Parameters

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

Leave codes

leaves with KErrNoMemory in out of memeory conditions.

IMPORT_C CSubConExtensionParameterSet *FindExtensionSet(TUid aSetId, TParameterSetType aType);

Description

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

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

Return value

CSubConExtensionParameterSet * Pointer to the extension set if found, otherwise a NULL pointer.

IMPORT_C CSubConExtensionParameterSet *FindExtensionSet(STypeId aSetId, TParameterSetType aType);

Description

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

Parameters

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

Return value

CSubConExtensionParameterSet * Pointer to the extension set if found, otherwise a NULL pointer.

IMPORT_C CSubConGenericParameterSet *GetGenericSet(TParameterSetType aType);

Description

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

Parameters

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

Return value

CSubConGenericParameterSet * Pointer to the generic set if set, otherwise a NULL pointer.

inline TUint32 Id();

Description

Fetch the identity of the sub-connection parameter family

Return value

TUint32

IMPORT_C TUint Length() const;

Description

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

Return value

TUint Length of buffer required.

IMPORT_C TInt Load(TPtrC8 &aDes);

Description

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

Parameters

TPtrC8 &aDes Buffer containing the serialised family object

Return value

TInt KErrNone if successful, otherwise system wide error

IMPORT_C TInt Store(TDes8 &aDes) const;

Description

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

Parameters

TDes8 &aDes Buffer to append the serialised object to

Return value

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

IMPORT_C void ClearAllParameters(TParameterSetType aType);

Description

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

Parameters

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

TParameterSetType

Description

ERequested EAcceptable EGranted ENumValues