nConfItemBase Class Reference

base clas for network configuration items More...

#include <nConfig.h>

Inheritance diagram for nConfItemBase:

[legend]

Collaboration diagram for nConfItemBase:

[legend]

List of all members.

Public Member Functions
	nConfItemBase (const char *title)
virtual	~nConfItemBase ()
virtual void	NetReadVal (nMessage &m)=0
virtual void	NetWriteVal (nMessage &m)=0
virtual void	WasChanged (bool nonDefault)
virtual bool	Writable ()
void	SendConfig (bool force=true, int peer=-1)
void	RevertToDefaults ()
	revert this setting to its default
void	SaveValue ()
	saves value for later restoring
void	RevertToSavedValue ()
	reverts to the saved value
Static Public Member Functions
static void	s_GetConfigMessage (nMessage &m)
static void	s_SendConfig (bool force=true, int peer=-1)
static void	s_RevertToDefaults ()
	revert all settings to defaults defined in the code
static void	s_SaveValues ()
	saves all values for later restoring
static void	s_RevertToSavedValues ()
	reverts all settings to the saved values
Protected Member Functions
	nConfItemBase ()
Private Member Functions
virtual void	OnRevertToDefaults ()=0
	revert this setting to its default
virtual void	OnSaveValue ()=0
	saves value for later restoring
virtual void	OnRevertToSavedValue ()=0
	reverts to the saved value
Private Attributes
double	lastChangeTime_
	the time of the last change
unsigned long	lastChangeMessage_
	the ID of the networking message responsible for the change
nIConfItemWatcher *	watcher_
	the watcher that reacts on changes of this item
Friends
class	nIConfItemWatcher

---

Detailed Description

base clas for network configuration items

Definition at line 69 of file nConfig.h.

---

Constructor & Destructor Documentation

nConfItemBase::nConfItemBase

(

)

[protected]

Definition at line 35 of file nConfig.cpp.

        :tConfItemBase(""), lastChangeTime_(-10000), lastChangeMessage_(0), watcher_(0){}

nConfItemBase::nConfItemBase

(

const char *

title

)

Definition at line 41 of file nConfig.cpp.

        :tConfItemBase(title), lastChangeTime_(-10000), lastChangeMessage_(0), watcher_(0){}

nConfItemBase::~nConfItemBase

(

)

[virtual]

Definition at line 44 of file nConfig.cpp.

{}

---

Member Function Documentation

virtual void nConfItemBase::NetReadVal

(

nMessage &

m

)

[pure virtual]

Implemented in nConfItem< T >, and nConfItem< tString >.

Referenced by s_GetConfigMessage().

Here is the caller graph for this function:

virtual void nConfItemBase::NetWriteVal

(

nMessage &

m

)

[pure virtual]

Implemented in nConfItem< T >, and nConfItem< tString >.

Referenced by SendConfig().

Here is the caller graph for this function:

void nConfItemBase::s_GetConfigMessage

(

nMessage &

m

)

[static]

Definition at line 46 of file nConfig.cpp.

References con, tConfItemBase::ConfItemMap(), lastChangeMessage_, lastChangeTime_, nMessage::MessageIDBig(), NetReadVal(), nReadError(), nSERVER, sn_GetNetState(), sn_Update(), and tSysTimeFloat().

                                                 {
    if (sn_GetNetState()==nSERVER){
        nReadError(); // never accept config messages from the clients
    }
    else{
        tString name;
        m >> name;

        //con << "got conf message for " << name << "\n";

        tConfItemMap & confmap = ConfItemMap();
        tConfItemMap::iterator iter = confmap.find( name );
        if ( iter != confmap.end() )
        {
            tConfItemBase * item = (*iter).second;
            nConfItemBase *netitem = dynamic_cast<nConfItemBase*> (item);
            if (netitem)
            {
                // check if message was new
                if ( tSysTimeFloat() > netitem->lastChangeTime_ + 100 || sn_Update( netitem->lastChangeMessage_, m.MessageIDBig() ) )
                {
                    netitem->lastChangeMessage_ = m.MessageIDBig();
                    netitem->lastChangeTime_ = tSysTimeFloat();
                    netitem->NetReadVal(m);
                }
                else
                {
                    static bool warn = true;
                    if ( warn )
                        con << tOutput( "$nconfig_error_ignoreold", name );
                    warn = false;
                }
            }
            else
            {
                static bool warn = true;
                if ( warn )
                    con << tOutput( "$nconfig_error_nonet", name );
                warn = false;
            }
        }
        else
        {
            static bool warn = true;
            if ( warn )
                con << tOutput( "$nconfig_error_unknown", name );
            warn = false;
        }
    }
}

Here is the call graph for this function:

void nConfItemBase::WasChanged

(

bool

nonDefault

)

[virtual]

Definition at line 132 of file nConfig.cpp.

References nIConfItemWatcher::Change(), SendConfig(), and watcher_.

                                               {
    // inform watcher
    if (this->watcher_ )
        this->watcher_->Change( nonDefault );

    SendConfig();
}

Here is the call graph for this function:

bool nConfItemBase::Writable

(

void

)

[virtual]

Reimplemented from tConfItemBase.

Definition at line 140 of file nConfig.cpp.

References nCLIENT, sn_GetNetState(), watcher_, and nIConfItemWatcher::Writable().

{
    // network settings are read only on the client
    if ( sn_GetNetState() == nCLIENT )
        return false;

    // on the server, we need to check for a watcher...
    if ( !watcher_ )
        return true;

    // delegate
    return watcher_->Writable();
}

Here is the call graph for this function:

void nConfItemBase::s_SendConfig	(	bool	force = true,
		int	peer = -1
	)			[static]

Definition at line 101 of file nConfig.cpp.

References tConfItemBase::ConfItemMap(), nSERVER, SendConfig(), and sn_GetNetState().

Referenced by gGame::StateUpdate().

                                                    {
    if(sn_GetNetState()==nSERVER){
        tConfItemMap & confmap = ConfItemMap();
        for(tConfItemMap::iterator iter = confmap.begin(); iter != confmap.end() ; ++iter)
        {
            tConfItemBase * item = (*iter).second;

            nConfItemBase *netitem = dynamic_cast<nConfItemBase*> (item);
            if (netitem)
                netitem->SendConfig(force, peer);
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void nConfItemBase::SendConfig	(	bool	force = true,
		int	peer = -1
	)

Definition at line 115 of file nConfig.cpp.

References nMessage::BroadCast(), tConfItemBase::changed, NetWriteVal(), nSERVER, nMessage::Send(), sn_GetNetState(), tConfItemBase::title, and transferConfig.

Referenced by s_SendConfig(), and WasChanged().

                                                  {
    if ( (changed || force) && sn_GetNetState()==nSERVER)
    {
        //con << "sending conf message for " << tConfItems(i)->title << "\n";
        nMessage *m=new nMessage(transferConfig);
        *m << title;
        NetWriteVal(*m);
        if (peer==-1)
        {
            m->BroadCast();
            changed = false;
        }
        else
            m->Send(peer);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void nConfItemBase::s_RevertToDefaults

(

void

)

[static]

revert all settings to defaults defined in the code

Definition at line 163 of file nConfig.cpp.

References tConfItemBase::ConfItemMap(), and RevertToDefaults().

Referenced by gSettingsReverter::gSettingsReverter().

{
    tConfItemMap & confmap = ConfItemMap();
    for(tConfItemMap::iterator iter = confmap.begin(); iter != confmap.end() ; ++iter)
    {
        tConfItemBase * item = (*iter).second;
        nConfItemBase *netitem = dynamic_cast<nConfItemBase*> (item);
        if (netitem)
        {
            netitem->RevertToDefaults();
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void nConfItemBase::RevertToDefaults

(

void

)

[inline]

revert this setting to its default

Definition at line 316 of file nConfig.h.

References nIConfItemWatcher::Change(), lastChangeMessage_, lastChangeTime_, OnRevertToDefaults(), and watcher_.

Referenced by nConfItemVersionWatcher::OnVersionChange(), and s_RevertToDefaults().

{
    // inform watcher
    if (this->watcher_ )
        this->watcher_->Change( false );

    // reset last change information
    lastChangeMessage_ = 0;
    lastChangeTime_ = -1000000;

    this->OnRevertToDefaults();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void nConfItemBase::s_SaveValues

(

void

)

[static]

saves all values for later restoring

Definition at line 186 of file nConfig.cpp.

References tConfItemBase::ConfItemMap(), and SaveValue().

Referenced by gSettingsReverter::gSettingsReverter().

{
    tConfItemMap & confmap = ConfItemMap();
    for(tConfItemMap::iterator iter = confmap.begin(); iter != confmap.end() ; ++iter)
    {
        tConfItemBase * item = (*iter).second;
        nConfItemBase *netitem = dynamic_cast<nConfItemBase*> (item);
        if (netitem)
        {
            netitem->SaveValue();
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void nConfItemBase::SaveValue

(

void

)

[inline]

saves value for later restoring

Definition at line 338 of file nConfig.h.

References OnSaveValue().

Referenced by nConfItemVersionWatcher::OnVersionChange(), and s_SaveValues().

{
    this->OnSaveValue();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void nConfItemBase::s_RevertToSavedValues

(

void

)

[static]

reverts all settings to the saved values

Definition at line 209 of file nConfig.cpp.

References tConfItemBase::ConfItemMap(), and RevertToSavedValue().

Referenced by gSettingsReverter::~gSettingsReverter().

{
    tConfItemMap & confmap = ConfItemMap();
    for(tConfItemMap::iterator iter = confmap.begin(); iter != confmap.end() ; ++iter)
    {
        tConfItemBase * item = (*iter).second;
        nConfItemBase *netitem = dynamic_cast<nConfItemBase*> (item);
        if (netitem)
        {
            netitem->RevertToSavedValue();
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void nConfItemBase::RevertToSavedValue

(

void

)

[inline]

reverts to the saved value

Definition at line 352 of file nConfig.h.

References OnRevertToSavedValue().

Referenced by nConfItemVersionWatcher::OnVersionChange(), and s_RevertToSavedValues().

{
    this->OnRevertToSavedValue();
}

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void nConfItemBase::OnRevertToDefaults

(

)

[private, pure virtual]

revert this setting to its default

Implemented in nConfItem< T >, and nConfItem< tString >.

Referenced by RevertToDefaults().

Here is the caller graph for this function:

virtual void nConfItemBase::OnSaveValue

(

)

[private, pure virtual]

saves value for later restoring

Implemented in nConfItem< T >, and nConfItem< tString >.

Referenced by SaveValue().

Here is the caller graph for this function:

virtual void nConfItemBase::OnRevertToSavedValue

(

)

[private, pure virtual]

reverts to the saved value

Implemented in nConfItem< T >, and nConfItem< tString >.

Referenced by RevertToSavedValue().

Here is the caller graph for this function:

---

Friends And Related Function Documentation

friend class nIConfItemWatcher [friend]

Definition at line 71 of file nConfig.h.

---

Member Data Documentation

double nConfItemBase::lastChangeTime_ [private]

the time of the last change

Definition at line 73 of file nConfig.h.

Referenced by RevertToDefaults(), and s_GetConfigMessage().

unsigned long nConfItemBase::lastChangeMessage_ [private]

the ID of the networking message responsible for the change

Definition at line 74 of file nConfig.h.

Referenced by RevertToDefaults(), and s_GetConfigMessage().

nIConfItemWatcher* nConfItemBase::watcher_ [private]

the watcher that reacts on changes of this item

Definition at line 75 of file nConfig.h.

Referenced by nIConfItemWatcher::nIConfItemWatcher(), RevertToDefaults(), WasChanged(), Writable(), and nIConfItemWatcher::~nIConfItemWatcher().

---

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

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

---