epoc32/include/networking/qos3gpp_subconparams.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// 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
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
// Header file for the 3GPP SubConnection Extension Parameters
williamr@2
    15
// 
williamr@2
    16
//
williamr@2
    17
williamr@2
    18
williamr@2
    19
williamr@2
    20
/**
williamr@2
    21
 @file
williamr@2
    22
 @publishedAll
williamr@2
    23
*/
williamr@2
    24
williamr@2
    25
williamr@2
    26
#ifndef QOS3GPP_SUBCONPARAMS_H
williamr@2
    27
#define QOS3GPP_SUBCONPARAMS_H
williamr@2
    28
williamr@2
    29
#include <es_sock.h>
williamr@2
    30
#include <comms-infras/metadata.h>
williamr@2
    31
#include <comms-infras/metatype.h>
williamr@2
    32
#include <etelqos.h>
williamr@2
    33
williamr@2
    34
const TInt KSubCon3GPPExtParamsFactoryUid = 0x1020D460;
williamr@2
    35
const TInt KSubConQosR99ParamsType = 1;
williamr@2
    36
const TInt KSubConnSBLPR5ExtensionParamsType = 2;
williamr@2
    37
williamr@2
    38
williamr@2
    39
#ifdef SYMBIAN_NETWORKING_UMTSR5  
williamr@2
    40
const TInt KSubConQosR5ParamsType =3;
williamr@2
    41
const TInt KSubConImsExtParamsType = 4;
williamr@2
    42
#endif 
williamr@2
    43
// SYMBIAN_NETWORKING_UMTSR5 
williamr@2
    44
williamr@2
    45
/** Constant definitions particular to the Generic Parameters. */
williamr@2
    46
const TInt KMAuthTokenLength = 255;
williamr@2
    47
/** Typedef for the AuthToken Holder. */
williamr@2
    48
typedef TBuf8<KMAuthTokenLength> TAuthToken;
williamr@2
    49
williamr@2
    50
/** Provides Implementation of IP QoS Parameters
williamr@2
    51
williamr@2
    52
@publishedAll
williamr@2
    53
@released Since 9.3
williamr@2
    54
*/
williamr@2
    55
//SMetaDataECom must be the first in the superclasses' list
williamr@2
    56
class CSubConQosR99ParamSet : public CSubConExtensionParameterSet
williamr@2
    57
{
williamr@2
    58
public:
williamr@2
    59
	enum 
williamr@2
    60
		{
williamr@2
    61
		EUid = KSubCon3GPPExtParamsFactoryUid,
williamr@2
    62
		EId = KSubConQosR99ParamsType,
williamr@2
    63
		};
williamr@2
    64
public:
williamr@2
    65
	inline static CSubConQosR99ParamSet* NewL(CSubConParameterFamily& aFamily, CSubConParameterFamily::TParameterSetType aType);
williamr@2
    66
	inline static CSubConQosR99ParamSet* NewL();
williamr@2
    67
williamr@2
    68
	inline CSubConQosR99ParamSet();
williamr@2
    69
williamr@2
    70
	inline RPacketQoS::TTrafficClass GetTrafficClass() const;
williamr@2
    71
	inline RPacketQoS::TDeliveryOrder GetDeliveryOrder() const;
williamr@2
    72
	inline RPacketQoS::TErroneousSDUDelivery GetErroneousSDUDelivery() const;
williamr@2
    73
	inline RPacketQoS::TBitErrorRatio GetResidualBitErrorRatio() const;
williamr@2
    74
	inline RPacketQoS::TSDUErrorRatio GetSDUErrorRatio() const;
williamr@2
    75
	inline RPacketQoS::TTrafficHandlingPriority GetTrafficHandlingPriority() const;
williamr@2
    76
	inline TInt GetTransferDelay() const;
williamr@2
    77
	inline TInt GetMaxSduSize() const;
williamr@2
    78
	inline TInt GetMaxBitrateUplink() const;
williamr@2
    79
	inline TInt GetMaxBitrateDownlink() const;
williamr@2
    80
	inline TInt GetGuaBitrateUplink() const;
williamr@2
    81
	inline TInt GetGuaBitrateDownlink() const;
williamr@2
    82
	inline void SetTrafficClass(RPacketQoS::TTrafficClass aTrafficClass);
williamr@2
    83
	inline void SetDeliveryOrder(RPacketQoS::TDeliveryOrder aDeliveryOrder);
williamr@2
    84
	inline void SetErroneousSDUDelivery(RPacketQoS::TErroneousSDUDelivery aDeliveryOfErroneusSdu);
williamr@2
    85
	inline void SetResidualBitErrorRatio(RPacketQoS::TBitErrorRatio aResidualBer);
williamr@2
    86
	inline void SetSDUErrorRatio(RPacketQoS::TSDUErrorRatio aErrorRatio);
williamr@2
    87
	inline void SetTrafficHandlingPriority(RPacketQoS::TTrafficHandlingPriority aPriority);
williamr@2
    88
	inline void SetTransferDelay(TInt aTransferDelay);
williamr@2
    89
	inline void SetMaxSduSize(TInt aMaxSduSize);
williamr@2
    90
	inline void SetMaxBitrateUplink(TInt aMaxBitrateUplink);
williamr@2
    91
	inline void SetMaxBitrateDownlink(TInt aMaxBitrateDownlink);
williamr@2
    92
	inline void SetGuaBitrateUplink(TInt aGuaBitrateUplink);
williamr@2
    93
	inline void SetGuaBitrateDownlink(TInt aGuaBitrateDownlink);
williamr@2
    94
williamr@2
    95
protected:
williamr@2
    96
williamr@2
    97
	DATA_VTABLE
williamr@2
    98
williamr@2
    99
protected:
williamr@2
   100
	RPacketQoS::TTrafficClass				iTrafficClass;			// Traffic class
williamr@2
   101
	RPacketQoS::TDeliveryOrder				iDeliveryOrder;			// Delivery order
williamr@2
   102
	RPacketQoS::TErroneousSDUDelivery		iDeliveryOfErroneusSdu;	// Delivery of erroneous SDUs
williamr@2
   103
	RPacketQoS::TBitErrorRatio				iResidualBer;			// Residual BER
williamr@2
   104
	RPacketQoS::TSDUErrorRatio				iErrorRatio;			// SDU error ratio
williamr@2
   105
	RPacketQoS::TTrafficHandlingPriority	iPriority;				// Traffic handling priority
williamr@2
   106
	TInt									iTransferDelay;			// Transfer delay
williamr@2
   107
	TInt									iMaxSduSize;			// Maximum SDU size
williamr@2
   108
	TInt									iMaxBitrateUplink;		// Maximum bit rate for uplink
williamr@2
   109
	TInt									iMaxBitrateDownlink;	// Maximum bit rate for downlink
williamr@2
   110
	TInt									iGuaBitrateUplink;		// Guaranteed bit rate for uplink
williamr@2
   111
	TInt									iGuaBitrateDownlink;	// Guaranteed bit rate for downlink
williamr@2
   112
	};
williamr@2
   113
williamr@2
   114
williamr@2
   115
williamr@2
   116
williamr@2
   117
#ifdef SYMBIAN_NETWORKING_UMTSR5  
williamr@2
   118
williamr@2
   119
/** Extension QoS Parameter Set for UMTS Release 5 */
williamr@2
   120
class CSubConImsExtParamSet : public CSubConExtensionParameterSet
williamr@2
   121
	{
williamr@2
   122
public:
williamr@2
   123
	enum 
williamr@2
   124
		{
williamr@2
   125
		EUid = KSubCon3GPPExtParamsFactoryUid,
williamr@2
   126
		EId = KSubConImsExtParamsType,
williamr@2
   127
		};
williamr@2
   128
public:
williamr@2
   129
	inline static CSubConImsExtParamSet* NewL(CSubConParameterFamily& aFamily,CSubConParameterFamily::TParameterSetType aType);
williamr@2
   130
	inline static CSubConImsExtParamSet* NewL();
williamr@2
   131
	inline CSubConImsExtParamSet();
williamr@2
   132
	
williamr@2
   133
	// New IM CN Signalling Indicator   
williamr@2
   134
	inline TBool GetImsSignallingIndicator() const;
williamr@2
   135
	inline void SetImsSignallingIndicator(TBool aIMSSignallingIndicator);
williamr@2
   136
protected:
williamr@2
   137
	DATA_VTABLE
williamr@2
   138
	
williamr@2
   139
private:	
williamr@2
   140
	// IMSSignallingIndicator for raised priority of traffic 
williamr@2
   141
	TBool iImsSignallingIndicator;
williamr@2
   142
	};
williamr@2
   143
williamr@2
   144
class CSubConQosR5ParamSet : public CSubConQosR99ParamSet
williamr@2
   145
	{
williamr@2
   146
public:
williamr@2
   147
	enum 
williamr@2
   148
		{
williamr@2
   149
		EUid = KSubCon3GPPExtParamsFactoryUid,
williamr@2
   150
		EId = KSubConQosR5ParamsType,
williamr@2
   151
		};
williamr@2
   152
	
williamr@2
   153
public:
williamr@2
   154
	inline static CSubConQosR5ParamSet* NewL(CSubConParameterFamily& aFamily,CSubConParameterFamily::TParameterSetType aType);
williamr@2
   155
	inline static CSubConQosR5ParamSet* NewL();
williamr@2
   156
	inline CSubConQosR5ParamSet();
williamr@2
   157
williamr@2
   158
	inline TBool GetSignallingIndicator() const;
williamr@2
   159
	inline void SetSignallingIndicator(TBool aSignallingIndicator);
williamr@2
   160
	inline RPacketQoS::TSourceStatisticsDescriptor GetSourceStatisticsDescriptor() const;
williamr@2
   161
	inline void SetSourceStatisticsDescriptor(RPacketQoS::TSourceStatisticsDescriptor aSrcStatsDescType);
williamr@2
   162
	
williamr@2
   163
protected:
williamr@2
   164
	DATA_VTABLE
williamr@2
   165
	
williamr@2
   166
private:
williamr@2
   167
	// Source Statistics Descriptor 
williamr@2
   168
	RPacketQoS::TSourceStatisticsDescriptor iSrcStatsDesc;
williamr@2
   169
	TBool iSignallingIndicator;
williamr@2
   170
		
williamr@2
   171
	};
williamr@2
   172
williamr@2
   173
#endif 
williamr@2
   174
// SYMBIAN_NETWORKING_UMTSR5 
williamr@2
   175
williamr@2
   176
williamr@2
   177
williamr@2
   178
/** Flow Identifires
williamr@2
   179
ECOM Implementation Id for SBLP Extension parameters.
williamr@2
   180
williamr@2
   181
@publishedAll
williamr@2
   182
@released Since 9.3
williamr@2
   183
*/
williamr@2
   184
struct TFlowId
williamr@2
   185
	{
williamr@2
   186
	/** Getter Function for the Components of Flow ids. */
williamr@2
   187
	inline TUint16 GetMediaComponentNumber() const;
williamr@2
   188
	inline TUint16 GetIPFlowNumber() const;
williamr@2
   189
	/**	Setter Function For Flow Id Components.	*/
williamr@2
   190
	inline void SetMediaComponentNumber(TUint16 aMediaComponentNumber);
williamr@2
   191
	inline void SetIPFlowNumber(TUint16 aIPFlowNumber);
williamr@2
   192
williamr@2
   193
private:	
williamr@2
   194
	TUint16 iMediaComponentNumber;
williamr@2
   195
	TUint16 iIPFlowNumber;
williamr@2
   196
	};	
williamr@2
   197
williamr@2
   198
typedef RArray<TFlowId> RFlowIdentifiers;
williamr@2
   199
williamr@2
   200
/** Extension Parameter Sets, Consise of MAT and FI(s).
williamr@2
   201
Provides Implementation of Extension parameters of the SBLP Family.
williamr@2
   202
williamr@2
   203
@publishedAll
williamr@2
   204
@released Since 9.3
williamr@2
   205
*/
williamr@2
   206
class CSubConSBLPR5ExtensionParamSet : public CSubConExtensionParameterSet
williamr@2
   207
	{
williamr@2
   208
public:
williamr@2
   209
	enum 
williamr@2
   210
		{
williamr@2
   211
		EUid = KSubCon3GPPExtParamsFactoryUid,
williamr@2
   212
		EId = KSubConnSBLPR5ExtensionParamsType,
williamr@2
   213
		};
williamr@2
   214
	
williamr@2
   215
williamr@2
   216
public:
williamr@2
   217
	inline static CSubConSBLPR5ExtensionParamSet* NewL(CSubConParameterFamily& aFamily, CSubConParameterFamily::TParameterSetType aType);
williamr@2
   218
	inline static CSubConSBLPR5ExtensionParamSet* NewL();
williamr@2
   219
williamr@2
   220
	/**	Media Authorization Token setter and getter functions. */
williamr@2
   221
	inline const TAuthToken& GetMAT() const;
williamr@2
   222
	inline void SetMAT(const TAuthToken& aAuthToken);
williamr@2
   223
	
williamr@2
   224
	/** Flow identifires setter and getter functions. */
williamr@2
   225
	inline TInt GetNumberOfFlowIds() const;
williamr@2
   226
	inline const TFlowId& GetFlowIdAt(TInt aIndex) const;
williamr@2
   227
	
williamr@2
   228
	/** Adding of Flow Identifires into an array. */
williamr@2
   229
	inline void AddFlowIdL(const TFlowId& aFlowId);
williamr@2
   230
	
williamr@2
   231
	/** public constructors so that it can be accessed by factory. */
williamr@2
   232
	inline CSubConSBLPR5ExtensionParamSet();	
williamr@2
   233
	inline ~CSubConSBLPR5ExtensionParamSet();
williamr@2
   234
	
williamr@2
   235
protected:
williamr@2
   236
	DATA_VTABLE
williamr@2
   237
williamr@2
   238
	/** Single Media Authorization Token (MAT). */
williamr@2
   239
	TAuthToken iAuthToken;
williamr@2
   240
	
williamr@2
   241
	/** Multiple Flow Identifiers. */
williamr@2
   242
	RFlowIdentifiers	iFlowIds;
williamr@2
   243
	};
williamr@2
   244
williamr@2
   245
/** Factory used to create instances of IP SubConnection Parameters.
williamr@2
   246
williamr@2
   247
@internalComponent
williamr@2
   248
@released Since 9.3
williamr@2
   249
*/
williamr@2
   250
class CSubCon3GPPExtParamsFactory : public CBase
williamr@2
   251
	{
williamr@2
   252
public:
williamr@2
   253
	static CSubConExtensionParameterSet* NewL(TAny* aConstructionParameters);
williamr@2
   254
	};
williamr@2
   255
williamr@2
   256
#include <networking/qos3gpp_subconparams.inl>
williamr@2
   257
williamr@2
   258
#endif
williamr@2
   259
// QOS3GPP_SUBCONPARAMS_H