FreeRTOScpp::Lockable Class Reference

A Base class to provide block based locking capability. More...

#include <Lock.h>

Inheritance diagram for FreeRTOScpp::Lockable:

Public Member Functions
	Lockable ()
virtual	~Lockable ()
virtual bool	give ()=0
virtual bool	take (TickType_t wait=portMAX_DELAY)=0
bool	take (Time_ms ms)

Private Member Functions
	Lockable (Lockable const &)=delete
	We are not copyable. More...
void	operator= (Lockable const &)=delete
	We are not assignable. More...

Detailed Description

A Base class to provide block based locking capability.

Any object that supports "Locking" should be derived from Lockable (like a Semaphore or Mutex)

Such objects need to provide an interface consisting of

• virtual bool take(TickType_t wait)
• virtual bool give();

Constructor & Destructor Documentation

Lockable() [1/2]

FreeRTOScpp::Lockable::Lockable ( )

inline

Referenced by take().

Here is the caller graph for this function:

~Lockable()

virtual FreeRTOScpp::Lockable::~Lockable ( )

inlinevirtual

References take().

Here is the call graph for this function:

Lockable() [2/2]

FreeRTOScpp::Lockable::Lockable ( Lockable const &  )

privatedelete

We are not copyable.

Member Function Documentation

give()

virtual bool FreeRTOScpp::Lockable::give ( )

pure virtual

Implemented in FreeRTOScpp::RecursiveMutex, FreeRTOScpp::Mutex, FreeRTOScpp::BinarySemaphore, FreeRTOScpp::Writer, and FreeRTOScpp::Reader.

Referenced by take(), FreeRTOScpp::Lock::unlock(), and FreeRTOScpp::Lock::~Lock().

Here is the caller graph for this function:

operator=()

void FreeRTOScpp::Lockable::operator= ( Lockable const &  )

privatedelete

We are not assignable.

Referenced by take().

Here is the caller graph for this function:

take() [1/2]

virtual bool FreeRTOScpp::Lockable::take ( TickType_t  wait = portMAX_DELAY )

pure virtual

Implemented in FreeRTOScpp::RecursiveMutex, FreeRTOScpp::BinarySemaphore, FreeRTOScpp::Mutex, FreeRTOScpp::Writer, and FreeRTOScpp::Reader.

Referenced by FreeRTOScpp::Lock::lock(), and ~Lockable().

Here is the caller graph for this function:

take() [2/2]

bool FreeRTOScpp::Lockable::take ( Time_ms  ms )

inline

References give(), Lockable(), FreeRTOScpp::ms2ticks(), operator=(), and take().

Referenced by take().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• Lock.h