epoc32/include/cs_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) 1997-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 Automated Test Tool
williamr@2
    15
// 
williamr@2
    16
//
williamr@2
    17
williamr@2
    18
/**
williamr@2
    19
 @file 
williamr@2
    20
 @publishedAll
williamr@2
    21
 @released
williamr@2
    22
*/
williamr@2
    23
williamr@2
    24
#ifndef __CS_SUBCONPARAMS_H__
williamr@2
    25
#define __CS_SUBCONPARAMS_H__
williamr@2
    26
williamr@2
    27
#include <e32base.h>
williamr@2
    28
#include <e32std.h>
williamr@2
    29
#include <comms-infras/metadata.h>
williamr@2
    30
#include <comms-infras/metatype.h>
williamr@4
    31
#include <comms-infras/es_parameterfamily.h>
williamr@2
    32
williamr@2
    33
#include <es_sock.h>
williamr@2
    34
williamr@4
    35
//Parameter Types are defined here and enums defined locally in the class
williamr@2
    36
const TInt32 KSubConnQosGenericParamsType = 1;
williamr@2
    37
const TInt32 KSubConnAuthorisationGenericParamsType = 2;
williamr@4
    38
const TInt32 KFlowRequestParametersType = 3;
williamr@4
    39
const TInt32 KSubConnProtocolGenericParamsType = 4;
williamr@4
    40
williamr@2
    41
using Meta::SMetaDataECom;
williamr@2
    42
williamr@2
    43
class CSubConQosGenericParamSet : public CSubConGenericParameterSet
williamr@2
    44
/** Qos generic parameter set.
williamr@2
    45
williamr@2
    46
This class contains a collection of generic QoS family parameters i.e, independent of any technology
williamr@2
    47
and provides the interface to access them.
williamr@2
    48
williamr@2
    49
The following operations are also provided:
williamr@2
    50
williamr@2
    51
GetDownlinkBandwidth()/SetDownlinkBandwidth() - Accessor function for downlink bandwidth value.
williamr@2
    52
GetUplinkBandwidth()/SetUplinkBandwidth() - Accessor function for uplink bandwidth value.
williamr@2
    53
GetDownLinkMaximumBurstSize()/SetDownLinkMaximumBurstSize() - Accessor function for maximum size of downlink burst of data the client can handle.
williamr@2
    54
GetUpLinkMaximumBurstSize()/SetUpLinkMaximumBurstSize() - Accessor function for maximum size of uplink burst of data the client can handle.
williamr@2
    55
GetDownLinkAveragePacketSize()/SetDownLinkAveragePacketSize() - Accessor function for downlink average packet size data.
williamr@2
    56
GetUpLinkAveragePacketSize()/SetUpLinkAveragePacketSize() - Accessor function for uplink average packet size data.
williamr@2
    57
GetDownLinkMaximumPacketSize()/SetDownLinkMaximumPacketSize() - Accessor function for downlink maximum packet size data.
williamr@2
    58
GetUpLinkMaximumPacketSize()/SetUpLinkMaximumPacketSize() - Accessor function for uplink maximum packet size data.
williamr@2
    59
GetDownLinkDelay()/SetDownLinkDelay() - Accessor function for acceptable downlink delay/latency value.
williamr@2
    60
GetUpLinkDelay()/SetUpLinkDelay() - Accessor function for acceptable uplink delay/latency value.
williamr@2
    61
GetDownLinkDelayVariation()/SetDownLinkDelayVariation() - Accessor function for acceptable downlink variation in delay.
williamr@2
    62
GetUpLinkDelayVariation()/SetUpLinkDelayVariation() - Accessor function for acceptable uplink variation in delay.
williamr@2
    63
GetDownLinkPriority()/SetDownLinkPriority() - Accessor function for downlink priority
williamr@2
    64
GetUpLinkPriority()/SetUpLinkPriority() - Accessor function for uplink priority
williamr@2
    65
GetHeaderMode()/SetHeaderMode() - Accessor function for header mode (Specify whether the header size should be calculated by the QoS module or specified by the client)
williamr@2
    66
GetName()/SetName() - Accessor function for QoS Parameters name.
williamr@2
    67
williamr@2
    68
@note SMetaDataECom must be the first in the superclasses' list
williamr@2
    69
@publishedAll
williamr@2
    70
@released since v9.1 */
williamr@2
    71
{
williamr@2
    72
public:
williamr@4
    73
	enum
williamr@4
    74
		{
williamr@4
    75
		EUid=KSubConnGenericParamsImplUid,
williamr@4
    76
		EType=KSubConnQosGenericParamsType
williamr@4
    77
		};
williamr@4
    78
williamr@2
    79
	inline static CSubConQosGenericParamSet* NewL(CSubConParameterFamily& aFamily, CSubConParameterFamily::TParameterSetType aType);
williamr@4
    80
	inline static CSubConQosGenericParamSet* NewL(RParameterFamily& aFamily, RParameterFamily::TParameterSetType aType);
williamr@2
    81
	inline static CSubConQosGenericParamSet* NewL();
williamr@2
    82
williamr@2
    83
	inline CSubConQosGenericParamSet();
williamr@2
    84
williamr@2
    85
	inline TInt GetDownlinkBandwidth() const;
williamr@2
    86
	inline TInt GetUplinkBandwidth() const;
williamr@2
    87
	inline TInt GetDownLinkMaximumBurstSize() const;
williamr@2
    88
	inline TInt GetUpLinkMaximumBurstSize() const;
williamr@2
    89
	inline TInt GetDownLinkAveragePacketSize() const;
williamr@2
    90
	inline TInt GetUpLinkAveragePacketSize() const;
williamr@2
    91
	inline TInt GetDownLinkMaximumPacketSize() const;
williamr@2
    92
	inline TInt GetUpLinkMaximumPacketSize() const;
williamr@2
    93
	inline TInt GetDownLinkDelay() const;
williamr@2
    94
	inline TInt GetUpLinkDelay() const;
williamr@2
    95
	inline TInt GetDownLinkDelayVariation() const;
williamr@2
    96
	inline TInt GetUpLinkDelayVariation() const;
williamr@2
    97
	inline TInt GetDownLinkPriority() const;
williamr@2
    98
	inline TInt GetUpLinkPriority() const;
williamr@2
    99
	inline TBool GetHeaderMode() const;
williamr@2
   100
	inline const TName& GetName() const;
williamr@2
   101
williamr@2
   102
	inline void SetDownlinkBandwidth(TInt);
williamr@2
   103
	inline void SetUplinkBandwidth(TInt);
williamr@2
   104
	inline void SetDownLinkMaximumBurstSize(TInt);
williamr@2
   105
	inline void SetUpLinkMaximumBurstSize(TInt);
williamr@2
   106
	inline void SetDownLinkAveragePacketSize(TInt);
williamr@2
   107
	inline void SetUpLinkAveragePacketSize(TInt);
williamr@2
   108
	inline void SetDownLinkMaximumPacketSize(TInt);
williamr@2
   109
	inline void SetUpLinkMaximumPacketSize(TInt);
williamr@2
   110
	inline void SetDownLinkDelay(TInt);
williamr@2
   111
	inline void SetUpLinkDelay(TInt);
williamr@2
   112
	inline void SetDownLinkDelayVariation(TInt);
williamr@2
   113
	inline void SetUpLinkDelayVariation(TInt);
williamr@2
   114
	inline void SetDownLinkPriority(TInt);
williamr@2
   115
	inline void SetUpLinkPriority(TInt);
williamr@2
   116
	inline void SetHeaderMode(TBool);
williamr@2
   117
	inline void SetName(const TName&);
williamr@2
   118
williamr@2
   119
protected:
williamr@2
   120
williamr@2
   121
	DATA_VTABLE
williamr@2
   122
williamr@2
   123
	TInt iDownlinkBandwidth;
williamr@2
   124
	TInt iUplinkBandwidth;
williamr@2
   125
	TInt iDownLinkMaximumBurstSize;
williamr@2
   126
	TInt iUpLinkMaximumBurstSize;
williamr@2
   127
	TInt iDownLinkAveragePacketSize;
williamr@2
   128
	TInt iUpLinkAveragePacketSize;
williamr@2
   129
	TInt iDownLinkMaximumPacketSize;
williamr@2
   130
	TInt iUpLinkMaximumPacketSize;
williamr@2
   131
	TInt iDownLinkDelay;
williamr@2
   132
	TInt iUpLinkDelay;
williamr@2
   133
	TInt iDownLinkDelayVariation;
williamr@2
   134
	TInt iUpLinkDelayVariation;
williamr@2
   135
	TInt iDownLinkPriority;
williamr@2
   136
	TInt iUpLinkPriority;
williamr@2
   137
	TBool iHeaderMode;
williamr@2
   138
	TName iName;
williamr@2
   139
	};
williamr@2
   140
williamr@2
   141
class CSubConAuthorisationGenericParamSet : public CSubConGenericParameterSet
williamr@2
   142
/** Authorisation generic parameter set.
williamr@2
   143
williamr@2
   144
This class contains authorization generic parameters.
williamr@2
   145
williamr@2
   146
@note SMetaDataECom must be the first in the superclasses' list
williamr@2
   147
@publishedAll
williamr@2
   148
@released since v9.1 */
williamr@2
   149
{
williamr@2
   150
public:
williamr@4
   151
	enum
williamr@4
   152
		{
williamr@4
   153
		EUid=KSubConnGenericParamsImplUid,
williamr@4
   154
		EType=KSubConnAuthorisationGenericParamsType
williamr@4
   155
		};
williamr@4
   156
williamr@2
   157
	inline static CSubConAuthorisationGenericParamSet* NewL(CSubConParameterFamily& aFamily, CSubConParameterFamily::TParameterSetType aType);
williamr@4
   158
	inline static CSubConAuthorisationGenericParamSet* NewL(RParameterFamily& aFamily, RParameterFamily::TParameterSetType aType);
williamr@2
   159
	inline static CSubConAuthorisationGenericParamSet* NewL();
williamr@2
   160
williamr@2
   161
	inline CSubConAuthorisationGenericParamSet();
williamr@2
   162
williamr@2
   163
	inline TInt GetId() const;
williamr@2
   164
williamr@2
   165
	inline void SetId(TInt);
williamr@2
   166
williamr@2
   167
protected:
williamr@2
   168
williamr@2
   169
	DATA_VTABLE
williamr@2
   170
williamr@2
   171
	TInt iId;
williamr@2
   172
	};
williamr@2
   173
williamr@2
   174
williamr@2
   175
#include <cs_subconparams.inl>
williamr@4
   176
williamr@2
   177
#endif	// __CS_SUBCONPARAMS_H__
williamr@4
   178