Container of RSubConnection parameter sets. More...

#include <es_sock.h>

Inheritance diagram for CSubConParameterFamily:

Public Types
enum	TParameterSetType { ERequested = 0 , EAcceptable = 1 , EGranted = 2 , ENumValues = 3 }

Public Member Functions
virtual IMPORT_C	~CSubConParameterFamily ()
	Sub-connection parameter family destructor.

IMPORT_C void	SetGenericSetL (CSubConGenericParameterSet &aGenericSet, TParameterSetType aType)
	Assigns the generic parameter set of a sub-connection parameter set family.

IMPORT_C void	AddExtensionSetL (CSubConExtensionParameterSet &aExtensionSet, TParameterSetType aType)
	Adds an extension parameter set to a sub-connection parameter set family.

IMPORT_C CSubConExtensionParameterSet *	FindExtensionSet (TUid aSetId, TParameterSetType aType)
	Searches a sub-connection parameter family for an extension parameter set.

IMPORT_C CSubConExtensionParameterSet *	FindExtensionSet (STypeId aSetId, TParameterSetType aType)
	Searches a sub-connection parameter family for an extension parameter set.

IMPORT_C CSubConGenericParameterSet *	GetGenericSet (TParameterSetType aType)
	Accessor for the sub-connection generic parameter set of a family.

TUint32	Id ()
	Fetch the identity of the sub-connection parameter family.

IMPORT_C TUint	Length () const
	Calculates the length of buffer required to serialise this parameter set family.

IMPORT_C TInt	Load (TPtrC8 &aDes)
	Instructs this sub-connection family to set its members based on the serialiesd data in the buffer passed.

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.

IMPORT_C void	ClearAllParameters (TParameterSetType aType)
	Clears (removes and deletes) all parameter sets with the type specified.

void	CopyToFamilyL (RParameterFamily &aDest) const
	Copy the parameters of this CSubConParameterFamily to a RParameterFamily.

void	CopyFromFamilyL (RParameterFamily &aSrc)
	Copy the parameters of this CSubConParameterFamily from a RParameterFamily.

Public Member Functions inherited from CBase
	CBase ()
	Default constructor.

virtual IMPORT_C	~CBase ()
	Virtual destructor.

TAny *	operator new (TUint aSize, TAny *aBase) __NO_THROW
	Initialises the object to binary zeroes.

TAny *	operator new (TUint aSize) __NO_THROW
	Allocates the object from the heap and then initialises its contents to binary zeroes.

TAny *	operator new (TUint aSize, TLeave)
	Allocates the object from the heap and then initialises its contents to binary zeroes.

TAny *	operator new (TUint aSize, TUint aExtraSize) __NO_THROW
	Allocates the object from the heap and then initialises its contents to binary zeroes.

TAny *	operator new (TUint aSize, TLeave, TUint aExtraSize)
	Allocates the object from the heap and then initialises its contents to binary zeroes.

Static Public Member Functions
static IMPORT_C CSubConParameterFamily *	NewL (RSubConParameterBundle &aBundle, TUint32 aFamilyId)
	Creates a new sub-connection parameter set family.

static IMPORT_C CSubConParameterFamily *	LoadL (RSubConParameterBundle &aBundle, TPtrC8 &aBuffer)
	Creates a new sub-connection parameter set family from a buffer containing the serialised object.

static IMPORT_C CSubConParameterFamily *	NewL (CSubConParameterBundle &aBundle, TUint32 aFamilyId)
	Creates a new sub-connection parameter set family.

static IMPORT_C CSubConParameterFamily *	LoadL (CSubConParameterBundle &aBundle, TPtrC8 &aBuffer)
	Creates a new sub-connection parameter set family from a buffer containing the serialised object.

Static Public Member Functions inherited from CBase
static IMPORT_C void	Delete (CBase *aPtr)
	Deletes the specified object.

Protected Member Functions
IMPORT_C	CSubConParameterFamily (TUint32 aFamilyId)
	Empty sub-connection parameter family constructor.

IMPORT_C void	ConstructL (RSubConParameterBundle &aBundle)
	Set up the sub-connection family with empty sets.

IMPORT_C void	ConstructL (CSubConParameterBundle &aBundle)
	Set up the sub-connection family with empty sets.

Protected Member Functions inherited from CBase
virtual IMPORT_C TInt	Extension_ (TUint aExtensionId, TAny &a0, TAny a1)
	Extension function.

Static Protected Member Functions
static IMPORT_C TInt32	ExtractFamilyAndCreateBufferL (TPtrC8 &aBuffer, TPtrC8 &aContainerBuffer)
	Used internally to extract the family id for the descriptor storing the serialised version of this object (and others).

Protected Attributes
RMetaDataEComContainer	iExtensionSets [ENumValues]

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

Deprecated:: since v9.6

API status: Published to all clients.

Definition at line 1377 of file es_sock.h.

Member Enumeration Documentation

◆ TParameterSetType

enum CSubConParameterFamily::TParameterSetType

Enumerator
ERequested
EAcceptable
EGranted
ENumValues

Definition at line 1399 of file es_sock.h.

Constructor & Destructor Documentation

◆ ~CSubConParameterFamily()

IMPORT_C CSubConParameterFamily::~CSubConParameterFamily ( )

virtual

Sub-connection parameter family destructor.

It cleans up the arrays deleting all the paarmeter sets it ownes

(generated from Symbian Developer Library)

◆ CSubConParameterFamily()

IMPORT_C CSubConParameterFamily::CSubConParameterFamily ( TUint32 aFamilyId )

explicitprotected

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.

(generated from Symbian Developer Library)

Member Function Documentation

◆ AddExtensionSetL()

IMPORT_C void CSubConParameterFamily::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.

Parameters

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

Exceptions: leaves with KErrNoMemory in out of memeory conditions.

(generated from Symbian Developer Library)

◆ ClearAllParameters()

IMPORT_C void CSubConParameterFamily::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)

(generated from Symbian Developer Library)

◆ ConstructL() [1/2]

IMPORT_C void CSubConParameterFamily::ConstructL ( CSubConParameterBundle & 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).

Parameters

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

Exceptions: leaves with KErrNoMemory in out of memory conditions

(generated from Symbian Developer Library)

◆ ConstructL() [2/2]

IMPORT_C void CSubConParameterFamily::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).

Parameters

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

Exceptions: leaves with KErrNoMemory in out of memory conditions

(generated from Symbian Developer Library)

◆ CopyFromFamilyL()

void CSubConParameterFamily::CopyFromFamilyL ( RParameterFamily & aSrc )

Copy the parameters of this CSubConParameterFamily from a RParameterFamily.

Parameters

aSrc	RParameterFamily object to copy from

◆ CopyToFamilyL()

void CSubConParameterFamily::CopyToFamilyL ( RParameterFamily & aDest ) const

Copy the parameters of this CSubConParameterFamily to a RParameterFamily.

Parameters

aDest RParameterFamily object to copy to

◆ ExtractFamilyAndCreateBufferL()

static IMPORT_C TInt32 CSubConParameterFamily::ExtractFamilyAndCreateBufferL	(	TPtrC8 &	aBuffer,
		TPtrC8 &	aContainerBuffer
	)

staticprotected

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.

(generated from Symbian Developer Library)

◆ FindExtensionSet() [1/2]

IMPORT_C CSubConExtensionParameterSet * CSubConParameterFamily::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)

(generated from Symbian Developer Library)

◆ FindExtensionSet() [2/2]

IMPORT_C CSubConExtensionParameterSet * CSubConParameterFamily::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)

(generated from Symbian Developer Library)

◆ GetGenericSet()

IMPORT_C CSubConGenericParameterSet * CSubConParameterFamily::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)

(generated from Symbian Developer Library)

◆ Id()

TUint32 CSubConParameterFamily::Id ( )

inline

Fetch the identity of the sub-connection parameter family.

(generated from Symbian Developer Library)

◆ Length()

IMPORT_C TUint CSubConParameterFamily::Length ( ) const

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

(generated from Symbian Developer Library)

◆ Load()

IMPORT_C TInt CSubConParameterFamily::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

(generated from Symbian Developer Library)

◆ LoadL() [1/2]

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

static

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

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

Parameters

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

(generated from Symbian Developer Library)

◆ LoadL() [2/2]

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

static

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

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

Parameters

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

(generated from Symbian Developer Library)

◆ NewL() [1/2]

static IMPORT_C CSubConParameterFamily * CSubConParameterFamily::NewL	(	CSubConParameterBundle &	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.

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

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.

(generated from Symbian Developer Library)

◆ NewL() [2/2]

static IMPORT_C CSubConParameterFamily * 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.

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

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.

(generated from Symbian Developer Library)

◆ SetGenericSetL()

IMPORT_C void CSubConParameterFamily::SetGenericSetL	(	CSubConGenericParameterSet &	aGenericSet,
		TParameterSetType	aType
	)

Assigns the generic parameter set of 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.

Parameters

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

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

(generated from Symbian Developer Library)

◆ Store()

IMPORT_C TInt CSubConParameterFamily::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

(generated from Symbian Developer Library)

Member Data Documentation

◆ iExtensionSets

RMetaDataEComContainer CSubConParameterFamily::iExtensionSets[ENumValues]

protected

Definition at line 1451 of file es_sock.h.

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ TParameterSetType

Constructor & Destructor Documentation

◆ ~CSubConParameterFamily()

◆ CSubConParameterFamily()

Member Function Documentation

◆ AddExtensionSetL()

◆ ClearAllParameters()

◆ ConstructL() [1/2]

◆ ConstructL() [2/2]

◆ CopyFromFamilyL()

◆ CopyToFamilyL()

◆ ExtractFamilyAndCreateBufferL()

◆ FindExtensionSet() [1/2]

◆ FindExtensionSet() [2/2]

◆ GetGenericSet()

◆ Id()

◆ Length()

◆ Load()

◆ LoadL() [1/2]

◆ LoadL() [2/2]

◆ NewL() [1/2]

◆ NewL() [2/2]

◆ SetGenericSetL()

◆ Store()

Member Data Documentation

◆ iExtensionSets