RSubConParameterBundle Class Reference

Container for (bundle of) SubConnection parameter families. More...

#include <es_sock.h>

Public Member Functions
IMPORT_C	RSubConParameterBundle ()
	Empty sub-connection parameter bundle constructor.
IMPORT_C void	Close ()
	Close the parameter bundle handle.
IMPORT_C TUint	Length () const
	Calculates the length of buffer required to serialise this parameter set bundle.
IMPORT_C TInt	Load (const TDesC8 &aDes)
	Instructs this sub-connection bundle to set its members based on the serialiesd data in the buffer passed.
IMPORT_C TInt	Store (TDes8 &aDes) const
	Instructs this sub-connection parameter bundle to create a serilised version of itself and append it to the buffer that has been passed.
IMPORT_C void	AddFamilyL (CSubConParameterFamily *aFamily)
	Add a sub-connection parameter family to the bundle.
IMPORT_C CSubConParameterFamily *	FindFamily (TUint32 aFamilyId)
	Search the sub-connection parameter bundle for a parameter family.
IMPORT_C void	ClearAllParameters (CSubConParameterFamily::TParameterSetType aType)
	Clears (removes and deletes) all parameter sets with the type specified (delegated to the families)
void	CopyToFamilyBundleL (RParameterFamilyBundle &aDest) const
	Copy the contents of this parameter bundle to a RParameterFamilyBundle.
void	CopyFromFamilyBundleL (RParameterFamilyBundle &aSrc)
	Copy the contents of an RParameterFamilyBundle to this RSubConParameterBundle.

Protected Member Functions
TInt	CheckBundle () const
	Check to see if the handle has a heap object.

Detailed Description

Container for (bundle of) SubConnection parameter families.

May contain and 0..N SubConnection parameter families.

Note: If the RSubConParameterBundle object takes ownership of any CSubConParameterFamily object, then when the bundle object is destroyed, any family owned by this object will also be destroyed.

THIS API IS DEPRECATED IN FAVOUR OF RParameterFamilyBundle

Deprecated:

since v9.6

API status

Published to all clients.

Definition at line 1456 of file es_sock.h.

Constructor & Destructor Documentation

RSubConParameterBundle()

IMPORT_C RSubConParameterBundle::RSubConParameterBundle

(

)

Empty sub-connection parameter bundle constructor.

(generated from Symbian Developer Library)

Member Function Documentation

AddFamilyL()

IMPORT_C void RSubConParameterBundle::AddFamilyL

(

CSubConParameterFamily *

aFamily

)

Add a sub-connection parameter family to the bundle.

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

Parameters

aFamily

Family to be added (bundle takes ownership)

Exceptions

leaves with KErrNoMemory in out of memory conditions

(generated from Symbian Developer Library)

CheckBundle()

TInt RSubConParameterBundle::CheckBundle ( ) const

protected

Check to see if the handle has a heap object.

If it hasn't, it creates one

(generated from Symbian Developer Library)

ClearAllParameters()

IMPORT_C void RSubConParameterBundle::ClearAllParameters

(

CSubConParameterFamily::TParameterSetType

aType

)

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

Parameters

aType

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

(generated from Symbian Developer Library)

Close()

IMPORT_C void RSubConParameterBundle::Close

(

)

Close the parameter bundle handle.

(generated from Symbian Developer Library)

CopyFromFamilyBundleL()

void RSubConParameterBundle::CopyFromFamilyBundleL

(

RParameterFamilyBundle &

aSrc

)

Copy the contents of an RParameterFamilyBundle to this RSubConParameterBundle.

Parameters

aSrc	RParameterFamilyBundle to copy contents from

CopyToFamilyBundleL()

void RSubConParameterBundle::CopyToFamilyBundleL

(

RParameterFamilyBundle &

aDest

)

const

Copy the contents of this parameter bundle to a RParameterFamilyBundle.

Parameters

aDest

RParameterFamilyBundle to copy parameters to

FindFamily()

IMPORT_C CSubConParameterFamily * RSubConParameterBundle::FindFamily

(

TUint32

aFamilyId

)

Search the sub-connection parameter bundle for a parameter family.

Parameters

aFamilyId

Id of the family to match against. It is an 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)

Length()

IMPORT_C TUint RSubConParameterBundle::Length

(

)

const

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

(generated from Symbian Developer Library)

Load()

IMPORT_C TInt RSubConParameterBundle::Load

(

const TDesC8 &

aDes

)

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

Parameters

aDes	Buffer containing the serialised bundle object

(generated from Symbian Developer Library)

Store()

IMPORT_C TInt RSubConParameterBundle::Store

(

TDes8 &

aDes

)

const

Instructs this sub-connection parameter bundle to create a serilised 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)

---

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

• es_sock.h
• es_sock.h.dox