topical media & game development
lib-of-vs-libs-Poco-include-Poco-Util-Subsystem.h / h
//
// Subsystem.h
//
//
//
// Library: Util
// Package: Application
// Module: Subsystem
//
// Definition of the Subsystem class.
//
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// Permission is hereby granted, free of charge, to any person or organization
// obtaining a copy of the software and accompanying documentation covered by
// this license (the "Software") to use, reproduce, display, distribute,
// execute, and transmit the Software, and to prepare derivative works of the
// Software, and to permit third-parties to whom the Software is furnished to
// do so, all subject to the following:
//
// The copyright notices in the Software and this entire statement, including
// the above license grant, this restriction and the following disclaimer,
// must be included in all copies of the Software, in whole or in part, and
// all derivative works of the Software, unless such copies or derivative
// works are solely in the form of machine-executable object code generated by
// a source language processor.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
ifndef Util_Subsystem_INCLUDED
define Util_Subsystem_INCLUDED
include "Poco/Util/Util.h"
include "Poco/RefCountedObject.h"
namespace Poco {
namespace Util {
class Application;
class OptionSet;
class Util_API Subsystem: public Poco::RefCountedObject
Subsystems extend an application in a modular way.
The Subsystem class provides a common interface
for subsystems so that subsystems can be automatically
initialized at startup and uninitialized at shutdown.
Subsystems should also support dynamic reconfiguration,
so that they can be reconfigured anytime during the
life of a running application.
The degree to which dynamic reconfiguration is supported
is up to the actual subsystem implementation. It can
range from ignoring the reconfiguration request (not
recommended), to changing certain settings that affect
the performance, to a complete reinitialization.
{
public:
Subsystem();
Creates the Subsystem.
protected:
virtual const char* name() const = 0;
Returns the name of the subsystem.
Must be implemented by subclasses.
virtual void initialize(Application& app) = 0;
Initializes the subsystem.
virtual void uninitialize() = 0;
Uninitializes the subsystem.
virtual void reinitialize(Application& app);
Re-initializes the subsystem.
The default implementation just calls
uninitialize() followed by initialize().
Actual implementations might want to use a
less radical and possibly more performant
approach.
virtual void defineOptions(OptionSet& options);
Called before the Application's command line processing begins.
If a subsystem wants to support command line arguments,
it must override this method.
The default implementation does not define any options.
To effectively handle options, a subsystem should either bind
the option to a configuration property or specify a callback
to handle the option.
virtual ~Subsystem();
Destroys the Subsystem.
friend class Application;
private:
Subsystem(const Subsystem&);
Subsystem& operator = (const Subsystem&);
};
} } // namespace Poco::Util
endif // Util_Subsystem_INCLUDED
(C) Æliens
04/09/2009
You may not copy or print any of this material without explicit permission of the author or the publisher.
In case of other copyright issues, contact the author.
