epoc32/include/cs_subconparams.inl
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
     1.1 --- a/epoc32/include/cs_subconparams.inl	Wed Mar 31 12:27:01 2010 +0100
     1.2 +++ b/epoc32/include/cs_subconparams.inl	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -1,9 +1,9 @@
     1.4  // Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5  // All rights reserved.
     1.6  // This component and the accompanying materials are made available
     1.7 -// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     1.8 +// under the terms of "Eclipse Public License v1.0"
     1.9  // which accompanies this distribution, and is available
    1.10 -// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.12  //
    1.13  // Initial Contributors:
    1.14  // Nokia Corporation - initial contribution.
    1.15 @@ -13,23 +13,27 @@
    1.16  // Description:
    1.17  //
    1.18  
    1.19 -
    1.20 -
    1.21  /**
    1.22   @file
    1.23   @publishedAll
    1.24 + @released
    1.25  */
    1.26  
    1.27  #ifndef __CS_SUBCONPARAMS_INL__
    1.28  #define __CS_SUBCONPARAMS_INL__
    1.29  
    1.30  CSubConQosGenericParamSet* CSubConQosGenericParamSet::NewL(CSubConParameterFamily& aFamily, CSubConParameterFamily::TParameterSetType aType)
    1.31 -/** Creates a generic Qos family parameters sub-connection.
    1.32 +/** Creates a generic Qos family parameterset.
    1.33  
    1.34 -@param aFamily parameter sets.
    1.35 -@param aType parameter type (Requested/Acceptable/Granted) 
    1.36 +Note:
    1.37 +The aFamily parameter that is passed into this method will take ownership of the newly 
    1.38 +created CSubConQosGenericParamSet object.  When the family is destroyed, this parameter 
    1.39 +set object will also be destroyed (along with any other parameter sets owned by the family).
    1.40 +
    1.41 +@param aFamily Parameter sets.
    1.42 +@param aType Parameter type (Requested/Acceptable/Granted)
    1.43  @return a CSubConQosGenericParamSet object pointer if successful,
    1.44 - otherwise leaves with system error code.
    1.45 + otherwise leaves with a system error code.
    1.46  */
    1.47  	{
    1.48  	CSubConQosGenericParamSet* obj = NewL();
    1.49 @@ -39,14 +43,35 @@
    1.50  	return obj;
    1.51  	}
    1.52  
    1.53 +CSubConQosGenericParamSet* CSubConQosGenericParamSet::NewL(RParameterFamily& aFamily, RParameterFamily::TParameterSetType aType)
    1.54 +/** Creates a generic Qos family parameterset.
    1.55 +
    1.56 +Note:
    1.57 +The aFamily parameter that is passed into this method will take ownership of the newly 
    1.58 +created CSubConQosGenericParamSet object.  When the family is destroyed, this parameter 
    1.59 +set object will also be destroyed (along with any other parameter sets owned by the family).
    1.60 +
    1.61 +@param aFamily Parameter sets.
    1.62 +@param aType Parameter type (Requested/Acceptable/Granted)
    1.63 +@return a CSubConQosGenericParamSet object pointer if successful,
    1.64 + otherwise leaves with a system error code.
    1.65 +*/
    1.66 +	{
    1.67 +	CSubConQosGenericParamSet* obj = NewL();
    1.68 +	CleanupStack::PushL(obj);
    1.69 +	aFamily.AddParameterSetL(obj, aType);
    1.70 +	CleanupStack::Pop(obj);
    1.71 +	return obj;
    1.72 +	}
    1.73 +
    1.74  CSubConQosGenericParamSet* CSubConQosGenericParamSet::NewL()
    1.75 -/** Creates a generic Qos family parameters sub-connection.
    1.76 +/** Creates a generic Qos family parameterset.
    1.77  
    1.78  @return a CSubConQosGenericParamSet object pointer if successful,
    1.79 - otherwise leaves with system error code.
    1.80 + otherwise leaves with a system error code.
    1.81  */
    1.82  	{
    1.83 -	STypeId typeId(KSubConnGenericParamsImplUid, KSubConnQosGenericParamsType);
    1.84 +	STypeId typeId = STypeId::CreateSTypeId(CSubConQosGenericParamSet::EUid, CSubConQosGenericParamSet::EType);
    1.85  	return static_cast<CSubConQosGenericParamSet*>(CSubConParameterSet::NewL(typeId));
    1.86  	}
    1.87  
    1.88 @@ -187,7 +212,7 @@
    1.89  TBool CSubConQosGenericParamSet::GetHeaderMode() const
    1.90  /** Gets header mode.
    1.91  
    1.92 -@return boolean value indicating whether the header size 
    1.93 +@return boolean value indicating whether the header size
    1.94  should be calculated by the QoS module or specified by the client. */
    1.95  	{
    1.96  	return iHeaderMode;
    1.97 @@ -316,7 +341,7 @@
    1.98  void CSubConQosGenericParamSet::SetHeaderMode(TBool aHeaderMode)
    1.99  /** Sets header mode.
   1.100  
   1.101 -@param aHeaderMode boolean value indicating whether the header size 
   1.102 +@param aHeaderMode boolean value indicating whether the header size
   1.103  should be calculated by the QoS module or specified by the client. */
   1.104  	{
   1.105  	iHeaderMode = aHeaderMode;
   1.106 @@ -332,12 +357,18 @@
   1.107  
   1.108  //=============
   1.109  CSubConAuthorisationGenericParamSet* CSubConAuthorisationGenericParamSet::NewL(CSubConParameterFamily& aFamily, CSubConParameterFamily::TParameterSetType aType)
   1.110 -/** Creates a generic Authorisation family parameters sub-connection.
   1.111 +/** Creates a generic Authorisation family parameterset.
   1.112 +
   1.113 +Note:
   1.114 +The aFamily parameter that is passed into this method will take ownership of the newly 
   1.115 +created CSubConAuthorisationGenericParamSet object.  When the family is destroyed, this 
   1.116 +parameter set object will also be destroyed (along with any other parameter sets owned 
   1.117 +by the family).
   1.118  
   1.119  @param aFamily parameter sets.
   1.120 -@param aType parameter type (Requested/Acceptable/Granted) 
   1.121 +@param aType parameter type (Requested/Acceptable/Granted)
   1.122  @return a CSubConAuthorisationGenericParamSet object pointer if successful,
   1.123 - otherwise leaves with system error code.
   1.124 + otherwise leaves with a system error code.
   1.125  */
   1.126  	{
   1.127  	CSubConAuthorisationGenericParamSet* obj = NewL();
   1.128 @@ -347,19 +378,41 @@
   1.129  	return obj;
   1.130  	}
   1.131  
   1.132 +CSubConAuthorisationGenericParamSet* CSubConAuthorisationGenericParamSet::NewL(RParameterFamily& aFamily, RParameterFamily::TParameterSetType aType)
   1.133 +/** Creates a generic Authorisation family parameterset.
   1.134 +
   1.135 +Note:
   1.136 +The aFamily parameter that is passed into this method will take ownership of the newly 
   1.137 +created CSubConAuthorisationGenericParamSet object.  When the family is destroyed, this 
   1.138 +parameter set object will also be destroyed (along with any other parameter sets owned 
   1.139 +by the family).
   1.140 +
   1.141 +@param aFamily parameter sets.
   1.142 +@param aType parameter type (Requested/Acceptable/Granted)
   1.143 +@return a CSubConAuthorisationGenericParamSet object pointer if successful,
   1.144 + otherwise leaves with a system error code.
   1.145 +*/
   1.146 +	{
   1.147 +	CSubConAuthorisationGenericParamSet* obj = NewL();
   1.148 +	CleanupStack::PushL(obj);
   1.149 +	aFamily.AddParameterSetL(obj, aType);
   1.150 +	CleanupStack::Pop(obj);
   1.151 +	return obj;
   1.152 +	}
   1.153 +
   1.154  CSubConAuthorisationGenericParamSet* CSubConAuthorisationGenericParamSet::NewL()
   1.155 -/** Creates a generic Authorisation family parameters sub-connection.
   1.156 +/** Creates a generic Authorisation family parameterset.
   1.157  
   1.158  @return a CSubConAuthorisationGenericParamSet object pointer if successful,
   1.159 - otherwise leaves with system error code.
   1.160 + otherwise leaves with a system error code.
   1.161  */
   1.162  	{
   1.163 -	STypeId typeId(KSubConnGenericParamsImplUid, KSubConnAuthorisationGenericParamsType);
   1.164 +	STypeId typeId = STypeId::CreateSTypeId(CSubConAuthorisationGenericParamSet::EUid, CSubConAuthorisationGenericParamSet::EType);
   1.165  	return static_cast<CSubConAuthorisationGenericParamSet*>(CSubConParameterSet::NewL(typeId));
   1.166  	}
   1.167  
   1.168  CSubConAuthorisationGenericParamSet::CSubConAuthorisationGenericParamSet()
   1.169 -	: CSubConGenericParameterSet(), 
   1.170 +	: CSubConGenericParameterSet(),
   1.171  	iId(0)
   1.172  /** Empty CSubConAuthorisationGenericParamSet constructor
   1.173  */
   1.174 @@ -381,4 +434,6 @@
   1.175  	{
   1.176  	iId = aId;
   1.177  	}
   1.178 +
   1.179  #endif	// __CS_SUBCONPARAMS_INL__
   1.180 +