RTOS Wrapper
API reference
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
RtosSharedLock< SharedMutexT > Class Template Reference

#include <RtosMutex.h>

Public Member Functions

 RtosSharedLock (SharedMutexT &mutex, uint32_t timeout_ms=0) noexcept
 
 ~RtosSharedLock () noexcept
 
 RtosSharedLock (const RtosSharedLock &)=delete
 
RtosSharedLock & operator= (const RtosSharedLock &)=delete
 
 RtosSharedLock (RtosSharedLock &&other) noexcept
 
RtosSharedLock & operator= (RtosSharedLock &&other) noexcept
 
bool IsLocked () const noexcept
 
void Unlock () noexcept
 

Private Attributes

SharedMutexT * mutex_
 
bool locked_
 

Constructor & Destructor Documentation

◆ RtosSharedLock() [1/3]

template<typename SharedMutexT >
RtosSharedLock< SharedMutexT >::RtosSharedLock ( SharedMutexT &  mutex,
uint32_t  timeout_ms = 0 
)
inlineexplicitnoexcept

◆ ~RtosSharedLock()

template<typename SharedMutexT >
RtosSharedLock< SharedMutexT >::~RtosSharedLock ( )
inlinenoexcept

◆ RtosSharedLock() [2/3]

template<typename SharedMutexT >
RtosSharedLock< SharedMutexT >::RtosSharedLock ( const RtosSharedLock< SharedMutexT > &  )
delete

◆ RtosSharedLock() [3/3]

template<typename SharedMutexT >
RtosSharedLock< SharedMutexT >::RtosSharedLock ( RtosSharedLock< SharedMutexT > &&  other)
inlinenoexcept

Member Function Documentation

◆ IsLocked()

template<typename SharedMutexT >
bool RtosSharedLock< SharedMutexT >::IsLocked ( ) const
inlinenoexcept

◆ operator=() [1/2]

template<typename SharedMutexT >
RtosSharedLock & RtosSharedLock< SharedMutexT >::operator= ( const RtosSharedLock< SharedMutexT > &  )
delete

◆ operator=() [2/2]

template<typename SharedMutexT >
RtosSharedLock & RtosSharedLock< SharedMutexT >::operator= ( RtosSharedLock< SharedMutexT > &&  other)
inlinenoexcept

◆ Unlock()

template<typename SharedMutexT >
void RtosSharedLock< SharedMutexT >::Unlock ( )
inlinenoexcept

Member Data Documentation

◆ locked_

template<typename SharedMutexT >
bool RtosSharedLock< SharedMutexT >::locked_
private

◆ mutex_

template<typename SharedMutexT >
SharedMutexT* RtosSharedLock< SharedMutexT >::mutex_
private

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