epoc32/include/ip_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
/**
williamr@4
     2
* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:
williamr@2
    15
* Header file for the IP SubConnection Parameters
williamr@2
    16
* 
williamr@2
    17
*
williamr@2
    18
*/
williamr@2
    19
williamr@2
    20
williamr@2
    21
williamr@2
    22
/**
williamr@2
    23
 @file ip_subconparams.h
williamr@2
    24
*/
williamr@2
    25
williamr@2
    26
#ifndef __IP_SUBCONPARAMS_H__
williamr@2
    27
#define __IP_SUBCONPARAMS_H__
williamr@2
    28
williamr@2
    29
#include <es_sock.h>
williamr@4
    30
#include <networking/Qos3GPP_subconparams.h>
williamr@2
    31
williamr@4
    32
 
williamr@2
    33
// NOTE: This Uid may be changed - See #ifdef at bottom of the file
williamr@2
    34
const TInt KSubConIPParamsUid = 0x10204309;
williamr@4
    35
williamr@2
    36
const TInt KSubConQosIPLinkR99ParamsType = 1;
williamr@2
    37
williamr@2
    38
#ifdef SYMBIAN_NETWORKING_3GPPDEFAULTQOS
williamr@2
    39
#include <networking/qos3gpp_subconparams.h>
williamr@2
    40
williamr@2
    41
#else
williamr@2
    42
const TInt KSubConnSBLPR5ExtensionParamsType = 2;
williamr@2
    43
williamr@2
    44
/** Constant definitions particular to the Generic Parameters. */
williamr@2
    45
const TInt KMAuthTokenLength = 255;
williamr@2
    46
/** Typedef for the AuthToken Holder. */
williamr@2
    47
typedef TBuf8<KMAuthTokenLength> TAuthToken;
williamr@2
    48
#endif
williamr@2
    49
williamr@2
    50
#ifdef SYMBIAN_NETWORKING_3GPPDEFAULTQOS
williamr@2
    51
/** Provides Implementation of IP QoS Parameters
williamr@2
    52
williamr@2
    53
@publishedAll
williamr@2
    54
@released since v9.1
williamr@4
    55
@deprecated Since Intulo. Use CSubConQosR99ParamSet from Qos3GPP_Subconparams.h instead.
williamr@2
    56
*/
williamr@2
    57
#else
williamr@2
    58
/** Provides Implementation of IP QoS Parameters
williamr@2
    59
williamr@2
    60
@publishedAll
williamr@2
    61
@released since v9.1
williamr@4
    62
*/
williamr@4
    63
#endif
williamr@4
    64
williamr@2
    65
class CSubConQosIPLinkR99ParamSet : public CSubConExtensionParameterSet
williamr@2
    66
{
williamr@2
    67
public:
williamr@2
    68
	inline static CSubConQosIPLinkR99ParamSet* NewL(CSubConParameterFamily& aFamily, CSubConParameterFamily::TParameterSetType aType);
williamr@4
    69
	inline static CSubConQosIPLinkR99ParamSet* NewL(RParameterFamily& aFamily, RParameterFamily::TParameterSetType aType);
williamr@2
    70
	inline static CSubConQosIPLinkR99ParamSet* NewL();
williamr@2
    71
williamr@2
    72
	inline CSubConQosIPLinkR99ParamSet();
williamr@2
    73
williamr@2
    74
	inline RPacketQoS::TTrafficClass GetTrafficClass() const;
williamr@2
    75
	inline RPacketQoS::TDeliveryOrder GetDeliveryOrder() const;
williamr@2
    76
	inline RPacketQoS::TErroneousSDUDelivery GetErroneousSDUDelivery() const;
williamr@2
    77
	inline RPacketQoS::TBitErrorRatio GetResidualBitErrorRatio() const;
williamr@2
    78
	inline RPacketQoS::TSDUErrorRatio GetSDUErrorRatio() const;
williamr@2
    79
	inline RPacketQoS::TTrafficHandlingPriority GetTrafficHandlingPriority() const;
williamr@2
    80
	inline TInt GetTransferDelay() const;
williamr@2
    81
	inline TInt GetMaxSduSize() const;
williamr@2
    82
	inline TInt GetMaxBitrateUplink() const;
williamr@2
    83
	inline TInt GetMaxBitrateDownlink() const;
williamr@2
    84
	inline TInt GetGuaBitrateUplink() const;
williamr@2
    85
	inline TInt GetGuaBitrateDownlink() const;
williamr@2
    86
	inline void SetTrafficClass(RPacketQoS::TTrafficClass aTrafficClass);
williamr@2
    87
	inline void SetDeliveryOrder(RPacketQoS::TDeliveryOrder aDeliveryOrder);
williamr@2
    88
	inline void SetErroneousSDUDelivery(RPacketQoS::TErroneousSDUDelivery aDeliveryOfErroneusSdu);
williamr@2
    89
	inline void SetResidualBitErrorRatio(RPacketQoS::TBitErrorRatio aResidualBer);
williamr@2
    90
	inline void SetSDUErrorRatio(RPacketQoS::TSDUErrorRatio aErrorRatio);
williamr@2
    91
	inline void SetTrafficHandlingPriority(RPacketQoS::TTrafficHandlingPriority aPriority);
williamr@2
    92
	inline void SetTransferDelay(TInt aTransferDelay);
williamr@2
    93
	inline void SetMaxSduSize(TInt aMaxSduSize);
williamr@2
    94
	inline void SetMaxBitrateUplink(TInt aMaxBitrateUplink);
williamr@2
    95
	inline void SetMaxBitrateDownlink(TInt aMaxBitrateDownlink);
williamr@2
    96
	inline void SetGuaBitrateUplink(TInt aGuaBitrateUplink);
williamr@2
    97
	inline void SetGuaBitrateDownlink(TInt aGuaBitrateDownlink);
williamr@2
    98
williamr@2
    99
protected:
williamr@2
   100
williamr@2
   101
	DATA_VTABLE
williamr@2
   102
williamr@2
   103
protected:
williamr@2
   104
	RPacketQoS::TTrafficClass				iTrafficClass;			// Traffic class
williamr@2
   105
	RPacketQoS::TDeliveryOrder				iDeliveryOrder;			// Delivery order
williamr@2
   106
	RPacketQoS::TErroneousSDUDelivery		iDeliveryOfErroneusSdu;	// Delivery of erroneous SDUs
williamr@2
   107
	RPacketQoS::TBitErrorRatio				iResidualBer;			// Residual BER
williamr@2
   108
	RPacketQoS::TSDUErrorRatio				iErrorRatio;			// SDU error ratio
williamr@2
   109
	RPacketQoS::TTrafficHandlingPriority	iPriority;				// Traffic handling priority
williamr@2
   110
	TInt									iTransferDelay;			// Transfer delay
williamr@2
   111
	TInt									iMaxSduSize;			// Maximum SDU size
williamr@2
   112
	TInt									iMaxBitrateUplink;		// Maximum bit rate for uplink
williamr@2
   113
	TInt									iMaxBitrateDownlink;	// Maximum bit rate for downlink
williamr@2
   114
	TInt									iGuaBitrateUplink;		// Guaranteed bit rate for uplink
williamr@2
   115
	TInt									iGuaBitrateDownlink;	// Guaranteed bit rate for downlink
williamr@2
   116
	};
williamr@2
   117
williamr@4
   118
williamr@4
   119
williamr@2
   120
#ifndef SYMBIAN_NETWORKING_3GPPDEFAULTQOS
williamr@2
   121
williamr@2
   122
/** Flow Identifires
williamr@2
   123
ECOM Implementation Id for SBLP Extension parameters.
williamr@2
   124
williamr@2
   125
@publishedAll
williamr@2
   126
@released since v9.1 */
williamr@2
   127
struct TFlowId
williamr@2
   128
	{
williamr@2
   129
	/** Getter Function for the Components of Flow ids. */
williamr@2
   130
	inline TUint16 GetMediaComponentNumber() const;
williamr@2
   131
	inline TUint16 GetIPFlowNumber() const;
williamr@2
   132
	/**	Setter Function For Flow Id Components.	*/
williamr@2
   133
	inline void SetMediaComponentNumber(TUint16 aMediaComponentNumber);
williamr@2
   134
	inline void SetIPFlowNumber(TUint16 aIPFlowNumber);
williamr@2
   135
williamr@2
   136
private:	
williamr@2
   137
	TUint16 iMediaComponentNumber;
williamr@2
   138
	TUint16 iIPFlowNumber;
williamr@2
   139
	};	
williamr@2
   140
williamr@2
   141
typedef RArray<TFlowId> RFlowIdentifiers;
williamr@2
   142
williamr@2
   143
/** Extension Parameter Sets, Consise of MAT and FI(s).
williamr@2
   144
Provides Implementation of Extension parameters of the SBLP Family.
williamr@2
   145
williamr@2
   146
@publishedAll
williamr@2
   147
@released since v9.1 */
williamr@2
   148
class CSubConSBLPR5ExtensionParamSet : public CSubConExtensionParameterSet
williamr@2
   149
	{
williamr@2
   150
public:
williamr@2
   151
	inline static CSubConSBLPR5ExtensionParamSet* NewL(CSubConParameterFamily& aFamily, CSubConParameterFamily::TParameterSetType aType);
williamr@4
   152
	inline static CSubConSBLPR5ExtensionParamSet* NewL(RParameterFamily& aFamily, RParameterFamily::TParameterSetType aType);
williamr@2
   153
	inline static CSubConSBLPR5ExtensionParamSet* NewL();
williamr@2
   154
williamr@2
   155
	/**	Media Authorization Token setter and getter functions. */
williamr@2
   156
	inline const TAuthToken& GetMAT() const;
williamr@2
   157
	inline void SetMAT(const TAuthToken& aAuthToken);
williamr@2
   158
	
williamr@2
   159
	/** Flow identifires setter and getter functions. */
williamr@2
   160
	inline TInt GetNumberOfFlowIds() const;
williamr@2
   161
	inline const TFlowId& GetFlowIdAt(TInt aIndex) const;
williamr@2
   162
	
williamr@2
   163
	/** Adding of Flow Identifires into an array. */
williamr@2
   164
	inline void AddFlowIdL(const TFlowId& aFlowId);
williamr@2
   165
	
williamr@2
   166
	/** public constructors so that it can be accessed by factory. */
williamr@2
   167
	inline CSubConSBLPR5ExtensionParamSet();	
williamr@2
   168
	inline ~CSubConSBLPR5ExtensionParamSet();
williamr@2
   169
	
williamr@2
   170
protected:
williamr@2
   171
	DATA_VTABLE
williamr@2
   172
williamr@2
   173
	/** Single Media Authorization Token (MAT). */
williamr@2
   174
	TAuthToken iAuthToken;
williamr@2
   175
	
williamr@2
   176
	/** Multiple Flow Identifiers. */
williamr@2
   177
	RFlowIdentifiers	iFlowIds;
williamr@2
   178
	};
williamr@2
   179
#endif
williamr@2
   180
williamr@2
   181
/**
williamr@2
   182
Factory used to create instances of IP SubConnection Parameters.
williamr@2
   183
williamr@2
   184
@internalComponent
williamr@2
   185
@released since v9.1
williamr@2
   186
*/
williamr@2
   187
class CSubConIPExtensionParamsFactory : public CBase
williamr@2
   188
	{
williamr@2
   189
public:
williamr@2
   190
	static CSubConExtensionParameterSet* NewL(TAny* aConstructionParameters);
williamr@2
   191
	};
williamr@2
   192
williamr@2
   193
#include <ip_subconparams.inl>
williamr@2
   194
williamr@2
   195
#ifdef SYMBIAN_NETWORKING_3GPPDEFAULTQOS
williamr@2
   196
/*
williamr@2
   197
 Umts QoS extension classes have been relocated to the UmtsGprsSCPR component.
williamr@2
   198
 So now we need to make sure that the correct class factory TUid, class name,
williamr@2
   199
 and class Id are used
williamr@2
   200
*/
williamr@2
   201
#define KSubConIPParamsUid KSubCon3GPPExtParamsFactoryUid
williamr@2
   202
#define KSubConQosIPLinkR99ParamsType KSubConQosR99ParamsType
williamr@2
   203
#define CSubConQosIPLinkR99ParamSet CSubConQosR99ParamSet
williamr@2
   204
#endif
williamr@2
   205
// SYMBIAN_NETWORKING_3GPPDEFAULTQOS
williamr@2
   206
williamr@2
   207
#endif
williamr@2
   208
// __IP_SUBCONPARAMS_H__