Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
te::common::ClassLevelLockable< Host, MutexPolicy, LockReadingPolicy, LockWritingPolicy >::ClassLevelLockingPolicy< LockingPolicy > Class Template Reference

This class acquires a lock over the object class. More...

#include <ThreadingPolicies.h>

Inheritance diagram for te::common::ClassLevelLockable< Host, MutexPolicy, LockReadingPolicy, LockWritingPolicy >::ClassLevelLockingPolicy< LockingPolicy >:

Public Member Functions

 ClassLevelLockingPolicy ()
 Default constructor. More...
 
 ClassLevelLockingPolicy (const Host &host)
 Constructor to keep the semantics of object-level lock. More...
 
 ClassLevelLockingPolicy (const Host *host)
 Constructor to keep the semantics of object-level lock. More...
 
 ~ClassLevelLockingPolicy ()
 Destructor. More...
 

Private Member Functions

 ClassLevelLockingPolicy (const ClassLevelLockingPolicy &)
 
ClassLevelLockingPolicy & operator= (const ClassLevelLockingPolicy &)
 

Private Attributes

LockingPolicy m_lock
 lock policy. More...
 

Detailed Description

template<class Host, class MutexPolicy = TE_DEFAULT_MUTEX_POLICY, class LockReadingPolicy = TE_DEFAULT_LOCK_READING_POLICY, class LockWritingPolicy = TE_DEFAULT_LOCK_WRITING_POLICY>
template<class LockingPolicy>
class te::common::ClassLevelLockable< Host, MutexPolicy, LockReadingPolicy, LockWritingPolicy >::ClassLevelLockingPolicy< LockingPolicy >

This class acquires a lock over the object class.

Requirements on type LockingPolicy:

  • it must be one of: boost::lock_guard, boost::unique_lock, boost::shared_lock, boost::upgrade_lock, boost::upgrade_to_unique_lock

Definition at line 264 of file ThreadingPolicies.h.

Constructor & Destructor Documentation

◆ ClassLevelLockingPolicy() [1/4]

template<class Host , class MutexPolicy = TE_DEFAULT_MUTEX_POLICY, class LockReadingPolicy = TE_DEFAULT_LOCK_READING_POLICY, class LockWritingPolicy = TE_DEFAULT_LOCK_WRITING_POLICY>
template<class LockingPolicy >
te::common::ClassLevelLockable< Host, MutexPolicy, LockReadingPolicy, LockWritingPolicy >::ClassLevelLockingPolicy< LockingPolicy >::ClassLevelLockingPolicy ( )
inlineexplicit

Default constructor.

Definition at line 269 of file ThreadingPolicies.h.

◆ ClassLevelLockingPolicy() [2/4]

template<class Host , class MutexPolicy = TE_DEFAULT_MUTEX_POLICY, class LockReadingPolicy = TE_DEFAULT_LOCK_READING_POLICY, class LockWritingPolicy = TE_DEFAULT_LOCK_WRITING_POLICY>
template<class LockingPolicy >
te::common::ClassLevelLockable< Host, MutexPolicy, LockReadingPolicy, LockWritingPolicy >::ClassLevelLockingPolicy< LockingPolicy >::ClassLevelLockingPolicy ( const Host &  host)
inlineexplicit

Constructor to keep the semantics of object-level lock.

Definition at line 275 of file ThreadingPolicies.h.

◆ ClassLevelLockingPolicy() [3/4]

template<class Host , class MutexPolicy = TE_DEFAULT_MUTEX_POLICY, class LockReadingPolicy = TE_DEFAULT_LOCK_READING_POLICY, class LockWritingPolicy = TE_DEFAULT_LOCK_WRITING_POLICY>
template<class LockingPolicy >
te::common::ClassLevelLockable< Host, MutexPolicy, LockReadingPolicy, LockWritingPolicy >::ClassLevelLockingPolicy< LockingPolicy >::ClassLevelLockingPolicy ( const Host *  host)
inlineexplicit

Constructor to keep the semantics of object-level lock.

Definition at line 281 of file ThreadingPolicies.h.

◆ ~ClassLevelLockingPolicy()

template<class Host , class MutexPolicy = TE_DEFAULT_MUTEX_POLICY, class LockReadingPolicy = TE_DEFAULT_LOCK_READING_POLICY, class LockWritingPolicy = TE_DEFAULT_LOCK_WRITING_POLICY>
template<class LockingPolicy >
te::common::ClassLevelLockable< Host, MutexPolicy, LockReadingPolicy, LockWritingPolicy >::ClassLevelLockingPolicy< LockingPolicy >::~ClassLevelLockingPolicy ( )
inline

Destructor.

Definition at line 287 of file ThreadingPolicies.h.

◆ ClassLevelLockingPolicy() [4/4]

template<class Host , class MutexPolicy = TE_DEFAULT_MUTEX_POLICY, class LockReadingPolicy = TE_DEFAULT_LOCK_READING_POLICY, class LockWritingPolicy = TE_DEFAULT_LOCK_WRITING_POLICY>
template<class LockingPolicy >
te::common::ClassLevelLockable< Host, MutexPolicy, LockReadingPolicy, LockWritingPolicy >::ClassLevelLockingPolicy< LockingPolicy >::ClassLevelLockingPolicy ( const ClassLevelLockingPolicy< LockingPolicy > &  )
private

Member Function Documentation

◆ operator=()

template<class Host , class MutexPolicy = TE_DEFAULT_MUTEX_POLICY, class LockReadingPolicy = TE_DEFAULT_LOCK_READING_POLICY, class LockWritingPolicy = TE_DEFAULT_LOCK_WRITING_POLICY>
template<class LockingPolicy >
ClassLevelLockingPolicy & te::common::ClassLevelLockable< Host, MutexPolicy, LockReadingPolicy, LockWritingPolicy >::ClassLevelLockingPolicy< LockingPolicy >::operator= ( const ClassLevelLockingPolicy< LockingPolicy > &  )
private

Member Data Documentation

◆ m_lock

template<class Host , class MutexPolicy = TE_DEFAULT_MUTEX_POLICY, class LockReadingPolicy = TE_DEFAULT_LOCK_READING_POLICY, class LockWritingPolicy = TE_DEFAULT_LOCK_WRITING_POLICY>
template<class LockingPolicy >
LockingPolicy te::common::ClassLevelLockable< Host, MutexPolicy, LockReadingPolicy, LockWritingPolicy >::ClassLevelLockingPolicy< LockingPolicy >::m_lock
private

lock policy.

Definition at line 298 of file ThreadingPolicies.h.

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