moduledeclare.h

Go to the documentation of this file.

/*
 *   Copyright 2014-2015 The 4S Foundation (www.4s-online.dk)
 *
 *   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.
 */

#ifndef MODULEDECLARE_H
#define MODULEDECLARE_H

#include "FSYS/basemsg.h"
#include "FSYS/log.h"

#include <assert.h>

namespace FSYS
{
  class Module
  {
  public:
    virtual void msgReady( void ) {}
    virtual void msgGroupReady( void ) {}
    virtual void msgSystemReady( void ) {}
    virtual void msgGoingDown( void ) {}
    virtual void msgDestroy( void ) {}
    virtual ~Module( void ) {}
  };

  class MsgSystemReady : public BaseMsg {};

  class MsgGoingDown : public BaseMsg {};

  class MsgGroupReady : public BaseMsg {};

  class MsgDestroy : public BaseMsg {};

  class MsgAllDestroyed : public BaseMsg {};

namespace ModulePrivate
{
  class LauncherBase
  {
  private:
    void sendMsgReady( void );

    void sendMsgDestroy( void );

    bool isCreated = {false};

  protected:
    Module *userObject{nullptr};   // The pointer to the real object

    virtual void create( void ) = 0;

    virtual void destroy( void ) = 0;

  public:
    enum class ModuleType {
      UNKNOWN,
      STATIC,
      DELAYED,
      DYNAMIC,
      DYNAMIC_THREAD
    };

    virtual ModuleType getType( void ) = 0;

    void startup( void );

    void shutdown( void );

    inline bool isRunning( void );

    void sendMsgGroupReady( void );

    void sendMsgSystemReady( void );

    void sendMsgGoingDown( void );

    virtual ~LauncherBase( void ) {}
  };

  template <class TypeToLaunch,
            LauncherBase::ModuleType mt=LauncherBase::ModuleType::STATIC>
    class Launcher : public LauncherBase
  {

  private:
    void create( void ) override
    {
      // Ensure the user object is null
      assert(nullptr == userObject);

      // Instantiate the user object
      userObject = new TypeToLaunch;
    }

    void destroy( void ) override
    {
      // Delete the user object
      delete userObject;

      // Make sure the user object is null
      userObject = nullptr;
    }

    ModuleType moduleType = {mt};
  public:
    ModuleType getType( void ) override
    {
      return moduleType;
    }

  };

  class LauncherEnd : public LauncherBase
  {

  private:
    void create( void ) override {};

    void destroy( void ) override {};

  public:
    ModuleType getType( void ) override
    {
      return LauncherBase::ModuleType::UNKNOWN;
    }

  };

}

}
#endif