TKN Logo SelfSoft Logo

Total Knowledge

SelfSoft, Inc.

CPPSERV

[CPPSERV] [Documentation] [Download] [Contact] [Bug tracker] [News] [RSS Feed] [gitweb]

container::ServerConfig::Context Class Reference

Inheritance diagram for container::ServerConfig::Context:

Inheritance graph
[legend]
Collaboration diagram for container::ServerConfig::Context:

Collaboration graph
[legend]
List of all members.

Public Types

typedef std::list< ConfigNodecfgparamlist_t
typedef std::map< std::string,
cfgparamlist_t
params_t
typedef std::list< Context * > ctxlist_t
typedef std::map< std::string,
UnsetParam
unsetparams_t

Public Member Functions

 Context (ServerConfig &cfg, Context *parent)
virtual ~Context ()
bool complete ()
const cfgparamlist_tgetParam (const std::string &type) const
bool setParam (const ConfigNode &)
const std::string & getName () const
const std::string & getType () const
ServerConfiggetServerConfig ()
bool process (ServerConfig &, ServerConfig::ConfigNode *)
void addChildContext (Context *ctx)
bool setIgnore (const ServerConfig::ConfigNode &)
ContextgetParent ()

Protected Member Functions

virtual bool onPreComplete ()
virtual bool onPostComplete ()
virtual bool onSetParam (const ConfigNode &val)=0
virtual ContextgetContext (const ConfigNode &)=0
unsetparams_tgetUnsetParams ()

Private Attributes

ctxlist_t kids
params_t params
std::string type
std::string name
Contextparent
unsetparams_t unsetParams
ServerConfigm_cfg

Classes

class  UnsetParam

Detailed Description

Definition at line 139 of file serverconfig.h.


Member Typedef Documentation

Definition at line 150 of file serverconfig.h.

Definition at line 151 of file serverconfig.h.

Definition at line 152 of file serverconfig.h.

Definition at line 153 of file serverconfig.h.


Constructor & Destructor Documentation

container::ServerConfig::Context::Context ( ServerConfig cfg,
Context parent 
) [inline]

Definition at line 184 of file serverconfig.h.

container::ServerConfig::Context::~Context (  )  [virtual]

Definition at line 408 of file serverconfig.cpp.

References kids.


Member Function Documentation

container::ServerConfig::Context::onPreComplete (  )  [inline, protected, virtual]

called before child contexts' complete()

Reimplemented in container::ServerConfig::AppContext.

Definition at line 167 of file serverconfig.h.

Referenced by complete().

container::ServerConfig::Context::onPostComplete (  )  [inline, protected, virtual]

called after child contexts' complete()

Reimplemented in container::ServerConfig::GlobalContext, container::ServerConfig::AppContext, and container::ServerConfig::ServletContext.

Definition at line 172 of file serverconfig.h.

Referenced by complete().

virtual bool container::ServerConfig::Context::onSetParam ( const ConfigNode val  )  [protected, pure virtual]

Context * container::ServerConfig::Context::getContext ( const ConfigNode node  )  [protected, pure virtual]

Parameters:
node Finds context for node with the name. Derived classes should override this function to search in their own context registries.

Implemented in container::ServerConfig::GlobalContext, container::ServerConfig::AppContext, and container::ServerConfig::ServletContext.

Referenced by process().

unsetparams_t& container::ServerConfig::Context::getUnsetParams (  )  [inline, protected]

bool container::ServerConfig::Context::complete (  ) 

Definition at line 136 of file serverconfig.cpp.

References getParam(), getUnsetParams(), kids, onPostComplete(), onPreComplete(), params, parent, setParam(), and unsetParams.

Referenced by container::ServerConfig::processConfig().

Here is the call graph for this function:

const ServerConfig::Context::cfgparamlist_t * container::ServerConfig::Context::getParam ( const std::string &  type  )  const

Definition at line 124 of file serverconfig.cpp.

References params.

Referenced by complete().

bool container::ServerConfig::Context::setParam ( const ConfigNode node  ) 

Parameters:
node Config node describing parameter to set in the current context

Definition at line 110 of file serverconfig.cpp.

References container::ServerConfig::ConfigNode::getName(), container::ServerConfig::ConfigNode::getType(), getUnsetParams(), onSetParam(), params, and unsetParams.

Referenced by complete(), process(), and container::ServerConfig::GlobalContext::setGlobalParam().

Here is the call graph for this function:

const std::string& container::ServerConfig::Context::getType (  )  const [inline]

Definition at line 193 of file serverconfig.h.

References type.

Referenced by process().

ServerConfig& container::ServerConfig::Context::getServerConfig (  )  [inline]

Definition at line 194 of file serverconfig.h.

References m_cfg.

Referenced by container::ServerConfig::AppContext::onPreComplete().

bool container::ServerConfig::Context::process ( ServerConfig cfg,
ServerConfig::ConfigNode node 
)

Walk the config tree and, create all contexts, and set all parameters that are specified in config. container::ServerConfig::Context::complete() will pass inheritable parameters and verify all required ones are set

Definition at line 73 of file serverconfig.cpp.

References addChildContext(), getContext(), getName(), container::ServerConfig::ConfigNode::getName(), container::ServerConfig::getNodes(), getType(), container::ServerConfig::ConfigNode::getType(), kids, name, setParam(), and type.

Referenced by container::ServerConfig::processConfig().

Here is the call graph for this function:

void container::ServerConfig::Context::addChildContext ( Context ctx  ) 

Definition at line 100 of file serverconfig.cpp.

References kids.

Referenced by process().

container::ServerConfig::Context::setIgnore ( const ServerConfig::ConfigNode  )  [inline]

This function can be used for registering params that do nothing in current context, but can be inherited by child contexts

Definition at line 210 of file serverconfig.h.

Referenced by container::ServerConfig::GlobalContext::registerParams().

container::ServerConfig::Context::getParent (  )  [inline]


Member Data Documentation

Definition at line 157 of file serverconfig.h.

Referenced by getType(), and process().

Definition at line 161 of file serverconfig.h.

Referenced by getServerConfig().


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

SourceForge.net Logo

Authoright © Total Knowledge: 2001-2004