Collapse all Symbian^3 Application Developer Library

ESock::TAvailabilitySubscriptionOptions Struct Reference

struct ESock::TAvailabilitySubscriptionOptions

Collection of options used to register to availability notifications

Public Member Functions
	TAvailabilitySubscriptionOptions ( TBool , TUint , TUint , TUint , TUint )
	TAvailabilitySubscriptionOptions ( TChangeScopeFlags )
TBool	IsChangeSignificant (const TAvailabilityStatus &, const TAvailabilityStatus &)

Private Member Functions
TBool	ShouldNotifyAnyChange (const TAvailabilityStatus &, const TAvailabilityStatus &)
TBool	ShouldNotifyScoreDecreasesByMoreThan (const TAvailabilityStatus &, const TAvailabilityStatus &)
TBool	ShouldNotifyScoreDropsBelow (const TAvailabilityStatus &, const TAvailabilityStatus &)
TBool	ShouldNotifyScoreExceeds (const TAvailabilityStatus &, const TAvailabilityStatus &)
TBool	ShouldNotifyScoreIncreasesByMoreThan (const TAvailabilityStatus &, const TAvailabilityStatus &)

Public Member Enumerations
enum	TChangeScopeFlags { ENotAnyChange = 0, EAnyChange , EAnyNestedChange }

Private Attributes
TUint	iFlags
TUint	iScoreDecreasesByMoreThan
TUint	iScoreDropsBelow
TUint	iScoreExceeds
TUint	iScoreIncreasesByMoreThan

Constructor & Destructor Documentation

TAvailabilitySubscriptionOptions(TBool, TUint, TUint, TUint, TUint)

TAvailabilitySubscriptionOptions	(	TBool	aAnyChange = ETrue,
		TUint	aScoreExceeds = 0,
		TUint	aScoreDropsBelow = 0,
		TUint	aScoreIncreasesByMoreThan = 0,
		TUint	aScoreDecreasesByMoreThan = 0
	)	[inline]

Parameters

TBool aAnyChange = ETrue	If ETrue, notify on all changes in the calculated availability. If EFalse, use following parameters to decide what to notify on.
TUint aScoreExceeds = 0	Notify if availability score exceeds this
TUint aScoreDropsBelow = 0	Notify if availability score drops below this
TUint aScoreIncreasesByMoreThan = 0	Notify if availability score increased by more than this
TUint aScoreDecreasesByMoreThan = 0

TAvailabilitySubscriptionOptions(TChangeScopeFlags)

TAvailabilitySubscriptionOptions

(

TChangeScopeFlags

aFlags

)

[inline]

TChangeScopeFlags .

Parameters

TChangeScopeFlags aFlags

Member Functions Documentation

IsChangeSignificant(const TAvailabilityStatus &, const TAvailabilityStatus &)

TBool	IsChangeSignificant	(	const TAvailabilityStatus &	aReported,
			const TAvailabilityStatus &	aNew
		)	const [inline]

Parameters

const TAvailabilityStatus & aReported	Currently reported availability
const TAvailabilityStatus & aNew	Newly reported availability

ShouldNotifyAnyChange(const TAvailabilityStatus &, const TAvailabilityStatus &)

TBool	ShouldNotifyAnyChange	(	const TAvailabilityStatus &	aReported,
			const TAvailabilityStatus &	aNew
		)	const [private, inline]

Parameters

const TAvailabilityStatus & aReported
const TAvailabilityStatus & aNew

ShouldNotifyScoreDecreasesByMoreThan(const TAvailabilityStatus &, const TAvailabilityStatus &)

TBool	ShouldNotifyScoreDecreasesByMoreThan	(	const TAvailabilityStatus &	aReported,
			const TAvailabilityStatus &	aNew
		)	const [private, inline]

Parameters

const TAvailabilityStatus & aReported
const TAvailabilityStatus & aNew

ShouldNotifyScoreDropsBelow(const TAvailabilityStatus &, const TAvailabilityStatus &)

TBool	ShouldNotifyScoreDropsBelow	(	const TAvailabilityStatus &	aReported,
			const TAvailabilityStatus &	aNew
		)	const [private, inline]

Parameters

const TAvailabilityStatus & aReported
const TAvailabilityStatus & aNew

ShouldNotifyScoreExceeds(const TAvailabilityStatus &, const TAvailabilityStatus &)

TBool	ShouldNotifyScoreExceeds	(	const TAvailabilityStatus &	aReported,
			const TAvailabilityStatus &	aNew
		)	const [private, inline]

Parameters

const TAvailabilityStatus & aReported
const TAvailabilityStatus & aNew

ShouldNotifyScoreIncreasesByMoreThan(const TAvailabilityStatus &, const TAvailabilityStatus &)

TBool	ShouldNotifyScoreIncreasesByMoreThan	(	const TAvailabilityStatus &	aReported,
			const TAvailabilityStatus &	aNew
		)	const [private, inline]

Parameters

const TAvailabilityStatus & aReported
const TAvailabilityStatus & aNew

Member Enumerations Documentation

Enum TChangeScopeFlags

Subscription option flags: ENotAnyChange - the client is specifying availability score thresholds he wishes to be notified on crossing; EAnyChange - the client is interestes in any change in the availability. Only change in calculated score will be reported. EAnyNestedChamge - the client is interested in any change in the availability even if it does not affect the calculated score e.g.: one of many available access points ceases to be available (and doesn't affect the score calculated against the remaning access points)