Collapse all Symbian^3 Application Developer Library

CQoSParameters Class Reference

class CQoSParameters : public CBase

This class contains the generic QoS parameters and optional extensions.

Inherits from

CQoSParameters
- CBase

Public Member Functions
	CQoSParameters ()
	~CQoSParameters ()
IMPORT_C TBool	AdaptMode ()
IMPORT_C TInt	AddExtensionL ( CExtensionBase &)
IMPORT_C void	CopyL ( CQoSParameters &)
IMPORT_C TQoSExtensionQueue &	Extensions ()
IMPORT_C CExtensionBase *	FindExtension ( TInt )
IMPORT_C TInt	GetDownLinkAveragePacketSize ()
IMPORT_C TInt	GetDownLinkDelay ()
IMPORT_C TInt	GetDownLinkDelayVariation ()
IMPORT_C TInt	GetDownLinkMaximumBurstSize ()
IMPORT_C TInt	GetDownLinkMaximumPacketSize ()
IMPORT_C TInt	GetDownLinkPriority ()
IMPORT_C TInt	GetDownlinkBandwidth ()
IMPORT_C TBool	GetHeaderMode ()
IMPORT_C const TName &	GetName ()
IMPORT_C TInt	GetUpLinkAveragePacketSize ()
IMPORT_C TInt	GetUpLinkDelay ()
IMPORT_C TInt	GetUpLinkDelayVariation ()
IMPORT_C TInt	GetUpLinkMaximumBurstSize ()
IMPORT_C TInt	GetUpLinkMaximumPacketSize ()
IMPORT_C TInt	GetUpLinkPriority ()
IMPORT_C TInt	GetUplinkBandwidth ()
IMPORT_C TInt	RemoveExtension ( TInt )
IMPORT_C void	SetAdaptMode ( TBool )
IMPORT_C void	SetDownLinkAveragePacketSize ( TInt )
IMPORT_C void	SetDownLinkDelay ( TInt )
IMPORT_C void	SetDownLinkDelayVariation ( TInt )
IMPORT_C void	SetDownLinkMaximumBurstSize ( TInt )
IMPORT_C void	SetDownLinkMaximumPacketSize ( TInt )
IMPORT_C void	SetDownLinkPriority ( TInt )
IMPORT_C void	SetDownlinkBandwidth ( TInt )
IMPORT_C void	SetHeaderMode ( TBool )
IMPORT_C void	SetName (const TName &)
IMPORT_C void	SetUpLinkAveragePacketSize ( TInt )
IMPORT_C void	SetUpLinkDelay ( TInt )
IMPORT_C void	SetUpLinkDelayVariation ( TInt )
IMPORT_C void	SetUpLinkMaximumBurstSize ( TInt )
IMPORT_C void	SetUpLinkMaximumPacketSize ( TInt )
IMPORT_C void	SetUpLinkPriority ( TInt )
IMPORT_C void	SetUplinkBandwidth ( TInt )

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
TQoSExtensionQueue	iExtensionList
TName	iName
TQoSParameters	iQoS

Constructor & Destructor Documentation

CQoSParameters()

IMPORT_C

CQoSParameters

(

)

Constructor.

Default constructor.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

~CQoSParameters()

IMPORT_C

~CQoSParameters

(

)

Destructor.

Deletes all extensions.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

Member Functions Documentation

AdaptMode()

IMPORT_C TBool

AdaptMode

(

)

const

Returns the adaptation mode.

Gets the adaptation mode.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

AddExtensionL(CExtensionBase &)

IMPORT_C TInt

AddExtensionL

(

CExtensionBase &

aExtension

)

Copies the extension into the list of extensions. If there already exists an extension with the same type, it is replaced.

Exceptions

Leaves

if there is no memory available for the extension.

Copies the extension into the list of extensions.

If there already exists an extension with the same type, it is replaced.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

leave: If there is no memory available for the extension.

Parameters

CExtensionBase & aExtension

The extension that is added to the list of extenstions.

CopyL(CQoSParameters &)

IMPORT_C void

CopyL

(

CQoSParameters &

aPolicy

)

Copies the parameters and extensions from aPolicy into this object.

Exceptions

Leaves

if there is no memory available for extensions.

Copies the parameters and extensions from aFlowSpec into this object.

Any existing extensions are deleted.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

leave: If there is no memory available for extensions.

Parameters

CQoSParameters & aPolicy

Contains the CQoSParameters object that is copied into this object.

Extensions()

IMPORT_C TQoSExtensionQueue &

Extensions

(

)

Returns a list of extensions that have been added to this object.

Gets a list of extensions that have been added to this object.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

FindExtension(TInt)

IMPORT_C CExtensionBase *

FindExtension

(

TInt

aType

)

Returns an extension with extension type aType.

Gets an extension with the specified extension type.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

Parameters

TInt aType

The type of extension that is to be searched for from the list of extensions.

GetDownLinkAveragePacketSize()

IMPORT_C TInt

GetDownLinkAveragePacketSize

(

)

const

Returns the average packet size for downlink direction. Average packet size is used as the smallest packet size when doing traffic policing and estimating effect of protocol headers.

Gets the average packet size for downlink direction.

Average packet size is used when doing traffic policing and estimating effect of protocol headers.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

GetDownLinkDelay()

IMPORT_C TInt

GetDownLinkDelay

(

)

const

Returns the delay for downlink direction.

Gets the delay for downlink direction.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

GetDownLinkDelayVariation()

IMPORT_C TInt

GetDownLinkDelayVariation

(

)

const

GetDownLinkMaximumBurstSize()

IMPORT_C TInt

GetDownLinkMaximumBurstSize

(

)

const

Returns the maximum burst size for downlink direction. Maximum burst size defines the burst size that the application might send.

Gets the maximum burst size for downlink direction.

Maximum burst size defines the burst size that the application might send.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

GetDownLinkMaximumPacketSize()

IMPORT_C TInt

GetDownLinkMaximumPacketSize

(

)

const

Returns the maximum packet size for downlink direction.

Gets the maximum packet size for downlink direction.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

GetDownLinkPriority()

IMPORT_C TInt

GetDownLinkPriority

(

)

const

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

Gets the priority for downlink direction.

Priority can be used to prioritise between traffic flows inside the terminal.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

GetDownlinkBandwidth()

IMPORT_C TInt

GetDownlinkBandwidth

(

)

const

Returns the bandwidth for downlink direction. Bandwidth defines the requested transfer rate that the application requests.

Gets the bandwidth for downlink direction.

Bandwidth defines the requested transfer rate that the application requests.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

GetHeaderMode()

IMPORT_C TBool

GetHeaderMode

(

)

const

Returns the headers included mode.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

GetName()

IMPORT_C const TName &

GetName

(

)

const

Returns the name of the flowspec.

Gets the name of the flowspec.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

GetUpLinkAveragePacketSize()

IMPORT_C TInt

GetUpLinkAveragePacketSize

(

)

const

Returns the average packet size for uplink direction. Average packet size is used when doing traffic policing and estimating effect of protocol headers.

Gets the average packet size for uplink direction.

Average packet size is used when doing traffic policing and estimating effect of protocol headers.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

GetUpLinkDelay()

IMPORT_C TInt

GetUpLinkDelay

(

)

const

Returns the delay for uplink direction.

Gets the delay for uplink direction.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

GetUpLinkDelayVariation()

IMPORT_C TInt

GetUpLinkDelayVariation

(

)

const

GetUpLinkMaximumBurstSize()

IMPORT_C TInt

GetUpLinkMaximumBurstSize

(

)

const

Returns the maximum burst size for uplink direction. Maximum burst size defines the burst size that the application might send.

Gets the maximum burst size for uplink direction.

Maximum burst size defines the burst size that the application might send.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

GetUpLinkMaximumPacketSize()

IMPORT_C TInt

GetUpLinkMaximumPacketSize

(

)

const

Returns the maximum packet size for uplink direction.

Gets the maximum packet size for uplink direction.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

GetUpLinkPriority()

IMPORT_C TInt

GetUpLinkPriority

(

)

const

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

Gets the priority for uplink direction.

Priority can be used to prioritise between traffic flows inside the terminal.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

GetUplinkBandwidth()

IMPORT_C TInt

GetUplinkBandwidth

(

)

const

Returns the bandwidth for uplink direction. Bandwidth defines the requested transfer rate that the application requests.

Gets the bandwidth for uplink direction.

Bandwidth defines the requested transfer rate that the application requests.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

RemoveExtension(TInt)

IMPORT_C TInt

RemoveExtension

(

TInt

aType

)

Removes the extension with extension type aType from the list of extensions.

Removes the extension with the specified extension type from the list of extensions.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

Parameters

TInt aType

The type of extension to be removed from the list of extensions.

SetAdaptMode(TBool)

IMPORT_C void

SetAdaptMode

(

TBool

aCanAdapt

)

Sets the adaptation mode. If the application is willing to accept lower QoS than requested, it should set the adapt mode on. By default adapt mode is not set.

Sets the adaptation mode.

If the application is willing to accept lower QoS than requested, it should set the adapt mode on. By default adapt mode is not set.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

Parameters

TBool aCanAdapt

The value for adapt mode.

SetDownLinkAveragePacketSize(TInt)

IMPORT_C void

SetDownLinkAveragePacketSize

(

TInt

aSize

)

Sets the average packet size for downlink direction. Average packet size is used as the smallest packet size when doing traffic policing and estimating effect of protocol headers. The average packet size must be <= maximum packet size.

Sets the average packet size for downlink direction.

Average packet size is used when doing traffic policing and estimating effect of protocol headers. The average packet size must be <= maximum packet size.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

Parameters

TInt aSize

Value (in bytes) to which to set the average packet size for downlink direction.

SetDownLinkDelay(TInt)

IMPORT_C void

SetDownLinkDelay

(

TInt

aDelay

)

Sets the requested delay for downlink direction.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

Parameters

TInt aDelay

Value (in milliseconds) to which to set the delay for downlink direction.

SetDownLinkDelayVariation(TInt)

IMPORT_C void

SetDownLinkDelayVariation

(

TInt

aVariation

)

Parameters

TInt aVariation

SetDownLinkMaximumBurstSize(TInt)

IMPORT_C void

SetDownLinkMaximumBurstSize

(

TInt

aSize

)

Sets the maximum burst size for downlink direction. Maximum burst size defines the burst size that the application might send. Maximum burst size must be > 0.

Sets the maximum burst size for downlink direction.

Maximum burst size defines the burst size that the application might send. Maximum burst size must be > 0.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

Parameters

TInt aSize

Value (in bytes) to which to set the maximum burst size for downlink direction.

SetDownLinkMaximumPacketSize(TInt)

IMPORT_C void

SetDownLinkMaximumPacketSize

(

TInt

aMaxSize

)

Sets the maximum packet size for downlink direction.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

Parameters

TInt aMaxSize

Value (in bytes) to which to set the maximum packet size for downlink direction.

SetDownLinkPriority(TInt)

IMPORT_C void

SetDownLinkPriority

(

TInt

aPriority

)

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

Sets the priority for downlink direction.

Priority can be used to prioritise between traffic flows inside the terminal.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

Parameters

TInt aPriority

Value (0-7) to which to set the priority for downlink direction: 0 is the highest priority, 7 is lowest.

SetDownlinkBandwidth(TInt)

IMPORT_C void

SetDownlinkBandwidth

(

TInt

aBandwidth

)

Sets the bandwidth for downlink direction. Bandwidth defines the requested transfer rate that the application requests. Bandwidth must be > 0.

Sets the bandwidth for downlink direction.

Bandwidth defines the requested transfer rate that the application requests. Bandwidth must be > 0.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

Parameters

TInt aBandwidth

Value (in bytes/second) to which to set the bandwidth for downlink direction.

SetHeaderMode(TBool)

IMPORT_C void

SetHeaderMode

(

TBool

aHeadersIncluded

)

Sets the header mode. If the application wants QoS Framework to include network and transport layer header values in bitrate calcutaions or not. By default the mode is set to include the headers in the calculations. Protocols such as RTSP or SIP, which already include the header sizes in their calculations will want to alter the mode so that header values are not included in calculations twice.

Sets the header mode. If the application wants QoS Framework to include network and transport layer header values in bitrate calculations or not. By default the mode is set to include the headers in the calculations. Protocols such as RTSP or SIP, which already include the header sizes in their calculations will want to alter the mode so that header values are not included in calculations twice.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

Parameters

TBool aHeadersIncluded

The value for header mode.

SetName(const TName &)

IMPORT_C void

SetName

(

const TName &

aName

)

Sets the name of the flowspec. This allows application to specify a user friendly name for a flowspec.

Sets the name of the flowspec.

This allows application to specify a user friendly name for a flowspec.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

Parameters

const TName & aName

The name for the flowspec. Maximum length for the name is KMaxName.

SetUpLinkAveragePacketSize(TInt)

IMPORT_C void

SetUpLinkAveragePacketSize

(

TInt

aSize

)

Sets the average packet size for uplink direction. Average packet size is used when doing traffic policing and estimating effect of protocol headers. The average packet size must be <= maximum packet size.

Sets the average packet size for uplink direction.

Average packet size is used when doing traffic policing and estimating effect of protocol headers. The average packet size must be <= maximum packet size.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

Parameters

TInt aSize

Value (in bytes) to which to set the average packet size for uplink direction.

SetUpLinkDelay(TInt)

IMPORT_C void

SetUpLinkDelay

(

TInt

aDelay

)

Sets the requested delay for uplink direction.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

Parameters

TInt aDelay

Value (in milliseconds) to which to set the delay for uplink direction.

SetUpLinkDelayVariation(TInt)

IMPORT_C void

SetUpLinkDelayVariation

(

TInt

aVariation

)

Parameters

TInt aVariation

SetUpLinkMaximumBurstSize(TInt)

IMPORT_C void

SetUpLinkMaximumBurstSize

(

TInt

aSize

)

Sets the maximum burst size for uplink direction. Maximum burst size defines the burst size that the application might send. Maximum burst size must be > 0.

Sets the maximum burst size for uplink direction.

Maximum burst size defines the burst size that the application might send. Maximum burst size must be > 0.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

Parameters

TInt aSize

Value (in bytes) to which to set the maximum burst size for uplink direction.

SetUpLinkMaximumPacketSize(TInt)

IMPORT_C void

SetUpLinkMaximumPacketSize

(

TInt

aMaxSize

)

Sets the maximum packet size for uplink direction.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

Parameters

TInt aMaxSize

Value (in bytes) to which to set the maximum packet size for uplink direction.

SetUpLinkPriority(TInt)

IMPORT_C void

SetUpLinkPriority

(

TInt

aPriority

)

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

Sets the priority for uplink direction.

Priority can be used to prioritise between traffic flows inside the terminal.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

Parameters

TInt aPriority

Value (0-7) to which to set the priority for uplink direction: 0 is the highest priority, 7 is lowest.

SetUplinkBandwidth(TInt)

IMPORT_C void

SetUplinkBandwidth

(

TInt

aBandwidth

)

Sets the bandwidth for uplink direction. Bandwidth defines the requested transfer rate that the application requests. Bandwidth must be > 0.

Sets the bandwidth for uplink direction.

Bandwidth defines the requested transfer rate that the application requests. Bandwidth must be > 0.

capability: NetworkServices Restrict QoS operations in similar way as normal socket operations.

Parameters

TInt aBandwidth

Value (in bytes/second) to which to set the bandwidth for uplink direction.

Member Data Documentation

TQoSExtensionQueue iExtensionList

TQoSExtensionQueue

iExtensionList

[private]

A list of extensions.

TName iName

TName

iName

[private]

TQoSParameters iQoS

TQoSParameters

iQoS

[private]

Generic QoS parameters.