Symbian^3 Application Developer Library >

TWlanTrafficStreamParameters Class Reference

class TWlanTrafficStreamParameters

Parameter storage for a virtual traffic stream.

This class is used to store the parameters of a virtual traffic stream. When instantiated, it sets all the parameters to the default values so the client application only needs to set the parameters it specifically wants to alter.

Any parameter left to its default value means that the WLAN subsystem is free to select a suitable value.

Public Member Functions
TWlanTrafficStreamParameters ( TUint8 )
void SetAutomaticRetry ( TBool )
void SetDelayBound ( TUint32 )
void SetDirection ( TWlanTrafficStreamDirection )
void SetId ( TUint8 )
void SetInactivityInterval ( TUint32 )
void SetMaximumBurstSize ( TUint32 )
void SetMaximumMsduSize ( TUint16 )
void SetMaximumServiceInterval ( TUint32 )
void SetMeanDataRate ( TUint32 )
void SetMinimumDataRate ( TUint32 )
void SetMinimumPhyRate ( TWlanRate )
void SetMinimumServiceInterval ( TUint32 )
void SetNominalMsduSize ( TUint16 , TBool )
void SetNominalPhyRate ( TWlanRate )
void SetPeakDataRate ( TUint32 )
void SetSba ( TUint16 )
void SetServiceStartTime ( TUint32 )
void SetSuspensionInterval ( TUint32 )
void SetTrafficType ( TWlanTrafficStreamTrafficType )
Public Member Enumerations
enum TWlanParameter {
EWlanParameterNone  = 0x00000000, EWlanParameterType  = 0x00000001, EWlanParameterId  = 0x00000002, EWlanParameterDirection  = 0x00000004, EWlanParameterNominalMsduSize  = 0x00000008, EWlanParameterMaximumMsduSize  = 0x00000010, EWlanParameterMinimumServiceInterval  = 0x00000020, EWlanParameterMaximumServiceInterval  = 0x00000040, EWlanParameterInactivityInterval  = 0x00000080, EWlanParameterSuspensionInterval  = 0x00000100, EWlanParameterServiceStartTime  = 0x00000200, EWlanParameterMinimumDataRate  = 0x00000400, EWlanParameterMeanDataRate  = 0x00000800, EWlanParameterPeakDataRate  = 0x00001000, EWlanParameterMaximumBurstSize  = 0x00002000, EWlanParameterDelayBound  = 0x00004000, EWlanParameterMinimumPhyRate  = 0x00008000, EWlanParameterNominalPhyRate  = 0x00010000, EWlanParameterSba  = 0x00020000, EWlanParameterIsRetryAllowed  = 0x00040000
}
Public Attributes
TUint32 iDelayBound
TWlanTrafficStreamDirection iDirection
TUint8 iId
TUint32 iInactivityInterval
TBool iIsAutomaticRetryAllowed
TBool iIsMsduSizeFixed
TUint32 iMaximumBurstSize
TUint16 iMaximumMsduSize
TUint32 iMaximumServiceInterval
TUint32 iMeanDataRate
TUint32 iMinimumDataRate
TWlanRate iMinimumPhyRate
TUint32 iMinimumServiceInterval
TUint16 iNominalMsduSize
TWlanRate iNominalPhyRate
TUint32 iParameterBitmap
TUint32 iPeakDataRate
TUint16 iSba
TUint32 iServiceStartTime
TUint32 iSuspensionInterval
TWlanTrafficStreamTrafficType iType
TUint8 iUserPriority

Constructor & Destructor Documentation

TWlanTrafficStreamParameters(TUint8)

TWlanTrafficStreamParameters ( TUint8 aUserPriority ) [inline]

Constructor.

Parameters

TUint8 aUserPriority User Priority (0 - 7) admission is requested for.

Member Functions Documentation

SetAutomaticRetry(TBool)

void SetAutomaticRetry ( TBool aIsAllowed ) [inline]

Set the whether re-creation of traffic streams is allowed.

Parameters

TBool aIsAllowed Whether re-creation of traffic streams that have been deleted or refused by the current WLAN access point can be automatically retried.

SetDelayBound(TUint32)

void SetDelayBound ( TUint32 aDelay ) [inline]

Set the maximum transport delay used.

Parameters

TUint32 aDelay The maximum amount of microseconds allowed to transport a packet belonging to this traffic stream.

SetDirection(TWlanTrafficStreamDirection)

void SetDirection ( TWlanTrafficStreamDirection aDirection ) [inline]

Set the traffic stream direction used.

Parameters

TWlanTrafficStreamDirection aDirection Traffic stream direction.

SetId(TUint8)

void SetId ( TUint8 aId ) [inline]

Set the traffic stream ID used.

Parameters

TUint8 aId Traffic Stream ID (0 - 7).

SetInactivityInterval(TUint32)

void SetInactivityInterval ( TUint32 aInactivityInterval ) [inline]

Set the inactivity interval used.

Parameters

TUint32 aInactivityInterval The minimum amount of microseconds that may elapse without arrival or transfer of packets belonging to this traffic stream before the traffic stream is deleted.

SetMaximumBurstSize(TUint32)

void SetMaximumBurstSize ( TUint32 aBurstSize ) [inline]

Set the maximum burst size used.

Parameters

TUint32 aBurstSize The maximum burst in bytes that can arrive or be transmitted at the peak data rate.

SetMaximumMsduSize(TUint16)

void SetMaximumMsduSize ( TUint16 aMsduSize ) [inline]

Set the maximum MSDU size used.

Parameters

TUint16 aMsduSize The maximum size of packets in bytes (0 - 0xFFFF).

SetMaximumServiceInterval(TUint32)

void SetMaximumServiceInterval ( TUint32 aServiceInterval ) [inline]

Set the maximum service interval used.

Parameters

TUint32 aServiceInterval The maximum interval between packets in microseconds.

SetMeanDataRate(TUint32)

void SetMeanDataRate ( TUint32 aRate ) [inline]

Set the average data rate used.

Parameters

TUint32 aRate The average data rate in bits per second used for packets belonging to this traffic stream.

SetMinimumDataRate(TUint32)

void SetMinimumDataRate ( TUint32 aRate ) [inline]

Set the minimum data rate used.

Parameters

TUint32 aRate The lowest data rate in bits per second used for packets belonging to this traffic stream.

SetMinimumPhyRate(TWlanRate)

void SetMinimumPhyRate ( TWlanRate aRate ) [inline]

Set the minimum WLAN data rate used.

Parameters

TWlanRate aRate The minimum WLAN data rate in bits per second used for this traffic stream.

SetMinimumServiceInterval(TUint32)

void SetMinimumServiceInterval ( TUint32 aServiceInterval ) [inline]

Set the minimum service interval used.

Parameters

TUint32 aServiceInterval The minimum interval between packets in microseconds.

SetNominalMsduSize(TUint16, TBool)

void SetNominalMsduSize ( TUint16 aMsduSize,
TBool aIsMsduSizeFixed
) [inline]

Set the nominal MSDU size used.

Parameters

TUint16 aMsduSize The nominal size of packets in bytes (0 - 0x7FFF).
TBool aIsMsduSizeFixed Whether the size of packets is fixed.

SetNominalPhyRate(TWlanRate)

void SetNominalPhyRate ( TWlanRate aRate ) [inline]

Set the nominal WLAN data rate used.

Parameters

TWlanRate aRate The nominal WLAN data rate in bits per second used for this traffic stream.

SetPeakDataRate(TUint32)

void SetPeakDataRate ( TUint32 aRate ) [inline]

Set the maximum data rate used.

Parameters

TUint32 aRate The maximum data rate in bits per second used for packets belonging to this traffic stream.

SetSba(TUint16)

void SetSba ( TUint16 aRatio ) [inline]

Set the SBA ratio used.

Parameters

TUint16 aRatio The excess ratio of actual over-the-air bandwidth to ideal bandwidth used for transporting packets belonging to this traffic stream.

SetServiceStartTime(TUint32)

void SetServiceStartTime ( TUint32 aServiceStartTime ) [inline]

Set the service start time used.

Parameters

TUint32 aServiceStartTime The time in microseconds when the service period starts.

SetSuspensionInterval(TUint32)

void SetSuspensionInterval ( TUint32 aSuspensionInterval ) [inline]

Set the suspension interval used.

Parameters

TUint32 aSuspensionInterval The minimum amount of microseconds that may elapse without arrival or transfer of packets belonging to this traffic stream before polling for the traffic stream is stopped.

SetTrafficType(TWlanTrafficStreamTrafficType)

void SetTrafficType ( TWlanTrafficStreamTrafficType aType ) [inline]

Set the traffic pattern used.

Parameters

TWlanTrafficStreamTrafficType aType Traffic pattern used.

Member Enumerations Documentation

Enum TWlanParameter

Bit definitions for parameters.

Enumerators

EWlanParameterNone = 0x00000000
EWlanParameterType = 0x00000001
EWlanParameterId = 0x00000002
EWlanParameterDirection = 0x00000004
EWlanParameterNominalMsduSize = 0x00000008
EWlanParameterMaximumMsduSize = 0x00000010
EWlanParameterMinimumServiceInterval = 0x00000020
EWlanParameterMaximumServiceInterval = 0x00000040
EWlanParameterInactivityInterval = 0x00000080
EWlanParameterSuspensionInterval = 0x00000100
EWlanParameterServiceStartTime = 0x00000200
EWlanParameterMinimumDataRate = 0x00000400
EWlanParameterMeanDataRate = 0x00000800
EWlanParameterPeakDataRate = 0x00001000
EWlanParameterMaximumBurstSize = 0x00002000
EWlanParameterDelayBound = 0x00004000
EWlanParameterMinimumPhyRate = 0x00008000
EWlanParameterNominalPhyRate = 0x00010000
EWlanParameterSba = 0x00020000
EWlanParameterIsRetryAllowed = 0x00040000

Member Data Documentation

TUint32 iDelayBound

TUint32 iDelayBound

Maximum transport delay used.

TWlanTrafficStreamDirection iDirection

TWlanTrafficStreamDirection iDirection

Traffic stream direction used.

TUint8 iId

TUint8 iId

Traffic stream ID used.

TUint32 iInactivityInterval

TUint32 iInactivityInterval

Inactivity interval used.

TBool iIsAutomaticRetryAllowed

TBool iIsAutomaticRetryAllowed

Whether re-creation of traffic streams is allowed.

TBool iIsMsduSizeFixed

TBool iIsMsduSizeFixed

Whether the size of packets is fixed.

TUint32 iMaximumBurstSize

TUint32 iMaximumBurstSize

Maximum burst size used.

TUint16 iMaximumMsduSize

TUint16 iMaximumMsduSize

Maximum MSDU size used.

TUint32 iMaximumServiceInterval

TUint32 iMaximumServiceInterval

Maximum service interval used.

TUint32 iMeanDataRate

TUint32 iMeanDataRate

Average data rate used.

TUint32 iMinimumDataRate

TUint32 iMinimumDataRate

Minimum data rate used.

TWlanRate iMinimumPhyRate

TWlanRate iMinimumPhyRate

Minimum WLAN data rate used.

TUint32 iMinimumServiceInterval

TUint32 iMinimumServiceInterval

Minimum service interval used.

TUint16 iNominalMsduSize

TUint16 iNominalMsduSize

Nominal MSDU size used.

TWlanRate iNominalPhyRate

TWlanRate iNominalPhyRate

Nominal WLAN data rate used.

TUint32 iParameterBitmap

TUint32 iParameterBitmap

Bitmap of parameters that have been set.

TUint32 iPeakDataRate

TUint32 iPeakDataRate

Maximum data rate used.

TUint16 iSba

TUint16 iSba

SBA ratio used.

TUint32 iServiceStartTime

TUint32 iServiceStartTime

Service start time used.

TUint32 iSuspensionInterval

TUint32 iSuspensionInterval

Suspension interval used.

TWlanTrafficStreamTrafficType iType

TWlanTrafficStreamTrafficType iType

Traffic pattern used.

TUint8 iUserPriority

TUint8 iUserPriority

User Priority used.

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.