Symbian^3 Product 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
enumTChangeScopeFlags { 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(TBoolaAnyChange = ETrue,
TUintaScoreExceeds = 0,
TUintaScoreDropsBelow = 0,
TUintaScoreIncreasesByMoreThan = 0,
TUintaScoreDecreasesByMoreThan = 0
)[inline]

Parameters

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

TAvailabilitySubscriptionOptions(TChangeScopeFlags)

TAvailabilitySubscriptionOptions(TChangeScopeFlagsaFlags)[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 & aReportedCurrently reported availability
const TAvailabilityStatus & aNewNewly 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)

Enumerators

ENotAnyChange = 0
EAnyChange
EAnyNestedChange

Member Data Documentation

TUint iFlags

TUint iFlags[private]

TUint iScoreDecreasesByMoreThan

TUint iScoreDecreasesByMoreThan[private]

TUint iScoreDropsBelow

TUint iScoreDropsBelow[private]

TUint iScoreExceeds

TUint iScoreExceeds[private]

TUint iScoreIncreasesByMoreThan

TUint iScoreIncreasesByMoreThan[private]

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.