epoc32/include/cs_subconparams.inl
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) 2004-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
//
williamr@2
    15
williamr@2
    16
williamr@2
    17
williamr@2
    18
/**
williamr@2
    19
 @file
williamr@2
    20
 @publishedAll
williamr@2
    21
*/
williamr@2
    22
williamr@2
    23
#ifndef __CS_SUBCONPARAMS_INL__
williamr@2
    24
#define __CS_SUBCONPARAMS_INL__
williamr@2
    25
williamr@2
    26
CSubConQosGenericParamSet* CSubConQosGenericParamSet::NewL(CSubConParameterFamily& aFamily, CSubConParameterFamily::TParameterSetType aType)
williamr@2
    27
/** Creates a generic Qos family parameters sub-connection.
williamr@2
    28
williamr@2
    29
@param aFamily parameter sets.
williamr@2
    30
@param aType parameter type (Requested/Acceptable/Granted) 
williamr@2
    31
@return a CSubConQosGenericParamSet object pointer if successful,
williamr@2
    32
 otherwise leaves with system error code.
williamr@2
    33
*/
williamr@2
    34
	{
williamr@2
    35
	CSubConQosGenericParamSet* obj = NewL();
williamr@2
    36
	CleanupStack::PushL(obj);
williamr@2
    37
	aFamily.SetGenericSetL(*obj, aType);
williamr@2
    38
	CleanupStack::Pop(obj);
williamr@2
    39
	return obj;
williamr@2
    40
	}
williamr@2
    41
williamr@2
    42
CSubConQosGenericParamSet* CSubConQosGenericParamSet::NewL()
williamr@2
    43
/** Creates a generic Qos family parameters sub-connection.
williamr@2
    44
williamr@2
    45
@return a CSubConQosGenericParamSet object pointer if successful,
williamr@2
    46
 otherwise leaves with system error code.
williamr@2
    47
*/
williamr@2
    48
	{
williamr@2
    49
	STypeId typeId(KSubConnGenericParamsImplUid, KSubConnQosGenericParamsType);
williamr@2
    50
	return static_cast<CSubConQosGenericParamSet*>(CSubConParameterSet::NewL(typeId));
williamr@2
    51
	}
williamr@2
    52
williamr@2
    53
CSubConQosGenericParamSet::CSubConQosGenericParamSet()
williamr@2
    54
	: CSubConGenericParameterSet(),
williamr@2
    55
	iDownlinkBandwidth(0),
williamr@2
    56
	iUplinkBandwidth(0),
williamr@2
    57
	iDownLinkMaximumBurstSize(0),
williamr@2
    58
	iUpLinkMaximumBurstSize(0),
williamr@2
    59
	iDownLinkAveragePacketSize(0),
williamr@2
    60
	iUpLinkAveragePacketSize(0),
williamr@2
    61
	iDownLinkMaximumPacketSize(0),
williamr@2
    62
	iUpLinkMaximumPacketSize(0),
williamr@2
    63
	iDownLinkDelay(0),
williamr@2
    64
	iUpLinkDelay(0),
williamr@2
    65
	iDownLinkDelayVariation(0),
williamr@2
    66
	iUpLinkDelayVariation(0),
williamr@2
    67
	iDownLinkPriority(0),
williamr@2
    68
	iUpLinkPriority(0),
williamr@2
    69
	iHeaderMode(EFalse)
williamr@2
    70
/** Empty CSubConQosGenericParamSet constructor
williamr@2
    71
*/
williamr@2
    72
	{
williamr@2
    73
	}
williamr@2
    74
williamr@2
    75
TInt CSubConQosGenericParamSet::GetDownlinkBandwidth() const
williamr@2
    76
/** Gets downlink bandwidth value.
williamr@2
    77
williamr@2
    78
@return downlink bandwidth value. */
williamr@2
    79
	{
williamr@2
    80
	return iDownlinkBandwidth;
williamr@2
    81
	}
williamr@2
    82
williamr@2
    83
TInt CSubConQosGenericParamSet::GetUplinkBandwidth() const
williamr@2
    84
/** Gets uplink bandwidth value.
williamr@2
    85
williamr@2
    86
@return uplink bandwidth value. */
williamr@2
    87
	{
williamr@2
    88
	return iUplinkBandwidth;
williamr@2
    89
	}
williamr@2
    90
williamr@2
    91
TInt CSubConQosGenericParamSet::GetDownLinkMaximumBurstSize() const
williamr@2
    92
/** Gets downlink max burst size client can handle.
williamr@2
    93
williamr@2
    94
@return downlink max burst size . */
williamr@2
    95
	{
williamr@2
    96
	return iDownLinkMaximumBurstSize;
williamr@2
    97
	}
williamr@2
    98
williamr@2
    99
TInt CSubConQosGenericParamSet::GetUpLinkMaximumBurstSize() const
williamr@2
   100
/** Gets uplink max burst size client can handle.
williamr@2
   101
williamr@2
   102
@return uplink max burst size . */
williamr@2
   103
	{
williamr@2
   104
	return iUpLinkMaximumBurstSize;
williamr@2
   105
	}
williamr@2
   106
williamr@2
   107
TInt CSubConQosGenericParamSet::GetDownLinkAveragePacketSize() const
williamr@2
   108
/** Gets downlink average packet size required.
williamr@2
   109
williamr@2
   110
@return downlink average packet size . */
williamr@2
   111
	{
williamr@2
   112
	return iDownLinkAveragePacketSize;
williamr@2
   113
	}
williamr@2
   114
williamr@2
   115
TInt CSubConQosGenericParamSet::GetUpLinkAveragePacketSize() const
williamr@2
   116
/** Gets uplink average packet size required.
williamr@2
   117
williamr@2
   118
@return uplink average packet size . */
williamr@2
   119
	{
williamr@2
   120
	return iUpLinkAveragePacketSize;
williamr@2
   121
	}
williamr@2
   122
williamr@2
   123
TInt CSubConQosGenericParamSet::GetDownLinkMaximumPacketSize() const
williamr@2
   124
/** Gets downlink max packet size client can handle.
williamr@2
   125
williamr@2
   126
@return downlink max packet size . */
williamr@2
   127
	{
williamr@2
   128
	return iDownLinkMaximumPacketSize;
williamr@2
   129
	}
williamr@2
   130
williamr@2
   131
TInt CSubConQosGenericParamSet::GetUpLinkMaximumPacketSize() const
williamr@2
   132
/** Gets uplink max packet size client can handle.
williamr@2
   133
williamr@2
   134
@return uplink max packet size . */
williamr@2
   135
	{
williamr@2
   136
	return iUpLinkMaximumPacketSize;
williamr@2
   137
	}
williamr@2
   138
williamr@2
   139
TInt CSubConQosGenericParamSet::GetDownLinkDelay() const
williamr@2
   140
/** Gets acceptable downlink delay value.
williamr@2
   141
williamr@2
   142
@return downlink delay value. */
williamr@2
   143
	{
williamr@2
   144
	return iDownLinkDelay;
williamr@2
   145
	}
williamr@2
   146
williamr@2
   147
TInt CSubConQosGenericParamSet::GetUpLinkDelay() const
williamr@2
   148
/** Gets acceptable uplink delay value.
williamr@2
   149
williamr@2
   150
@return uplink delay value. */
williamr@2
   151
	{
williamr@2
   152
	return iUpLinkDelay;
williamr@2
   153
	}
williamr@2
   154
williamr@2
   155
TInt CSubConQosGenericParamSet::GetDownLinkDelayVariation() const
williamr@2
   156
/** Gets acceptable downlink delay variation value.
williamr@2
   157
williamr@2
   158
@return downlink delay variation value. */
williamr@2
   159
	{
williamr@2
   160
	return iDownLinkDelayVariation;
williamr@2
   161
	}
williamr@2
   162
williamr@2
   163
TInt CSubConQosGenericParamSet::GetUpLinkDelayVariation() const
williamr@2
   164
/** Gets acceptable uplink delay variation value.
williamr@2
   165
williamr@2
   166
@return uplink delay variation value. */
williamr@2
   167
	{
williamr@2
   168
	return iUpLinkDelayVariation;
williamr@2
   169
	}
williamr@2
   170
williamr@2
   171
TInt CSubConQosGenericParamSet::GetDownLinkPriority() const
williamr@2
   172
/** Gets downlink priority value (relative to other channel's priority).
williamr@2
   173
williamr@2
   174
@return downlink priority value. */
williamr@2
   175
	{
williamr@2
   176
	return iDownLinkPriority;
williamr@2
   177
	}
williamr@2
   178
williamr@2
   179
TInt CSubConQosGenericParamSet::GetUpLinkPriority() const
williamr@2
   180
/** Gets uplink priority value (relative to other channel's priority).
williamr@2
   181
williamr@2
   182
@return uplink priority value. */
williamr@2
   183
	{
williamr@2
   184
	return iUpLinkPriority;
williamr@2
   185
	}
williamr@2
   186
williamr@2
   187
TBool CSubConQosGenericParamSet::GetHeaderMode() const
williamr@2
   188
/** Gets header mode.
williamr@2
   189
williamr@2
   190
@return boolean value indicating whether the header size 
williamr@2
   191
should be calculated by the QoS module or specified by the client. */
williamr@2
   192
	{
williamr@2
   193
	return iHeaderMode;
williamr@2
   194
	}
williamr@2
   195
williamr@2
   196
const TName& CSubConQosGenericParamSet::GetName() const
williamr@2
   197
/** Gets Qos Parameter set name.
williamr@2
   198
williamr@2
   199
@return Qos Parameter set name. */
williamr@2
   200
	{
williamr@2
   201
	return iName;
williamr@2
   202
	}
williamr@2
   203
williamr@2
   204
void CSubConQosGenericParamSet::SetDownlinkBandwidth(TInt aDownlinkBandwidth)
williamr@2
   205
/** Sets downlink bandwidth value.
williamr@2
   206
williamr@2
   207
@param aDownlinkBandwidth downlink bandwidth value. */
williamr@2
   208
	{
williamr@2
   209
	iDownlinkBandwidth = aDownlinkBandwidth;
williamr@2
   210
	}
williamr@2
   211
williamr@2
   212
void CSubConQosGenericParamSet::SetUplinkBandwidth(TInt aUplinkBandwidth)
williamr@2
   213
/** Sets uplink bandwidth value.
williamr@2
   214
williamr@2
   215
@param aUplinkBandwidth uplink bandwidth value. */
williamr@2
   216
	{
williamr@2
   217
	iUplinkBandwidth = aUplinkBandwidth;
williamr@2
   218
	}
williamr@2
   219
williamr@2
   220
void CSubConQosGenericParamSet::SetDownLinkMaximumBurstSize(TInt aDownLinkMaximumBurstSize)
williamr@2
   221
/** Sets downlink max burst size client can handle.
williamr@2
   222
williamr@2
   223
@param aDownLinkMaximumBurstSize downlink max burst size . */
williamr@2
   224
	{
williamr@2
   225
	iDownLinkMaximumBurstSize = aDownLinkMaximumBurstSize;
williamr@2
   226
	}
williamr@2
   227
williamr@2
   228
void CSubConQosGenericParamSet::SetUpLinkMaximumBurstSize(TInt aUpLinkMaximumBurstSize)
williamr@2
   229
/** Sets uplink max burst size client can handle.
williamr@2
   230
williamr@2
   231
@param aUpLinkMaximumBurstSize uplink max burst size . */
williamr@2
   232
	{
williamr@2
   233
	iUpLinkMaximumBurstSize = aUpLinkMaximumBurstSize;
williamr@2
   234
	}
williamr@2
   235
williamr@2
   236
void CSubConQosGenericParamSet::SetDownLinkAveragePacketSize(TInt aDownLinkAveragePacketSize)
williamr@2
   237
/** Sets downlink average packet size required.
williamr@2
   238
williamr@2
   239
@param aDownLinkAveragePacketSize downlink average packet size . */
williamr@2
   240
	{
williamr@2
   241
	iDownLinkAveragePacketSize = aDownLinkAveragePacketSize;
williamr@2
   242
	}
williamr@2
   243
williamr@2
   244
void CSubConQosGenericParamSet::SetUpLinkAveragePacketSize(TInt aUpLinkAveragePacketSize)
williamr@2
   245
/** Sets uplink average packet size required.
williamr@2
   246
williamr@2
   247
@param aUpLinkAveragePacketSize uplink average packet size . */
williamr@2
   248
	{
williamr@2
   249
	iUpLinkAveragePacketSize = aUpLinkAveragePacketSize;
williamr@2
   250
	}
williamr@2
   251
williamr@2
   252
void CSubConQosGenericParamSet::SetDownLinkMaximumPacketSize(TInt aDownLinkMaximumPacketSize)
williamr@2
   253
/** Sets downlink max packet size client can handle.
williamr@2
   254
williamr@2
   255
@param aDownLinkMaximumPacketSize downlink max packet size . */
williamr@2
   256
	{
williamr@2
   257
	iDownLinkMaximumPacketSize = aDownLinkMaximumPacketSize;
williamr@2
   258
	}
williamr@2
   259
williamr@2
   260
void CSubConQosGenericParamSet::SetUpLinkMaximumPacketSize(TInt aUpLinkMaximumPacketSize)
williamr@2
   261
/** Sets uplink max packet size client can handle.
williamr@2
   262
williamr@2
   263
@param aUpLinkMaximumPacketSize uplink max packet size . */
williamr@2
   264
	{
williamr@2
   265
	iUpLinkMaximumPacketSize = aUpLinkMaximumPacketSize;
williamr@2
   266
	}
williamr@2
   267
williamr@2
   268
void CSubConQosGenericParamSet::SetDownLinkDelay(TInt aDownLinkDelay)
williamr@2
   269
/** Sets acceptable downlink delay value.
williamr@2
   270
williamr@2
   271
@param aDownLinkDelay downlink delay value. */
williamr@2
   272
	{
williamr@2
   273
	iDownLinkDelay = aDownLinkDelay;
williamr@2
   274
	}
williamr@2
   275
williamr@2
   276
void CSubConQosGenericParamSet::SetUpLinkDelay(TInt aUpLinkDelay)
williamr@2
   277
/** Sets acceptable uplink delay value.
williamr@2
   278
williamr@2
   279
@param aUpLinkDelay uplink delay value. */
williamr@2
   280
	{
williamr@2
   281
	iUpLinkDelay = aUpLinkDelay;
williamr@2
   282
	}
williamr@2
   283
williamr@2
   284
void CSubConQosGenericParamSet::SetDownLinkDelayVariation(TInt aDownLinkDelayVariation)
williamr@2
   285
/** Sets acceptable downlink delay variation value.
williamr@2
   286
williamr@2
   287
@param aDownLinkDelayVariation downlink delay variation value. */
williamr@2
   288
	{
williamr@2
   289
	iDownLinkDelayVariation = aDownLinkDelayVariation;
williamr@2
   290
	}
williamr@2
   291
williamr@2
   292
void CSubConQosGenericParamSet::SetUpLinkDelayVariation(TInt aUpLinkDelayVariation)
williamr@2
   293
/** Sets acceptable uplink delay variation value.
williamr@2
   294
williamr@2
   295
@param aUpLinkDelayVariation uplink delay variation value. */
williamr@2
   296
	{
williamr@2
   297
	iUpLinkDelayVariation = aUpLinkDelayVariation;
williamr@2
   298
	}
williamr@2
   299
williamr@2
   300
void CSubConQosGenericParamSet::SetDownLinkPriority(TInt aDownLinkPriority)
williamr@2
   301
/** Sets downlink priority value (relative to other channel's priority).
williamr@2
   302
williamr@2
   303
@param aDownLinkPriority downlink priority value. */
williamr@2
   304
	{
williamr@2
   305
	iDownLinkPriority = aDownLinkPriority;
williamr@2
   306
	}
williamr@2
   307
williamr@2
   308
void CSubConQosGenericParamSet::SetUpLinkPriority(TInt aUpLinkPriority)
williamr@2
   309
/** Sets uplink priority value (relative to other channel's priority).
williamr@2
   310
williamr@2
   311
@param aUpLinkPriority uplink priority value. */
williamr@2
   312
	{
williamr@2
   313
	iUpLinkPriority = aUpLinkPriority;
williamr@2
   314
	}
williamr@2
   315
williamr@2
   316
void CSubConQosGenericParamSet::SetHeaderMode(TBool aHeaderMode)
williamr@2
   317
/** Sets header mode.
williamr@2
   318
williamr@2
   319
@param aHeaderMode boolean value indicating whether the header size 
williamr@2
   320
should be calculated by the QoS module or specified by the client. */
williamr@2
   321
	{
williamr@2
   322
	iHeaderMode = aHeaderMode;
williamr@2
   323
	}
williamr@2
   324
williamr@2
   325
void CSubConQosGenericParamSet::SetName(const TName& aName)
williamr@2
   326
/** Sets Qos Parameter set name.
williamr@2
   327
williamr@2
   328
@param aName Qos Parameter set name. */
williamr@2
   329
	{
williamr@2
   330
	iName = aName;
williamr@2
   331
	}
williamr@2
   332
williamr@2
   333
//=============
williamr@2
   334
CSubConAuthorisationGenericParamSet* CSubConAuthorisationGenericParamSet::NewL(CSubConParameterFamily& aFamily, CSubConParameterFamily::TParameterSetType aType)
williamr@2
   335
/** Creates a generic Authorisation family parameters sub-connection.
williamr@2
   336
williamr@2
   337
@param aFamily parameter sets.
williamr@2
   338
@param aType parameter type (Requested/Acceptable/Granted) 
williamr@2
   339
@return a CSubConAuthorisationGenericParamSet object pointer if successful,
williamr@2
   340
 otherwise leaves with system error code.
williamr@2
   341
*/
williamr@2
   342
	{
williamr@2
   343
	CSubConAuthorisationGenericParamSet* obj = NewL();
williamr@2
   344
	CleanupStack::PushL(obj);
williamr@2
   345
	aFamily.SetGenericSetL(*obj, aType);
williamr@2
   346
	CleanupStack::Pop(obj);
williamr@2
   347
	return obj;
williamr@2
   348
	}
williamr@2
   349
williamr@2
   350
CSubConAuthorisationGenericParamSet* CSubConAuthorisationGenericParamSet::NewL()
williamr@2
   351
/** Creates a generic Authorisation family parameters sub-connection.
williamr@2
   352
williamr@2
   353
@return a CSubConAuthorisationGenericParamSet object pointer if successful,
williamr@2
   354
 otherwise leaves with system error code.
williamr@2
   355
*/
williamr@2
   356
	{
williamr@2
   357
	STypeId typeId(KSubConnGenericParamsImplUid, KSubConnAuthorisationGenericParamsType);
williamr@2
   358
	return static_cast<CSubConAuthorisationGenericParamSet*>(CSubConParameterSet::NewL(typeId));
williamr@2
   359
	}
williamr@2
   360
williamr@2
   361
CSubConAuthorisationGenericParamSet::CSubConAuthorisationGenericParamSet()
williamr@2
   362
	: CSubConGenericParameterSet(), 
williamr@2
   363
	iId(0)
williamr@2
   364
/** Empty CSubConAuthorisationGenericParamSet constructor
williamr@2
   365
*/
williamr@2
   366
	{
williamr@2
   367
	}
williamr@2
   368
williamr@2
   369
TInt CSubConAuthorisationGenericParamSet::GetId() const
williamr@2
   370
/** Gets Id of Authorisation Parameter set.
williamr@2
   371
williamr@2
   372
@return Id of Authorisation Parameter set. */
williamr@2
   373
	{
williamr@2
   374
	return iId;
williamr@2
   375
	}
williamr@2
   376
williamr@2
   377
void CSubConAuthorisationGenericParamSet::SetId(TInt aId)
williamr@2
   378
/** Sets Id of Authorisation Parameter set.
williamr@2
   379
williamr@2
   380
@param aId Id of Authorisation Parameter set. */
williamr@2
   381
	{
williamr@2
   382
	iId = aId;
williamr@2
   383
	}
williamr@2
   384
#endif	// __CS_SUBCONPARAMS_INL__