spawnable.hh

Go to the documentation of this file.

#ifndef _DRAMA2_SPAWNABLE_INC
#define _DRAMA2_SPAWNABLE_INC
/*
 * History:
     07-Jan-2014 - TJF - Original version
 
 * The above ID is for Doxygen, this one has the format ACMM is looking for.
 * "@(#) $Id$"
*/
#include "drama/task.hh"
#include "drama/entryinfo.hh"
#include "drama/request.hh"
#include "drama/action.hh"
#include "drama/messagehandler.hh"
#include "status.h"
namespace drama { 
 
    class Spawnable : public ActionHandler  {
    private:
 
        // *************
        //  Override of three methods from ActionHandler
        /*
         * MessageEvent is invoked when a message is received. Must invoke
         * the sub-class's method.
         */ 
        Request MessageEvent(std::weak_ptr<Task> task, Action *action) 
            override final;
        /* This is invoked when the action ends. 
         *
         * Will never be invoked as control is passed to a user's MessageHandler
         * which is what is invoked.
         */
        void InvokeActionEnd(std::weak_ptr<Task> task, Action *action,
                             bool taskExiting, 
                             StatusType actionEndStatus) override final;
        /* Invoked when DITS is cleaning up an action's entry in the internal
         *  DITS tables.  
         *
         * This method should return true if the internal objects related
         *  to this action can be deleted.  
         */
 
        /* This three are only valid during a call to MessageReceived() . */
        std::weak_ptr<Task> _theTask;
 
    public:
 
        Spawnable() { }
 
        virtual ~Spawnable();
 
        Spawnable& operator=(const Spawnable &rhs) = delete;
        Spawnable(const Spawnable &source) = delete;
        
        Spawnable& operator=( Spawnable &&rhs) = default;
        Spawnable( Spawnable &&source) = default;
    private:
#ifdef RUNNING_DOXYGEN /* So that DOXYGEN will document the next one */
    protected:
#endif
        virtual MessageHandlerPtr Spawn() = 0;
    public:
        virtual void ActionEnd(MessageHandlerPtr obj) = 0;
 
        virtual std::shared_ptr<Task>  GetTask() const {
            return std::shared_ptr<Task>(_theTask);
        }
 
    protected:
 
    }; // class Spawnable.
 
    using SpawnablePtr = std::shared_ptr<Spawnable> ;
 
 
 
} // namespace drama
 
#endif