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