epoc32/include/cs_subconparams.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
     1.1 --- a/epoc32/include/cs_subconparams.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/cs_subconparams.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,168 @@
     1.4 -cs_subconparams.h
     1.5 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +// All rights reserved.
     1.7 +// This component and the accompanying materials are made available
     1.8 +// 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.9 +// which accompanies this distribution, and is available
    1.10 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +//
    1.12 +// Initial Contributors:
    1.13 +// Nokia Corporation - initial contribution.
    1.14 +//
    1.15 +// Contributors:
    1.16 +//
    1.17 +// Description:
    1.18 +// Header file for the Automated Test Tool
    1.19 +// 
    1.20 +//
    1.21 +
    1.22 +
    1.23 +
    1.24 +/**
    1.25 + @file 
    1.26 + @publishedAll
    1.27 + @released
    1.28 +*/
    1.29 +
    1.30 +#ifndef __CS_SUBCONPARAMS_H__
    1.31 +#define __CS_SUBCONPARAMS_H__
    1.32 +
    1.33 +#include <e32base.h>
    1.34 +#include <e32std.h>
    1.35 +#include <comms-infras/metadata.h>
    1.36 +#include <comms-infras/metatype.h>
    1.37 +
    1.38 +#include <es_sock.h>
    1.39 +
    1.40 +const TInt32 KSubConnQosGenericParamsType = 1;
    1.41 +const TInt32 KSubConnAuthorisationGenericParamsType = 2;
    1.42 +using Meta::SMetaDataECom;
    1.43 +
    1.44 +class CSubConQosGenericParamSet : public CSubConGenericParameterSet
    1.45 +/** Qos generic parameter set.
    1.46 +
    1.47 +This class contains a collection of generic QoS family parameters i.e, independent of any technology
    1.48 +and provides the interface to access them.
    1.49 +
    1.50 +The following operations are also provided:
    1.51 +
    1.52 +GetDownlinkBandwidth()/SetDownlinkBandwidth() - Accessor function for downlink bandwidth value.
    1.53 +GetUplinkBandwidth()/SetUplinkBandwidth() - Accessor function for uplink bandwidth value.
    1.54 +GetDownLinkMaximumBurstSize()/SetDownLinkMaximumBurstSize() - Accessor function for maximum size of downlink burst of data the client can handle.
    1.55 +GetUpLinkMaximumBurstSize()/SetUpLinkMaximumBurstSize() - Accessor function for maximum size of uplink burst of data the client can handle.
    1.56 +GetDownLinkAveragePacketSize()/SetDownLinkAveragePacketSize() - Accessor function for downlink average packet size data.
    1.57 +GetUpLinkAveragePacketSize()/SetUpLinkAveragePacketSize() - Accessor function for uplink average packet size data.
    1.58 +GetDownLinkMaximumPacketSize()/SetDownLinkMaximumPacketSize() - Accessor function for downlink maximum packet size data.
    1.59 +GetUpLinkMaximumPacketSize()/SetUpLinkMaximumPacketSize() - Accessor function for uplink maximum packet size data.
    1.60 +GetDownLinkDelay()/SetDownLinkDelay() - Accessor function for acceptable downlink delay/latency value.
    1.61 +GetUpLinkDelay()/SetUpLinkDelay() - Accessor function for acceptable uplink delay/latency value.
    1.62 +GetDownLinkDelayVariation()/SetDownLinkDelayVariation() - Accessor function for acceptable downlink variation in delay.
    1.63 +GetUpLinkDelayVariation()/SetUpLinkDelayVariation() - Accessor function for acceptable uplink variation in delay.
    1.64 +GetDownLinkPriority()/SetDownLinkPriority() - Accessor function for downlink priority
    1.65 +GetUpLinkPriority()/SetUpLinkPriority() - Accessor function for uplink priority
    1.66 +GetHeaderMode()/SetHeaderMode() - Accessor function for header mode (Specify whether the header size should be calculated by the QoS module or specified by the client)
    1.67 +GetName()/SetName() - Accessor function for QoS Parameters name.
    1.68 +
    1.69 +@note SMetaDataECom must be the first in the superclasses' list
    1.70 +@publishedAll
    1.71 +@released since v9.1 */
    1.72 +{
    1.73 +public:
    1.74 +	inline static CSubConQosGenericParamSet* NewL(CSubConParameterFamily& aFamily, CSubConParameterFamily::TParameterSetType aType);
    1.75 +	inline static CSubConQosGenericParamSet* NewL();
    1.76 +
    1.77 +	inline CSubConQosGenericParamSet();
    1.78 +
    1.79 +	inline TInt GetDownlinkBandwidth() const;
    1.80 +	inline TInt GetUplinkBandwidth() const;
    1.81 +	inline TInt GetDownLinkMaximumBurstSize() const;
    1.82 +	inline TInt GetUpLinkMaximumBurstSize() const;
    1.83 +	inline TInt GetDownLinkAveragePacketSize() const;
    1.84 +	inline TInt GetUpLinkAveragePacketSize() const;
    1.85 +	inline TInt GetDownLinkMaximumPacketSize() const;
    1.86 +	inline TInt GetUpLinkMaximumPacketSize() const;
    1.87 +	inline TInt GetDownLinkDelay() const;
    1.88 +	inline TInt GetUpLinkDelay() const;
    1.89 +	inline TInt GetDownLinkDelayVariation() const;
    1.90 +	inline TInt GetUpLinkDelayVariation() const;
    1.91 +	inline TInt GetDownLinkPriority() const;
    1.92 +	inline TInt GetUpLinkPriority() const;
    1.93 +	inline TBool GetHeaderMode() const;
    1.94 +	inline const TName& GetName() const;
    1.95 +
    1.96 +	inline void SetDownlinkBandwidth(TInt);
    1.97 +	inline void SetUplinkBandwidth(TInt);
    1.98 +	inline void SetDownLinkMaximumBurstSize(TInt);
    1.99 +	inline void SetUpLinkMaximumBurstSize(TInt);
   1.100 +	inline void SetDownLinkAveragePacketSize(TInt);
   1.101 +	inline void SetUpLinkAveragePacketSize(TInt);
   1.102 +	inline void SetDownLinkMaximumPacketSize(TInt);
   1.103 +	inline void SetUpLinkMaximumPacketSize(TInt);
   1.104 +	inline void SetDownLinkDelay(TInt);
   1.105 +	inline void SetUpLinkDelay(TInt);
   1.106 +	inline void SetDownLinkDelayVariation(TInt);
   1.107 +	inline void SetUpLinkDelayVariation(TInt);
   1.108 +	inline void SetDownLinkPriority(TInt);
   1.109 +	inline void SetUpLinkPriority(TInt);
   1.110 +	inline void SetHeaderMode(TBool);
   1.111 +	inline void SetName(const TName&);
   1.112 +
   1.113 +protected:
   1.114 +
   1.115 +	DATA_VTABLE
   1.116 +
   1.117 +	TInt iDownlinkBandwidth;
   1.118 +	TInt iUplinkBandwidth;
   1.119 +	TInt iDownLinkMaximumBurstSize;
   1.120 +	TInt iUpLinkMaximumBurstSize;
   1.121 +	TInt iDownLinkAveragePacketSize;
   1.122 +	TInt iUpLinkAveragePacketSize;
   1.123 +	TInt iDownLinkMaximumPacketSize;
   1.124 +	TInt iUpLinkMaximumPacketSize;
   1.125 +	TInt iDownLinkDelay;
   1.126 +	TInt iUpLinkDelay;
   1.127 +	TInt iDownLinkDelayVariation;
   1.128 +	TInt iUpLinkDelayVariation;
   1.129 +	TInt iDownLinkPriority;
   1.130 +	TInt iUpLinkPriority;
   1.131 +	TBool iHeaderMode;
   1.132 +	TName iName;
   1.133 +	};
   1.134 +
   1.135 +class CSubConAuthorisationGenericParamSet : public CSubConGenericParameterSet
   1.136 +/** Authorisation generic parameter set.
   1.137 +
   1.138 +This class contains authorization generic parameters.
   1.139 +
   1.140 +@note SMetaDataECom must be the first in the superclasses' list
   1.141 +@publishedAll
   1.142 +@released since v9.1 */
   1.143 +{
   1.144 +public:
   1.145 +	inline static CSubConAuthorisationGenericParamSet* NewL(CSubConParameterFamily& aFamily, CSubConParameterFamily::TParameterSetType aType);
   1.146 +	inline static CSubConAuthorisationGenericParamSet* NewL();
   1.147 +
   1.148 +	inline CSubConAuthorisationGenericParamSet();
   1.149 +
   1.150 +	inline TInt GetId() const;
   1.151 +
   1.152 +	inline void SetId(TInt);
   1.153 +
   1.154 +protected:
   1.155 +
   1.156 +	DATA_VTABLE
   1.157 +
   1.158 +	TInt iId;
   1.159 +	};
   1.160 +
   1.161 +class CSubConGenericParamsFactory : public CBase
   1.162 +/** Sub connection generic parameter set factory.
   1.163 +
   1.164 +@internalComponent
   1.165 +@released since v9.1 */
   1.166 +	{
   1.167 +public:
   1.168 +	static CSubConGenericParameterSet* NewL(TAny* aConstructionParameters);
   1.169 +	};
   1.170 +
   1.171 +#include <cs_subconparams.inl>
   1.172 +#endif	// __CS_SUBCONPARAMS_H__