nConfItemVersionWatcher Class Reference

configuration item watcher that shuts out clients that don't support a certain interface More...

#include <nConfig.h>

Inheritance diagram for nConfItemVersionWatcher:

[legend]

Collaboration diagram for nConfItemVersionWatcher:

[legend]

List of all members.

Public Types
enum	Group {   Group_Breaking, Group_Bumpy, Group_Annoying, Group_Cheating,   Group_Visual, Group_Max }
	enum describing the effect a nondefault setting has on clients that don't support it More...
typedef nConfigItemBehavior	Behavior
Public Member Functions
	nConfItemVersionWatcher (nConfItemBase &item, Group group, int min, int max=-1)
	constructor
virtual	~nConfItemVersionWatcher ()
	destructor
Behavior	GetBehavior (void) const
	Gets behavior if this setting is on non-default and a client that does not support it connects.
nConfItemVersionWatcher const &	GetBehavior (Behavior &behavior) const
	Gets behavior if this setting is on non-default and a client that does not support it connects.
void	FillTemplateParameters (tOutput &o) const
	fills output with template parameters about the setting
Static Public Member Functions
static void	AdaptVersion (nVersion &version)
	adapt version so it is compatible with all settings
static void	OnVersionChange (nVersion const &version)
	revert relevant settings that don't fit with the version to their defaults
Private Member Functions
virtual void	OnChange (bool nonDefault)
	called on configuration item changes
virtual bool	DoWritable () const
	returns whether the item should be writable
Private Attributes
nVersion	version_
	the versions that support this
bool	nonDefault_
	flag memorizing whether the setting is at default by the user
bool	reverted_
	flag memorizing whether the setting has been reverted to the default temporarily
Group	group_
	class of incompatibility
Behavior	overrideGroupBehavior_
	if set, the global behavior for the class gets ignored
tSettingItem< Behavior >	overrideGroupBehaviorConf_
	setting item for override

---

Detailed Description

configuration item watcher that shuts out clients that don't support a certain interface

Definition at line 230 of file nConfig.h.

---

Member Typedef Documentation

typedef nConfigItemBehavior nConfItemVersionWatcher::Behavior

Definition at line 245 of file nConfig.h.

---

Member Enumeration Documentation

enum nConfItemVersionWatcher::Group

enum describing the effect a nondefault setting has on clients that don't support it

Enumerator:

Group_Breaking	client breaks horribly
Group_Bumpy	client works, but physics are not simulated correctly
Group_Annoying	small, annoying incompatibility
Group_Cheating	the behavior of the old client is considered cheating
Group_Visual	some displayed value is wrong, but everything behaves right
Group_Max

Definition at line 234 of file nConfig.h.

    {
        Group_Breaking,  
        Group_Bumpy,     
        Group_Annoying,  
        Group_Cheating,  
        Group_Visual,    

        Group_Max
    };

---

Constructor & Destructor Documentation

nConfItemVersionWatcher::nConfItemVersionWatcher	(	nConfItemBase &	item,
		Group	c,
		int	min,
		int	max = -1
	)

constructor

Parameters:

	item
	feature

Definition at line 378 of file nConfig.cpp.

References sn_GetStrongWatchers(), and sn_StrongWatchersAddRef().

        : nIConfItemWatcher( item )
        , version_( min, max > 0 ? max : 0x7FFFFFFF )
        , nonDefault_( false )
        , reverted_( false )
        , group_( c )
        , overrideGroupBehavior_( Behavior_Default )
        , overrideGroupBehaviorConf_( item.GetTitle() + "_OVERRIDE", overrideGroupBehavior_ )
{
    sn_StrongWatchersAddRef();
    sn_GetStrongWatchers().insert(this);
}

Here is the call graph for this function:

nConfItemVersionWatcher::~nConfItemVersionWatcher

(

void

)

[virtual]

destructor

Definition at line 400 of file nConfig.cpp.

References sn_GetStrongWatchers(), and sn_StrongWatchersRelease().

{
    sn_GetStrongWatchers().erase(this);
    sn_StrongWatchersRelease();
}

Here is the call graph for this function:

---

Member Function Documentation

void nConfItemVersionWatcher::AdaptVersion

(

nVersion &

version

)

[static]

adapt version so it is compatible with all settings

Definition at line 489 of file nConfig.cpp.

References Behavior_Block, con, FillTemplateParameters(), GetBehavior(), nVersion::Merge(), nVersion::Min(), nonDefault_, nSERVER, sn_GetNetState(), sn_GetStrongWatchers(), tVERIFY, and version_.

{
    if ( sn_GetNetState() != nSERVER )
        return;

    // iterate over all watchers
    nStrongWatcherList & watchers = sn_GetStrongWatchers();
    for ( nStrongWatcherList::iterator iter = watchers.begin(); iter != watchers.end(); ++iter )
    {
        nConfItemVersionWatcher * run = *iter;

        // adapt version to needs
        if ( run->nonDefault_ && run->GetBehavior() >= Behavior_Block )
        {
            tVERIFY( version.Merge( version, run->version_ ) );
            if ( version.Min() > lastVersion.Min() )
            {
                // inform user about potential problem
                tOutput o;
                run->FillTemplateParameters(o);
                o << "$setting_legacy_clientblock";
                con << o;

                lastVersion = version;
            }
        }
    }
}

Here is the call graph for this function:

void nConfItemVersionWatcher::OnVersionChange

(

nVersion const &

version

)

[static]

revert relevant settings that don't fit with the version to their defaults

Parameters:

version

the version to adapt the settings to

Definition at line 528 of file nConfig.cpp.

References Behavior_Block, Behavior_Default, Behavior_Nothing, Behavior_Revert, con, FillTemplateParameters(), GetBehavior(), group_, Group_Max, inited, nVersion::Max(), nVersion::Min(), nonDefault_, nSERVER, reverted_, nConfItemBase::RevertToDefaults(), nConfItemBase::RevertToSavedValue(), nConfItemBase::SaveValue(), sn_GetNetState(), sn_GetStrongWatchers(), sn_MyVersion(), version_, and nIConfItemWatcher::watched_.

{
    // store version for reference
    lastVersion = version;

    if ( sn_GetNetState() != nSERVER )
        return;

    // iterate over all watchers
    nStrongWatcherList & watchers = sn_GetStrongWatchers();
    for ( nStrongWatcherList::iterator iter = watchers.begin(); iter != watchers.end(); ++iter )
    {
        nConfItemVersionWatcher * run = *iter;

        // warn about settings that will revert or be ignored
        Behavior behavior = run->GetBehavior();
        if (run->nonDefault_ && behavior != Behavior_Block )
        {
            // don't warn twice for the same group and behavior
            static int warnedRevert[ Behavior_Default ][ Group_Max ];
            {
                static bool inited = false;
                if (!inited)
                {
                    inited = true;
                    for ( int i = Behavior_Default-1; i>=0; --i )
                        for ( int j = Group_Max-1; j>=0; --j )
                            warnedRevert[i][j] = sn_MyVersion().Min();
                }
            }
            int & warned = warnedRevert[ behavior ][ run->group_ ];

            if ( warned < run->version_.Min() && run->version_.Min() > version.Min() )
            {
                warned = run->version_.Min();

                // inform user about potential problem with nondefault settings
                tOutput o;
                run->FillTemplateParameters(o);
                o << ( ( behavior == Behavior_Revert ) ? "$setting_legacy_revert" : "$setting_legacy_ignore" );
                con << o;
            }
        }

        // ignore settings where this is desired
        if ( run->GetBehavior() == Behavior_Nothing )
            continue;

        // if version is supported..
        if ( run->version_.Min() <= version.Max() )
        {
            // ...restore saved value of config item
            if ( run->reverted_ )
            {
                run->reverted_ = false;
                run->watched_.RevertToSavedValue();
            }
        }
        else
        {
            // version is not supported. Revert to defaults.
            if ( !run->reverted_ && run->nonDefault_ )
            {
                run->reverted_ = true;
                run->watched_.SaveValue();
                run->watched_.RevertToDefaults();
            }
        }

    }
}

Here is the call graph for this function:

nConfItemVersionWatcher::Behavior nConfItemVersionWatcher::GetBehavior

(

void

)

const

Gets behavior if this setting is on non-default and a client that does not support it connects.

Returns:

behavior if this setting is on non-default and a client that does not support it connects

Definition at line 625 of file nConfig.cpp.

References Behavior_Default, group_, Group_Max, overrideGroupBehavior_, sn_GroupBehaviors, and tASSERT.

Referenced by AdaptVersion(), DoWritable(), GetBehavior(), and OnVersionChange().

{
    // look up default behavior
    tASSERT( 0 <= group_ && group_ < nConfItemVersionWatcher::Group_Max );
    Behavior behavior = sn_GroupBehaviors[ group_ ];

    // override it
    if ( Behavior_Default != this->overrideGroupBehavior_ )
        behavior = this->overrideGroupBehavior_;

    return behavior;
}

Here is the caller graph for this function:

nConfItemVersionWatcher const & nConfItemVersionWatcher::GetBehavior

(

Behavior &

behavior

)

const

Gets behavior if this setting is on non-default and a client that does not support it connects.

Parameters:

behavior

behavior if this setting is on non-default and a client that does not support it connects to fill

Returns:

A reference to this to allow chaining

Definition at line 649 of file nConfig.cpp.

References GetBehavior().

{
    behavior = this->GetBehavior();
    return *this;
}

Here is the call graph for this function:

void nConfItemVersionWatcher::FillTemplateParameters

(

tOutput &

o

)

const

fills output with template parameters about the setting

Parameters:

o

output to fill. Template parameter 1 will be the setting name, parameter 2 the setting's group, and parameter 3 the first version supporting the setting

Definition at line 696 of file nConfig.cpp.

References tConfItemBase::GetTitle(), group_, nVersion::Min(), tOutput::SetTemplateParameter(), sn_GetVersionString(), sn_groupName, version_, and nIConfItemWatcher::watched_.

Referenced by AdaptVersion(), DoWritable(), and OnVersionChange().

{
    o.SetTemplateParameter(1, watched_.GetTitle() );
    o.SetTemplateParameter(2, sn_groupName[group_] );
    o.SetTemplateParameter(3, sn_GetVersionString( version_.Min() ) );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void nConfItemVersionWatcher::OnChange

(

bool

nonDefault

)

[private, virtual]

called on configuration item changes

Parameters:

nonDefault

flag indicating whether the change was away from the default

Implements nIConfItemWatcher.

Definition at line 416 of file nConfig.cpp.

References nonDefault_, and sn_UpdateCurrentVersion().

{
    bool changed = ( nonDefault != nonDefault_ );

    nonDefault_ = nonDefault;
    if ( changed )
    {
        sn_UpdateCurrentVersion();
    }
}

Here is the call graph for this function:

bool nConfItemVersionWatcher::DoWritable

(

void

)

const [private, virtual]

returns whether the item should be writable

Returns:

true if the watched item is changable

Implements nIConfItemWatcher.

Definition at line 665 of file nConfig.cpp.

References Behavior_Revert, con, FillTemplateParameters(), GetBehavior(), nVersion::Max(), nVersion::Min(), sn_CurrentVersion(), and version_.

{
    // if we're not set to revert, the setting is writable
    if ( GetBehavior() != Behavior_Revert )
        return true;

    // and if the setting is currently supported by all parites, it's writable too
    if ( version_.Min() <= sn_CurrentVersion().Max() )
        return true;

    // inform user about impossible change
    tOutput o;
    FillTemplateParameters(o);
    o << "$setting_legacy_change_blocked";
    con << o;

    // only if it's not, it needs to be protected.
    return false;

}

Here is the call graph for this function:

---

Member Data Documentation

nVersion nConfItemVersionWatcher::version_ [private]

the versions that support this

Definition at line 261 of file nConfig.h.

Referenced by AdaptVersion(), DoWritable(), FillTemplateParameters(), and OnVersionChange().

bool nConfItemVersionWatcher::nonDefault_ [private]

flag memorizing whether the setting is at default by the user

Definition at line 262 of file nConfig.h.

Referenced by AdaptVersion(), OnChange(), and OnVersionChange().

bool nConfItemVersionWatcher::reverted_ [private]

flag memorizing whether the setting has been reverted to the default temporarily

Definition at line 263 of file nConfig.h.

Referenced by OnVersionChange().

Group nConfItemVersionWatcher::group_ [private]

class of incompatibility

Definition at line 265 of file nConfig.h.

Referenced by FillTemplateParameters(), GetBehavior(), and OnVersionChange().

Behavior nConfItemVersionWatcher::overrideGroupBehavior_ [private]

if set, the global behavior for the class gets ignored

Definition at line 266 of file nConfig.h.

Referenced by GetBehavior().

tSettingItem< Behavior > nConfItemVersionWatcher::overrideGroupBehaviorConf_ [private]

setting item for override

Definition at line 267 of file nConfig.h.

---

The documentation for this class was generated from the following files:

• src/network/nConfig.h
• src/network/nConfig.cpp

---