Bitcoin Core  0.15.99
P2P Digital Currency
Public Types | Public Member Functions | List of all members
AnnotatedMixin< PARENT > Class Template Reference

Template mixin that adds -Wthread-safety locking annotations and lock order checking to a subset of the mutex API. More...

#include <sync.h>

Inheritance diagram for AnnotatedMixin< PARENT >:
[legend]
Collaboration diagram for AnnotatedMixin< PARENT >:
[legend]

Public Types

using UniqueLock = std::unique_lock< PARENT >
 

Public Member Functions

 ~AnnotatedMixin ()
 
void lock () EXCLUSIVE_LOCK_FUNCTION()
 
void unlock () UNLOCK_FUNCTION()
 
bool try_lock () EXCLUSIVE_TRYLOCK_FUNCTION(true)
 

Detailed Description

template<typename PARENT>
class AnnotatedMixin< PARENT >

Template mixin that adds -Wthread-safety locking annotations and lock order checking to a subset of the mutex API.

Definition at line 78 of file sync.h.

Member Typedef Documentation

◆ UniqueLock

template<typename PARENT>
using AnnotatedMixin< PARENT >::UniqueLock = std::unique_lock<PARENT>

Definition at line 100 of file sync.h.

Constructor & Destructor Documentation

◆ ~AnnotatedMixin()

template<typename PARENT>
AnnotatedMixin< PARENT >::~AnnotatedMixin ( )
inline

Definition at line 81 of file sync.h.

Member Function Documentation

◆ lock()

template<typename PARENT>
void AnnotatedMixin< PARENT >::lock ( )
inline

Definition at line 85 of file sync.h.

◆ try_lock()

template<typename PARENT>
bool AnnotatedMixin< PARENT >::try_lock ( )
inline

Definition at line 95 of file sync.h.

◆ unlock()

template<typename PARENT>
void AnnotatedMixin< PARENT >::unlock ( )
inline

Definition at line 90 of file sync.h.


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