Cpl::System::Runnable Class Reference

This is an abstract class defines the interface for an object that is "executed" when a Thread object is created. More...

Detailed Description

This is an abstract class defines the interface for an object that is "executed" when a Thread object is created.

#include <Runnable.h>

Inheritance diagram for Cpl::System::Runnable:

Public Member Functions
virtual	~Runnable ()
	Virtual destructor.
virtual void	run ()
	This method is called when the Thread is started.
virtual void	pleaseStop ()
	This method is a request to have the runnable object terminate itself.
virtual bool	isRunning () noexcept
	This method returns true if the instance has 'entered' its run method; false is returned, i.e.
virtual void	setThreadOfExecution_ (Thread *myThreadPtr)
	This method has COMPONENT Scope, it is only made public to avoid the tight coupling of the 'friend mechanism' for friending current and future concrete thread classes.

Protected Member Functions
	Runnable ()
	Constructor.
virtual void	appRun ()=0
	This method is called from the run() method.

Protected Attributes
bool	m_running
	Tracks the run state of the instance.

Constructor & Destructor Documentation

~Runnable()

virtual Cpl::System::Runnable::~Runnable ( )

inlinevirtual

Virtual destructor.

Runnable()

Cpl::System::Runnable::Runnable ( )

protected

Constructor.

Member Function Documentation

appRun()

virtual void Cpl::System::Runnable::appRun ( )

protectedpure virtual

This method is called from the run() method.

It is intended to to be the entry point for application specific code that is executed for the associated thread.

Implemented in Cpl::Dm::EventLoop, Cpl::Dm::MailboxServer, Cpl::Dm::PeriodicScheduler, Cpl::Io::Socket::Listener_, Cpl::Itc::MailboxServer, Cpl::Itc::PeriodicScheduler, Cpl::System::EventLoop, and Cpl::System::FreeRTOS::MakeCurrentThreadACplThread.

isRunning()

virtual bool Cpl::System::Runnable::isRunning ( )

virtualnoexcept

This method returns true if the instance has 'entered' its run method; false is returned, i.e.

the run() method has completed.

pleaseStop()

virtual void Cpl::System::Runnable::pleaseStop ( )

inlinevirtual

This method is a request to have the runnable object terminate itself.

This is only a request, it is not a requirement of a runnable object to oblige the request. Some runnable objects are just not 'built' to handle a such a request. On the other hand, a runnable object such as a MailBoxServer is, and should make every attempt to comply with the request.

NOTES:

1) This a low-level terminate request in that it
   does not understand the "semantics" of what the
   thread is currently doing.  It simply attempts to
   exit the run() method.  The system must first shutdown
   the "application" of the thread BEFORE calling this
   method.
2) This method is an attempted work-around for terminating
   threads by having the thread run itself to completion.
   Not all OSes support a polite way (i.e. reclaiming
   resource, memory, etc.) of killing threads.

Reimplemented in Cpl::Io::Socket::Listener_, and Cpl::System::EventLoop.

run()

virtual void Cpl::System::Runnable::run ( )

virtual

This method is called when the Thread is started.

If this function returns, the Thread will be terminated. This method is implemented by the base class, the application and/or child class needs to implement the 'appRun()' method.

setThreadOfExecution_()

virtual void Cpl::System::Runnable::setThreadOfExecution_ ( Thread *  myThreadPtr )

inlinevirtual

This method has COMPONENT Scope, it is only made public to avoid the tight coupling of the 'friend mechanism' for friending current and future concrete thread classes.

The application SHOULD NEVER call/use this method.

This method is used to provide the runnable instance knowledge about what thread it is associated with. The primary motivation for this is to help terminate a thread when pleaseStop() is called. A default implementation is provided that does NOTHING. It is up the concrete child class to decide how (if at all) to use this information. The Cpl::System::Thread will call this method BEFORE the run() is called.

Reimplemented in Cpl::Io::Socket::Listener_, and Cpl::System::EventLoop.

Member Data Documentation

m_running

bool Cpl::System::Runnable::m_running

protected

Tracks the run state of the instance.

---

The documentation for this class was generated from the following file:

• Cpl/System/Runnable.h