CSubConParameterFamily Class Reference

#include <es_sock.h>

Link against: esock.lib

class CSubConParameterFamily : public CBase

Inherits from

  • CSubConParameterFamily
    Protected Attributes
    RMetaDataEComContaineriExtensionSets
    Public Member Enumerations
    enumTParameterSetType { ERequested, EAcceptable, EGranted, ENumValues }
    Public Member Functions
    virtual ~CSubConParameterFamily()
    IMPORT_C voidAddExtensionSetL(CSubConExtensionParameterSet &, TParameterSetType)
    IMPORT_C voidClearAllParameters(TParameterSetType)
    voidCopyFromFamilyL(RParameterFamily &)
    voidCopyToFamilyL(RParameterFamily &)
    IMPORT_C CSubConExtensionParameterSet *FindExtensionSet(TUid, TParameterSetType)
    IMPORT_C CSubConExtensionParameterSet *FindExtensionSet(STypeId, TParameterSetType)
    IMPORT_C CSubConGenericParameterSet *GetGenericSet(TParameterSetType)
    TUint32 Id()
    IMPORT_C TUintLength()
    IMPORT_C TIntLoad(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 voidSetGenericSetL(CSubConGenericParameterSet &, TParameterSetType)
    IMPORT_C TIntStore(TDes8 &)
    Protected Member Functions
    CSubConParameterFamily(TUint32)
    IMPORT_C voidConstructL(RSubConParameterBundle &)
    IMPORT_C voidConstructL(CSubConParameterBundle &)
    IMPORT_C TInt32ExtractFamilyAndCreateBufferL(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

    RMetaDataEComContaineriExtensionSets[protected]

    Member Enumeration Documentation

    Enum TParameterSetType

    EnumeratorValueDescription
    ERequested0
    EAcceptable1
    EGranted2
    ENumValues3

    Constructor & Destructor Documentation

    CSubConParameterFamily ( TUint32 )

    IMPORT_CCSubConParameterFamily(TUint32aFamilyId)[protected, explicit]

    Empty sub-connection parameter family constructor

    ParameterDescription
    aFamilyIdidentifier 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 voidAddExtensionSetL(CSubConExtensionParameterSet &aExtensionSet,
    TParameterSetTypeaType
    )

    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.

    ParameterDescription
    aExtensionSetExtension Parameter Set to be added to the family (family takes ownership)
    aTypeThe type of the set (requested, acceptable or granted)

    ClearAllParameters ( TParameterSetType )

    IMPORT_C voidClearAllParameters(TParameterSetTypeaType)

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

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

    ConstructL ( RSubConParameterBundle & )

    IMPORT_C voidConstructL(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

    ParameterDescription
    aBundleBundle (container) the family is to be added to

    ConstructL ( CSubConParameterBundle & )

    IMPORT_C voidConstructL(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).

    Exceptions
    leaves

    with KErrNoMemory in out of memory conditions

    ParameterDescription
    aBundleBundle (container) the family is to be added to

    CopyFromFamilyL ( RParameterFamily & )

    voidCopyFromFamilyL(RParameterFamily &aSrc)

    Copy the parameters of this CSubConParameterFamily from a RParameterFamily.

    ParameterDescription
    aSrcRParameterFamily object to copy from

    CopyToFamilyL ( RParameterFamily & )

    voidCopyToFamilyL(RParameterFamily &aDest)const

    Copy the parameters of this CSubConParameterFamily to a RParameterFamily.

    ParameterDescription
    aDestRParameterFamily object to copy to

    ExtractFamilyAndCreateBufferL ( TPtrC8 &, TPtrC8 & )

    IMPORT_C TInt32ExtractFamilyAndCreateBufferL(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.

    ParameterDescription
    aBufferSource buffer containing mulitple serialised objects (family at the start)
    aContainerBufferSet up by this method and represents only the serialised data of the family object.

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

    FindExtensionSet ( TUid, TParameterSetType )

    IMPORT_C CSubConExtensionParameterSet *FindExtensionSet(TUidaSetId,
    TParameterSetTypeaType
    )

    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.

    ParameterDescription
    aSetIdAlthough a TUid, this is the extension class Id
    aTypeThe type of the set from TParameterSetType (ERequested, EAcceptable or EGranted)

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

    FindExtensionSet ( STypeId, TParameterSetType )

    IMPORT_C CSubConExtensionParameterSet *FindExtensionSet(STypeIdaSetId,
    TParameterSetTypeaType
    )

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

    ParameterDescription
    aSetIdThe STypeId of the extension set
    aTypeThe type of the set from TParameterSetType (ERequested, EAcceptable or EGranted)

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

    GetGenericSet ( TParameterSetType )

    IMPORT_C CSubConGenericParameterSet *GetGenericSet(TParameterSetTypeaType)

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

    ParameterDescription
    aTypeThe type of the set (requested, acceptable or granted)

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

    Id ( )

    TUint32 Id()[inline]

    Fetch the identity of the sub-connection parameter family

    Length ( )

    IMPORT_C TUintLength()const

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

    Returns: Length of buffer required.

    Load ( TPtrC8 & )

    IMPORT_C TIntLoad(TPtrC8 &aDes)

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

    ParameterDescription
    aDesBuffer containing the serialised family object

    Returns: 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.

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

    ParameterDescription
    aBundleFamily container (bundle) that this family is to be added to
    aBufferBuffer containing the serialised object information

    Returns: 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.

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

    ParameterDescription
    aBundleFamily container (bundle) that this family is to be added to
    aBufferBuffer containing the serialised object information

    Returns: 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,
    TUint32aFamilyId
    )[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).

    ParameterDescription
    aBundleFamily container (bundle) that this family is to be added to
    aFamilyIdidentifier for the specific family type, currently only 4, QoS (KSubConQoSFamily),Authorisation (KSubConAuthorisationFamily), CallDescrParams (KSubConnCallDescrParamsFamily) and ContextDescrParams (KSubConnContextDescrParamsFamily), are defined.

    Returns: 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,
    TUint32aFamilyId
    )[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).

    ParameterDescription
    aBundleFamily container (bundle) that this family is to be added to.
    aFamilyIdidentifier for the specific family type, currently only 4, QoS (KSubConQoSFamily),Authorisation (KSubConAuthorisationFamily), CallDescrParams (KSubConnCallDescrParamsFamily) and ContextDescrParams (KSubConnContextDescrParamsFamily), are defined.

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

    SetGenericSetL ( CSubConGenericParameterSet &, TParameterSetType )

    IMPORT_C voidSetGenericSetL(CSubConGenericParameterSet &aGenericSet,
    TParameterSetTypeaType
    )

    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.

    Exceptions
    leaves

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

    ParameterDescription
    aGenericSetGeneric Parameter Set to be assigned to the family (family takes ownership)
    aTypeThe type of the set (requested, acceptable or granted)

    Store ( TDes8 & )

    IMPORT_C TIntStore(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.

    ParameterDescription
    aDesBuffer to append the serialised object to

    Returns: 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.

    © Nokia 2011.