epoc32/include/cs_subconparams.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
     1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     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
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 // Header file for the Automated Test Tool
    15 // 
    16 //
    17 
    18 
    19 
    20 /**
    21  @file 
    22  @publishedAll
    23  @released
    24 */
    25 
    26 #ifndef __CS_SUBCONPARAMS_H__
    27 #define __CS_SUBCONPARAMS_H__
    28 
    29 #include <e32base.h>
    30 #include <e32std.h>
    31 #include <comms-infras/metadata.h>
    32 #include <comms-infras/metatype.h>
    33 
    34 #include <es_sock.h>
    35 
    36 const TInt32 KSubConnQosGenericParamsType = 1;
    37 const TInt32 KSubConnAuthorisationGenericParamsType = 2;
    38 using Meta::SMetaDataECom;
    39 
    40 class CSubConQosGenericParamSet : public CSubConGenericParameterSet
    41 /** Qos generic parameter set.
    42 
    43 This class contains a collection of generic QoS family parameters i.e, independent of any technology
    44 and provides the interface to access them.
    45 
    46 The following operations are also provided:
    47 
    48 GetDownlinkBandwidth()/SetDownlinkBandwidth() - Accessor function for downlink bandwidth value.
    49 GetUplinkBandwidth()/SetUplinkBandwidth() - Accessor function for uplink bandwidth value.
    50 GetDownLinkMaximumBurstSize()/SetDownLinkMaximumBurstSize() - Accessor function for maximum size of downlink burst of data the client can handle.
    51 GetUpLinkMaximumBurstSize()/SetUpLinkMaximumBurstSize() - Accessor function for maximum size of uplink burst of data the client can handle.
    52 GetDownLinkAveragePacketSize()/SetDownLinkAveragePacketSize() - Accessor function for downlink average packet size data.
    53 GetUpLinkAveragePacketSize()/SetUpLinkAveragePacketSize() - Accessor function for uplink average packet size data.
    54 GetDownLinkMaximumPacketSize()/SetDownLinkMaximumPacketSize() - Accessor function for downlink maximum packet size data.
    55 GetUpLinkMaximumPacketSize()/SetUpLinkMaximumPacketSize() - Accessor function for uplink maximum packet size data.
    56 GetDownLinkDelay()/SetDownLinkDelay() - Accessor function for acceptable downlink delay/latency value.
    57 GetUpLinkDelay()/SetUpLinkDelay() - Accessor function for acceptable uplink delay/latency value.
    58 GetDownLinkDelayVariation()/SetDownLinkDelayVariation() - Accessor function for acceptable downlink variation in delay.
    59 GetUpLinkDelayVariation()/SetUpLinkDelayVariation() - Accessor function for acceptable uplink variation in delay.
    60 GetDownLinkPriority()/SetDownLinkPriority() - Accessor function for downlink priority
    61 GetUpLinkPriority()/SetUpLinkPriority() - Accessor function for uplink priority
    62 GetHeaderMode()/SetHeaderMode() - Accessor function for header mode (Specify whether the header size should be calculated by the QoS module or specified by the client)
    63 GetName()/SetName() - Accessor function for QoS Parameters name.
    64 
    65 @note SMetaDataECom must be the first in the superclasses' list
    66 @publishedAll
    67 @released since v9.1 */
    68 {
    69 public:
    70 	inline static CSubConQosGenericParamSet* NewL(CSubConParameterFamily& aFamily, CSubConParameterFamily::TParameterSetType aType);
    71 	inline static CSubConQosGenericParamSet* NewL();
    72 
    73 	inline CSubConQosGenericParamSet();
    74 
    75 	inline TInt GetDownlinkBandwidth() const;
    76 	inline TInt GetUplinkBandwidth() const;
    77 	inline TInt GetDownLinkMaximumBurstSize() const;
    78 	inline TInt GetUpLinkMaximumBurstSize() const;
    79 	inline TInt GetDownLinkAveragePacketSize() const;
    80 	inline TInt GetUpLinkAveragePacketSize() const;
    81 	inline TInt GetDownLinkMaximumPacketSize() const;
    82 	inline TInt GetUpLinkMaximumPacketSize() const;
    83 	inline TInt GetDownLinkDelay() const;
    84 	inline TInt GetUpLinkDelay() const;
    85 	inline TInt GetDownLinkDelayVariation() const;
    86 	inline TInt GetUpLinkDelayVariation() const;
    87 	inline TInt GetDownLinkPriority() const;
    88 	inline TInt GetUpLinkPriority() const;
    89 	inline TBool GetHeaderMode() const;
    90 	inline const TName& GetName() const;
    91 
    92 	inline void SetDownlinkBandwidth(TInt);
    93 	inline void SetUplinkBandwidth(TInt);
    94 	inline void SetDownLinkMaximumBurstSize(TInt);
    95 	inline void SetUpLinkMaximumBurstSize(TInt);
    96 	inline void SetDownLinkAveragePacketSize(TInt);
    97 	inline void SetUpLinkAveragePacketSize(TInt);
    98 	inline void SetDownLinkMaximumPacketSize(TInt);
    99 	inline void SetUpLinkMaximumPacketSize(TInt);
   100 	inline void SetDownLinkDelay(TInt);
   101 	inline void SetUpLinkDelay(TInt);
   102 	inline void SetDownLinkDelayVariation(TInt);
   103 	inline void SetUpLinkDelayVariation(TInt);
   104 	inline void SetDownLinkPriority(TInt);
   105 	inline void SetUpLinkPriority(TInt);
   106 	inline void SetHeaderMode(TBool);
   107 	inline void SetName(const TName&);
   108 
   109 protected:
   110 
   111 	DATA_VTABLE
   112 
   113 	TInt iDownlinkBandwidth;
   114 	TInt iUplinkBandwidth;
   115 	TInt iDownLinkMaximumBurstSize;
   116 	TInt iUpLinkMaximumBurstSize;
   117 	TInt iDownLinkAveragePacketSize;
   118 	TInt iUpLinkAveragePacketSize;
   119 	TInt iDownLinkMaximumPacketSize;
   120 	TInt iUpLinkMaximumPacketSize;
   121 	TInt iDownLinkDelay;
   122 	TInt iUpLinkDelay;
   123 	TInt iDownLinkDelayVariation;
   124 	TInt iUpLinkDelayVariation;
   125 	TInt iDownLinkPriority;
   126 	TInt iUpLinkPriority;
   127 	TBool iHeaderMode;
   128 	TName iName;
   129 	};
   130 
   131 class CSubConAuthorisationGenericParamSet : public CSubConGenericParameterSet
   132 /** Authorisation generic parameter set.
   133 
   134 This class contains authorization generic parameters.
   135 
   136 @note SMetaDataECom must be the first in the superclasses' list
   137 @publishedAll
   138 @released since v9.1 */
   139 {
   140 public:
   141 	inline static CSubConAuthorisationGenericParamSet* NewL(CSubConParameterFamily& aFamily, CSubConParameterFamily::TParameterSetType aType);
   142 	inline static CSubConAuthorisationGenericParamSet* NewL();
   143 
   144 	inline CSubConAuthorisationGenericParamSet();
   145 
   146 	inline TInt GetId() const;
   147 
   148 	inline void SetId(TInt);
   149 
   150 protected:
   151 
   152 	DATA_VTABLE
   153 
   154 	TInt iId;
   155 	};
   156 
   157 class CSubConGenericParamsFactory : public CBase
   158 /** Sub connection generic parameter set factory.
   159 
   160 @internalComponent
   161 @released since v9.1 */
   162 	{
   163 public:
   164 	static CSubConGenericParameterSet* NewL(TAny* aConstructionParameters);
   165 	};
   166 
   167 #include <cs_subconparams.inl>
   168 #endif	// __CS_SUBCONPARAMS_H__