folly::LockPolicyUpgrade Struct Reference

#include <LockTraits.h>

Inheritance diagram for folly::LockPolicyUpgrade:

Public Types
using	UnlockPolicy = detail::UnlockPolicyUpgrade< LockTraits >

Static Public Member Functions
template<class Mutex >
static std::true_type	lock (Mutex &mutex)
template<class Mutex , class Rep , class Period >
static bool	try_lock_for (Mutex &mutex, const std::chrono::duration< Rep, Period > &timeout)
Static Public Member Functions inherited from folly::detail::UnlockPolicyUpgrade< LockTraits >
template<typename Mutex >
static void	unlock (Mutex &mutex)

Detailed Description

A lock policy with the following mapping

lock() -> lock_upgrade() unlock() -> unlock_upgrade() try_lock_for -> try_lock_upgrade_for()

Definition at line 511 of file LockTraits.h.

Member Typedef Documentation

using folly::LockPolicyUpgrade::UnlockPolicy = detail::UnlockPolicyUpgrade<LockTraits>

Definition at line 512 of file LockTraits.h.

Member Function Documentation

template<class Mutex >

static std::true_type folly::LockPolicyUpgrade::lock ( Mutex &  mutex )

inlinestatic

Definition at line 515 of file LockTraits.h.

Referenced by TEST().

                                         {
    LockTraits<Mutex>::lock_upgrade(mutex);
    return std::true_type{};
  }

template<class Mutex , class Rep , class Period >

static bool folly::LockPolicyUpgrade::try_lock_for ( Mutex &  mutex, const std::chrono::duration< Rep, Period > &  timeout  )

inlinestatic

Definition at line 520 of file LockTraits.h.

Referenced by TEST().

                                                     {
    return LockTraits<Mutex>::try_lock_upgrade_for(mutex, timeout);
  }

---

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

• proxygen/folly/folly/LockTraits.h