Collapse all Symbian^3 Product Developer Library

TQoSSelector Class Reference

class TQoSSelector

Selector for QoS policies. The variables defined in TQoSSelector are used to find QoS policies for traffic flows. Not all variables have to be set, the application can specify the variables that it wants to. Note: TQoSSelector stores IPv4 addresses in "IPv4-mapped IPv6 address" format.

Public Member Functions
	TQoSSelector()
IMPORT_C TInetAddr	GetDst()
IMPORT_C TInetAddr	GetDstMask()
IMPORT_C TInetAddr	GetSrc()
IMPORT_C TInetAddr	GetSrcMask()
IMPORT_C TInt	IapId()
IMPORT_C TBool	Match(RSocket &)
IMPORT_C TUint	MaxPortDst()
IMPORT_C TUint	MaxPortSrc()
IMPORT_C TUint	Protocol()
IMPORT_C TInt	SetAddr(const TInetAddr &, const TInetAddr &, const TInetAddr &, const TInetAddr &, TUint, TUint, TUint)
IMPORT_C TInt	SetAddr(RSocket &)
IMPORT_C TInt	SetDst(const TInetAddr &)
IMPORT_C TInt	SetDstMask(const TInetAddr &)
IMPORT_C void	SetIapId(TInt)
IMPORT_C TInt	SetMaxPortDst(TUint)
IMPORT_C TInt	SetMaxPortSrc(TUint)
IMPORT_C void	SetProtocol(TUint)
IMPORT_C TInt	SetSrc(const TInetAddr &)
IMPORT_C TInt	SetSrcMask(const TInetAddr &)
IMPORT_C TInt	operator==(const TQoSSelector &)

Private Attributes
TInetAddr	iDst
TInetAddr	iDstMask
TUint	iDstPortMax
TUint	iIapId
TUint	iProtocol
TInetAddr	iSrc
TInetAddr	iSrcMask
TUint	iSrcPortMax

Constructor & Destructor Documentation

TQoSSelector()

IMPORT_C

TQoSSelector

(

)

Constructor. Initialises all variables to unspecified values.

Constructor.

Initialises all variables to specified, but null, values.

capability: NetworkControl Restrict QoS policy operations because they may affect several data flows.

Member Functions Documentation

GetDst()

IMPORT_C TInetAddr

GetDst

(

)

const

Returns the current destination address.

Gets the current destination address.

capability: NetworkControl Restrict QoS policy operations because they may affect several data flows.

GetDstMask()

IMPORT_C TInetAddr

GetDstMask

(

)

const

Returns the current destination address mask.

Gets the current destination address mask.

capability: NetworkControl Restrict QoS policy operations because they may affect several data flows.

GetSrc()

IMPORT_C TInetAddr

GetSrc

(

)

const

Returns the current source address.

Gets the current source address.

capability: NetworkControl Restrict QoS policy operations because they may affect several data flows.

GetSrcMask()

IMPORT_C TInetAddr

GetSrcMask

(

)

const

Returns the current source address mask.

Gets the current source address mask.

capability: NetworkControl Restrict QoS policy operations because they may affect several data flows.

IapId()

IMPORT_C TInt

IapId

(

)

const

Returns the current Internet access point identifier.

Gets the current Internet access point identifier.

capability: NetworkControl Restrict QoS policy operations because they may affect several data flows.

Match(RSocket &)

IMPORT_C TBool

Match

(

RSocket &

aSocket

)

const

Compares if the selector matches aSocket.

capability: NetworkControl Restrict QoS policy operations because they may affect several data flows.

Parameters

RSocket & aSocket

RSocket that is compared with this object.

MaxPortDst()

IMPORT_C TUint

MaxPortDst

(

)

const

Returns the maximum destination port.

Gets the maximum destination port.

capability: NetworkControl Restrict QoS policy operations because they may affect several data flows.

MaxPortSrc()

IMPORT_C TUint

MaxPortSrc

(

)

const

Returns the maximum source port.

Gets the maximum source port.

capability: NetworkControl Restrict QoS policy operations because they may affect several data flows.

Protocol()

IMPORT_C TUint

Protocol

(

)

const

Returns the current protocol identifier.

Gets the current protocol identifier.

capability: NetworkControl Restrict QoS policy operations because they may affect several data flows.

SetAddr(const TInetAddr &, const TInetAddr &, const TInetAddr &, const TInetAddr &, TUint, TUint, TUint)

IMPORT_C TInt	SetAddr	(	const TInetAddr &	aSrcAddr,
			const TInetAddr &	aSrcAddrMask,
			const TInetAddr &	aDstAddr,
			const TInetAddr &	aDstAddrMask,
			TUint	aProtocol,
			TUint	aSrcPortMax,
			TUint	aDstPortMax
		)

Sets the addresses for selector.

capability: NetworkControl Restrict QoS policy operations because they may affect several data flows.

Parameters

const TInetAddr & aSrcAddr	Source address. Port must have value <= 65535 (0 is used as uspecified value for a port).
const TInetAddr & aSrcAddrMask	Source address mask. Port must have value <= 65535 (0 is used as uspecified value for a port).
const TInetAddr & aDstAddr	Destination address. Port must have value <= 65535 (0 is used as uspecified value for a port).
const TInetAddr & aDstAddrMask	Destination address mask. Port must have value <= 65535 (0 is used as uspecified value for a port).
TUint aProtocol	Protocol ID.
TUint aSrcPortMax	Maximum source port. Must have value <= 65535 (0 is used as uspecified value for a port).
TUint aDstPortMax	Maximum destination port. Must have value <= 65535 (0 is used as uspecified value for a port).

SetAddr(RSocket &)

IMPORT_C TInt

SetAddr

(

RSocket &

aSocket

)

Sets the addresses for selector. RSocket is used to fetch addresses and ports for a selector. The resulting selector will match only for one socket. NOTE: RSocket::Connect() must be called before calling this method.

Sets the addresses for selector.

RSocket is used to fetch addresses and ports for a selector. The resulting selector will match only for one socket.

Note that RSocket::Connect() must be called before calling this function.

capability: NetworkControl Restrict QoS policy operations because they may affect several data flows.

Parameters

RSocket & aSocket

RSocket object that is used to set the selector variables. Note: RSocket must be connected

SetDst(const TInetAddr &)

IMPORT_C TInt

SetDst

(

const TInetAddr &

aAddr

)

Sets the destination address for selector.

capability: NetworkControl Restrict QoS policy operations because they may affect several data flows.

Parameters

const TInetAddr & aAddr

Destination address. Port must have value <= 65535 (0 is used as uspecified value for a port).

SetDstMask(const TInetAddr &)

IMPORT_C TInt

SetDstMask

(

const TInetAddr &

aMask

)

Sets the destination address mask.

capability: NetworkControl Restrict QoS policy operations because they may affect several data flows.

Parameters

const TInetAddr & aMask

Destination address mask. Port must have value <= 65535 (0 is used as uspecified value for a port).

SetIapId(TInt)

IMPORT_C void

SetIapId

(

TInt

aIapId

)

Sets the Internet access point identifier. 0 is used as unspecified value.

Sets the Internet access point identifier.

0 is used as unspecified value.

capability: NetworkControl Restrict QoS policy operations because they may affect several data flows.

Parameters

TInt aIapId

Value to which to set the IapId.

SetMaxPortDst(TUint)

IMPORT_C TInt

SetMaxPortDst

(

TUint

aMaxPort

)

Sets the maximum destination port. Port must have value <= 65535 (0 is used as unspecified value).

Sets the maximum destination port.

Port must have value <= 65535 (0 is used as unspecified value).

capability: NetworkControl Restrict QoS policy operations because they may affect several data flows.

Parameters

TUint aMaxPort

Value to which to set maximum destination port.

SetMaxPortSrc(TUint)

IMPORT_C TInt

SetMaxPortSrc

(

TUint

aMaxPort

)

Sets the maximum source port. Port must have value <= 65535 (0 is used as unspecified value).

Sets the maximum source port.

Port must have value <= 65535 (0 is used as unspecified value).

capability: NetworkControl Restrict QoS policy operations because they may affect several data flows.

Parameters

TUint aMaxPort

Value to which to set maximum source port.

SetProtocol(TUint)

IMPORT_C void

SetProtocol

(

TUint

aProtocol

)

Sets the protocol identifier. 0 is used as unspecified value.

Sets the protocol identifier.

0 is used as unspecified value.

capability: NetworkControl Restrict QoS policy operations because they may affect several data flows.

Parameters

TUint aProtocol

Value to which to set the protocol ID.

SetSrc(const TInetAddr &)

IMPORT_C TInt

SetSrc

(

const TInetAddr &

aAddr

)

Sets the source address for selector.

capability: NetworkControl Restrict QoS policy operations because they may affect several data flows.

Parameters

const TInetAddr & aAddr

Source address. Port must have value <= 65535 (0 is used as uspecified value for a port).

SetSrcMask(const TInetAddr &)

IMPORT_C TInt

SetSrcMask

(

const TInetAddr &

aMask

)

Sets the source address mask.

capability: NetworkControl Restrict QoS policy operations because they may affect several data flows.

Parameters

const TInetAddr & aMask

Source address mask. Port must have value <= 65535 (0 is used as uspecified value for a port).

operator==(const TQoSSelector &)

IMPORT_C TInt

operator==

(

const TQoSSelector &

aSelector

)

const

Compares if the selectors are equal.

capability: NetworkControl Restrict QoS policy operations because they may affect several data flows.

Parameters

const TQoSSelector & aSelector

TQoSSelector object that is compared with this object.

Member Data Documentation

TInetAddr iDst

TInetAddr

iDst

[private]

The destination address.

TInetAddr iDstMask

TInetAddr

iDstMask

[private]

The destination address mask.

TUint iDstPortMax

TUint

iDstPortMax

[private]

The maximum destination port.

TUint iIapId

TUint

iIapId

[private]

The Internet access point identifier.

TUint iProtocol

TUint

iProtocol

[private]

The protocol ID.

TInetAddr iSrc

TInetAddr

iSrc

[private]

The source address.

TInetAddr iSrcMask

TInetAddr

iSrcMask

[private]

The source address mask.

TUint iSrcPortMax

TUint

iSrcPortMax

[private]

The maximum source port.