mthreadtriggered.hpp

Go to the documentation of this file.

/** ************************************************************************************************
 * \file
 * This header file is part of module \alib_threads of the \aliblong.
 *
 * \emoji :copyright: 2013-2019 A-Worx GmbH, Germany.
 * Published under \ref mainpage_license "Boost Software License".
 **************************************************************************************************/
#ifndef HPP_AWORX_ALIB_THREADS_MODEL_MTHREAD_TRIGGERED
#define HPP_AWORX_ALIB_THREADS_MODEL_MTHREAD_TRIGGERED
 
 
#if !defined(ALIB_DOX)  // todo remove
 
#if !defined(HPP_AWORX_ALIB_THREADS_MODEL_MTHREAD)
#   include "alib/threads/model/mthread.hpp"
#endif
 
#if !defined(HPP_AWORX_ALIB_THREADS_MODEL_TRIGGERED)
#   include "alib/threads/model/triggered.hpp"
#endif
namespace alib { namespace threads::model {
 
/** ************************************************************************************************
 * TODOX
 * Implements a distinct thread communication model...with priority queues...
 **************************************************************************************************/
class MThreadTriggered : public MThread, protected Triggered
{
  protected:
    /**
     * Command ids to push to the \b MThread's pipe in respect to triggeing.
     */
    enum class TriggerCommands
    {
        Trigger    , ///< Trigger
    };
 
    /**
     * Constructor. Passes the name to both parents. Usually these names are
     * hard-coded C++ character arrays. If progarmmatically created, it has to be assured that
     * the life-cycle of the string supersedes the lifecycle of the instnace of this class.
     * @param pName The name of this object.
     */
    MThreadTriggered(const String& pName)
    : MThread(pName)
    , Triggered( pName )                                                                          {}
 
 
    /**
     *  Implementation of parent classes' interface. This pushes command
     *  \ref TriggerCommands "TriggerCommands::Trigger" into the pipe.
     */
    virtual void        trigger()                                                           override
    {
        cmdPipe.Push( TriggerCommands::Trigger, 1 );
    }
 
 
}; // class MThreadTriggered
 
 
} // namespace alib[::threads::model]
 
/// Type alias in namespace #alib.
using      MThreadTriggered          = alib::threads::model::MThreadTriggered;
 
}  // namespace [alib]
 
 
#endif // !defined(ALIB_DOX)
 
#endif // HPP_AWORX_ALIB_THREADS_MODEL_MTHREAD_TRIGGERED