lifecycle-advisor.hpp

Go to the documentation of this file.

/*
  LIFECYCLE-ADVISOR.hpp  -  outline of the session lifecycle

   Copyright (C)
     2010,            Hermann Vosseler <Ichthyostega@web.de>

  **Lumiera** is free software; you can redistribute it and/or modify it
  under the terms of the GNU General Public License as published by the
  Free Software Foundation; either version 2 of the License, or (at your
  option) any later version. See the file COPYING for further details.

*/


#ifndef STEAM_MOBJECT_SESSION_LIFECYCLE_ADVISOR_H
#define STEAM_MOBJECT_SESSION_LIFECYCLE_ADVISOR_H

#include "lib/error.hpp"
#include "lib/nocopy.hpp"
#include "include/lifecycle.h"
#include "steam/mobject/session.hpp"
#include "lib/symbol.hpp"


namespace steam {
namespace mobject {
namespace session {
  
  using lib::Symbol;
  
  
  class LifecycleAdvisor
    : util::NonCopyable
    {
      
      
    public:
      void
      pullUp()
        {
          createSessionFacilities();      // includes switch of the "current" Session
          emitEvent (ON_SESSION_START);
          injectSessionContent();
          emitEvent (ON_SESSION_INIT);
          getSessionReady();
          openSessionInterface();
          emitEvent (ON_SESSION_READY);
        }
      
      
      void
      shutDown()
        {
          emitEvent (ON_SESSION_CLOSE);
          closeSessionInterface();
          disconnectRenderProcesses();
          emitEvent (ON_SESSION_END);
          commandLogCheckpoint();
          deconfigure();
        }
      
      
      virtual ~LifecycleAdvisor() { }   
      
      
    protected: /* === Lifecycle building blocks === */
      
      void
      emitEvent (Symbol eventLabel)
        {
          lumiera::LifecycleHook::trigger (eventLabel);
        }
      
      
      virtual void createSessionFacilities()   =0;
      
      
      virtual void injectSessionContent()      =0;
      
      
      virtual void getSessionReady()           =0;
      
      
      virtual void openSessionInterface()      =0;
      
      
      virtual void closeSessionInterface()     =0;
      
      
      virtual void disconnectRenderProcesses() =0;
      
      
      virtual void commandLogCheckpoint()      =0;
      
      
      virtual void deconfigure()               =0;
    };
  
  
  
}}} // namespace mobject::session
#endif