Symbian^3 Application Developer Library >

TQoSParameters Class Reference

class TQoSParameters

Holds information on the parameters that define Quality of Service (QoS).

Public Member Functions
TQoSParameters ()
IMPORT_C TBool AdaptMode ()
IMPORT_C void Copy ( CExtension &)
TUint Flags ()
TInt GetDownLinkAveragePacketSize ()
TInt GetDownLinkDelay ()
TInt GetDownLinkMaximumBurstSize ()
TInt GetDownLinkMaximumPacketSize ()
TInt GetDownLinkPriority ()
TInt GetDownlinkBandwidth ()
IMPORT_C TBool GetHeaderMode ()
const TName & GetName ()
TInt GetUpLinkAveragePacketSize ()
TInt GetUpLinkDelay ()
TInt GetUpLinkMaximumBurstSize ()
TInt GetUpLinkMaximumPacketSize ()
TInt GetUpLinkPriority ()
TInt GetUplinkBandwidth ()
IMPORT_C void SetAdaptMode ( TBool )
IMPORT_C void SetDownLinkAveragePacketSize ( TInt )
IMPORT_C void SetDownLinkDelay ( TInt )
IMPORT_C void SetDownLinkMaximumBurstSize ( TInt )
IMPORT_C void SetDownLinkMaximumPacketSize ( TInt )
IMPORT_C void SetDownLinkPriority ( TInt )
IMPORT_C void SetDownlinkBandwidth ( TInt )
void SetFlags ( TUint )
IMPORT_C void SetHeaderMode ( TBool )
IMPORT_C TInt SetName (const TName &)
IMPORT_C void SetUpLinkAveragePacketSize ( TInt )
IMPORT_C void SetUpLinkDelay ( TInt )
IMPORT_C void SetUpLinkMaximumBurstSize ( TInt )
IMPORT_C void SetUpLinkMaximumPacketSize ( TInt )
IMPORT_C void SetUpLinkPriority ( TInt )
IMPORT_C void SetUplinkBandwidth ( TInt )
IMPORT_C TQoSParameters & operator= (const TQoSParameters &)
IMPORT_C TInt operator== (const TQoSParameters &)
Private Attributes
TInt iDownLinkAveragePacketSize
TInt iDownLinkDelay
TInt iDownLinkMaximumBurstSize
TInt iDownLinkMaximumPacketSize
TInt iDownLinkPriority
TInt iDownlinkBandwidth
TUint iFlags
TName iName
TInt iUpLinkAveragePacketSize
TInt iUpLinkDelay
TInt iUpLinkMaximumBurstSize
TInt iUpLinkMaximumPacketSize
TInt iUpLinkPriority
TInt iUplinkBandwidth

Constructor & Destructor Documentation

TQoSParameters()

IMPORT_C TQoSParameters ( )

Member Functions Documentation

AdaptMode()

IMPORT_C TBool AdaptMode ( ) const

Copy(CExtension &)

IMPORT_C void Copy ( CExtension & aExtension )

Parameters

CExtension & aExtension

Flags()

TUint Flags ( ) const [inline]

Gets the current flags.

GetDownLinkAveragePacketSize()

TInt GetDownLinkAveragePacketSize ( ) const [inline]

The minimum policed unit for downlink direction.

Minimum policed unit is used as the smallest packet size when doing traffic policing and estimating effect of protocol headers. The minimum policed unit must be <= maximum packet size.

GetDownLinkDelay()

TInt GetDownLinkDelay ( ) const [inline]

Gets the requested delay for downlink direction.

GetDownLinkMaximumBurstSize()

TInt GetDownLinkMaximumBurstSize ( ) const [inline]

Gets the token bucket size for downlink direction.

Token bucket size defines the burst size that the application may send.

GetDownLinkMaximumPacketSize()

TInt GetDownLinkMaximumPacketSize ( ) const [inline]

Gets the maximum packet size for downlink direction.

GetDownLinkPriority()

TInt GetDownLinkPriority ( ) const [inline]

Gets the priority for downlink direction. Priority can be used to prioritise between traffic flows inside the terminal.

GetDownlinkBandwidth()

TInt GetDownlinkBandwidth ( ) const [inline]

Gets the token rate for downlink direction.

Token rate defines the requested transfer rate that the application requests.

GetHeaderMode()

IMPORT_C TBool GetHeaderMode ( ) const

GetName()

const TName & GetName ( ) const [inline]

Gets a reference to the name.

GetUpLinkAveragePacketSize()

TInt GetUpLinkAveragePacketSize ( ) const [inline]

Gets the size of the minimum policed unit which is the smallest packet size for traffic policing.

GetUpLinkDelay()

TInt GetUpLinkDelay ( ) const [inline]

Gets the delay for uplink direction (in milliseconds).

GetUpLinkMaximumBurstSize()

TInt GetUpLinkMaximumBurstSize ( ) const [inline]

Gets the current size of the token bucket, that is the maximum number of tokens that the transfer can support.

GetUpLinkMaximumPacketSize()

TInt GetUpLinkMaximumPacketSize ( ) const [inline]

Gets the maximum uplink single packet size.

GetUpLinkPriority()

TInt GetUpLinkPriority ( ) const [inline]

Gets the uplink priority.

GetUplinkBandwidth()

TInt GetUplinkBandwidth ( ) const [inline]

Gets the current token rate for the uplink.

SetAdaptMode(TBool)

IMPORT_C void SetAdaptMode ( TBool aCanAdapt )

Parameters

TBool aCanAdapt

SetDownLinkAveragePacketSize(TInt)

IMPORT_C void SetDownLinkAveragePacketSize ( TInt aSize )

Parameters

TInt aSize

SetDownLinkDelay(TInt)

IMPORT_C void SetDownLinkDelay ( TInt aDelay )

Parameters

TInt aDelay

SetDownLinkMaximumBurstSize(TInt)

IMPORT_C void SetDownLinkMaximumBurstSize ( TInt aSize )

Parameters

TInt aSize

SetDownLinkMaximumPacketSize(TInt)

IMPORT_C void SetDownLinkMaximumPacketSize ( TInt aMaxSize )

Parameters

TInt aMaxSize

SetDownLinkPriority(TInt)

IMPORT_C void SetDownLinkPriority ( TInt aPriority )

Parameters

TInt aPriority

SetDownlinkBandwidth(TInt)

IMPORT_C void SetDownlinkBandwidth ( TInt aBandwidth )

Parameters

TInt aBandwidth

SetFlags(TUint)

void SetFlags ( TUint aFlags ) [inline]

Set the flags.

Currently the only flag supported is KPfqosOptionCanAdapt that indicates whether the aplication can adapt.

Parameters

TUint aFlags The flag values to set.

SetHeaderMode(TBool)

IMPORT_C void SetHeaderMode ( TBool aHeadersIncluded )

Parameters

TBool aHeadersIncluded

SetName(const TName &)

IMPORT_C TInt SetName ( const TName & aName )

Parameters

const TName & aName

SetUpLinkAveragePacketSize(TInt)

IMPORT_C void SetUpLinkAveragePacketSize ( TInt aSize )

Parameters

TInt aSize

SetUpLinkDelay(TInt)

IMPORT_C void SetUpLinkDelay ( TInt aDelay )

Parameters

TInt aDelay

SetUpLinkMaximumBurstSize(TInt)

IMPORT_C void SetUpLinkMaximumBurstSize ( TInt aSize )

Parameters

TInt aSize

SetUpLinkMaximumPacketSize(TInt)

IMPORT_C void SetUpLinkMaximumPacketSize ( TInt aMaxSize )

Parameters

TInt aMaxSize

SetUpLinkPriority(TInt)

IMPORT_C void SetUpLinkPriority ( TInt aPriority )

Parameters

TInt aPriority

SetUplinkBandwidth(TInt)

IMPORT_C void SetUplinkBandwidth ( TInt aBandwidth )

Parameters

TInt aBandwidth

operator=(const TQoSParameters &)

IMPORT_C TQoSParameters & operator= ( const TQoSParameters & aSpec )

Parameters

const TQoSParameters & aSpec

operator==(const TQoSParameters &)

IMPORT_C TInt operator== ( const TQoSParameters & aFlowSpec ) const

Parameters

const TQoSParameters & aFlowSpec

Member Data Documentation

TInt iDownLinkAveragePacketSize

TInt iDownLinkAveragePacketSize [private]

The size of the minimum policed packet for the downlink.

TInt iDownLinkDelay

TInt iDownLinkDelay [private]

The delay (in milliseconds) for the downlink.

TInt iDownLinkMaximumBurstSize

TInt iDownLinkMaximumBurstSize [private]

The token bucket size for the downlink.

TInt iDownLinkMaximumPacketSize

TInt iDownLinkMaximumPacketSize [private]

The maximum packet size for the downlink.

TInt iDownLinkPriority

TInt iDownLinkPriority [private]

The priority for the downlink.

TInt iDownlinkBandwidth

TInt iDownlinkBandwidth [private]

The token rate for the downlink.

TUint iFlags

TUint iFlags [private]

Internal represention of the flags.

TName iName

TName iName [private]

The name.

TInt iUpLinkAveragePacketSize

TInt iUpLinkAveragePacketSize [private]

The size of the minimum policed unit for the uplink.

TInt iUpLinkDelay

TInt iUpLinkDelay [private]

The delay (in milliseconds) for the uplink.

TInt iUpLinkMaximumBurstSize

TInt iUpLinkMaximumBurstSize [private]

The token bucket size for the uplink.

TInt iUpLinkMaximumPacketSize

TInt iUpLinkMaximumPacketSize [private]

The maximum packet size for the uplink.

TInt iUpLinkPriority

TInt iUpLinkPriority [private]

The priority for the uplink.

TInt iUplinkBandwidth

TInt iUplinkBandwidth [private]

The token rate for the uplink.

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.