//////////////////////////////////////////////////////////////////////////////// /// @brief application server feature /// /// @file /// /// DISCLAIMER /// /// Copyright 2004-2012 triAGENS GmbH, Cologne, Germany /// /// Licensed under the Apache License, Version 2.0 (the "License"); /// you may not use this file except in compliance with the License. /// You may obtain a copy of the License at /// /// http://www.apache.org/licenses/LICENSE-2.0 /// /// Unless required by applicable law or agreed to in writing, software /// distributed under the License is distributed on an "AS IS" BASIS, /// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. /// See the License for the specific language governing permissions and /// limitations under the License. /// /// Copyright holder is triAGENS GmbH, Cologne, Germany /// /// @author Dr. Frank Celler /// @author Copyright 2010-2012, triAGENS GmbH, Cologne, Germany //////////////////////////////////////////////////////////////////////////////// #ifndef TRIAGENS_APPLICATION_SERVER_APPLICATION_FEATURE_H #define TRIAGENS_APPLICATION_SERVER_APPLICATION_FEATURE_H 1 #include "Basics/Common.h" #include "ApplicationServer/ApplicationServer.h" // ----------------------------------------------------------------------------- // --SECTION-- forward declarations // ----------------------------------------------------------------------------- namespace triagens { namespace basics { class ProgramOptionsDescription; } // ----------------------------------------------------------------------------- // --SECTION-- class ApplicationFeature // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup ApplicationServer /// @{ //////////////////////////////////////////////////////////////////////////////// namespace rest { //////////////////////////////////////////////////////////////////////////////// /// @brief application server feature //////////////////////////////////////////////////////////////////////////////// class ApplicationFeature { private: ApplicationFeature (ApplicationFeature const&); ApplicationFeature& operator= (ApplicationFeature const&); //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- constructors and destructors // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup ApplicationServer /// @{ //////////////////////////////////////////////////////////////////////////////// public: //////////////////////////////////////////////////////////////////////////////// /// @brief constructor //////////////////////////////////////////////////////////////////////////////// ApplicationFeature (); //////////////////////////////////////////////////////////////////////////////// /// @brief destructor //////////////////////////////////////////////////////////////////////////////// virtual ~ApplicationFeature (); //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- public methods // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup ApplicationServer /// @{ //////////////////////////////////////////////////////////////////////////////// public: //////////////////////////////////////////////////////////////////////////////// /// @brief setups the options //////////////////////////////////////////////////////////////////////////////// virtual void setupOptions (map&); //////////////////////////////////////////////////////////////////////////////// /// @brief parsing phase 1, before config file //////////////////////////////////////////////////////////////////////////////// virtual bool parsePhase1 (basics::ProgramOptions&); //////////////////////////////////////////////////////////////////////////////// /// @brief parsing phase 2, after config file //////////////////////////////////////////////////////////////////////////////// virtual bool parsePhase2 (basics::ProgramOptions&); //////////////////////////////////////////////////////////////////////////////// /// @brief starts the feature //////////////////////////////////////////////////////////////////////////////// virtual bool start (); //////////////////////////////////////////////////////////////////////////////// /// @brief checks if the feature is still running //////////////////////////////////////////////////////////////////////////////// virtual bool isRunning (); //////////////////////////////////////////////////////////////////////////////// /// @brief begins the shut down sequence //////////////////////////////////////////////////////////////////////////////// virtual void beginShutdown (); //////////////////////////////////////////////////////////////////////////////// /// @brief shuts down everything //////////////////////////////////////////////////////////////////////////////// virtual void shutdown (); }; } } //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// #endif // ----------------------------------------------------------------------------- // --SECTION-- END-OF-FILE // ----------------------------------------------------------------------------- // Local Variables: // mode: outline-minor // outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|/// @page\\|// --SECTION--\\|/// @\\}\\)" // End: