folly::detail::distributed_mutex::DistributedMutex< Atomic, TimePublishing >::DistributedMutexStateProxy< Atomic, TimePublishing > Class Template Reference

#include <DistributedMutex-inl.h>

Public Member Functions
	DistributedMutexStateProxy (DistributedMutexStateProxy &&other)
	operator bool () const
	DistributedMutexStateProxy (CachelinePadded< Waiter< Atomic >> *next, std::uintptr_t expected, bool timedWaiter=false, WakerMetadata wakerMetadata={}, CachelinePadded< Waiter< Atomic >> *waiters=nullptr, CachelinePadded< Waiter< Atomic >> *ready=nullptr)

Public Attributes
CachelinePadded< Waiter< Atomic > > *	next_ {nullptr}
std::uintptr_t	expected_ {0}
bool	timedWaiters_ {false}
WakerMetadata	wakerMetadata_ {}
CachelinePadded< Waiter< Atomic > > *	waiters_ {nullptr}
CachelinePadded< Waiter< Atomic > > *	ready_ {nullptr}

Friends
class	DistributedMutex< Atomic, TimePublishing >

Detailed Description

template<template< typename > class Atomic = std::atomic, bool TimePublishing = true>
template<template< typename > class Atomic, bool TimePublishing>
class folly::detail::distributed_mutex::DistributedMutex< Atomic, TimePublishing >::DistributedMutexStateProxy< Atomic, TimePublishing >

Definition at line 229 of file DistributedMutex-inl.h.

Constructor & Destructor Documentation

template<template< typename > class Atomic = std::atomic, bool TimePublishing = true>

template<template< typename > class Atomic, bool TimePublishing>

folly::detail::distributed_mutex::DistributedMutex< Atomic, TimePublishing >::DistributedMutexStateProxy< Atomic, TimePublishing >::DistributedMutexStateProxy ( DistributedMutexStateProxy< Atomic, TimePublishing > &&  other )

inline

DistributedMutexStateProxy is movable, so the caller can contain their critical section by moving the proxy around

Definition at line 233 of file DistributedMutex-inl.h.

References folly::exchange().

      : next_{exchange(other.next_, nullptr)},
        expected_{exchange(other.expected_, 0)},
        wakerMetadata_{exchange(other.wakerMetadata_, {})},
        waiters_{exchange(other.waiters_, nullptr)},
        ready_{exchange(other.ready_, nullptr)} {}

template<template< typename > class Atomic = std::atomic, bool TimePublishing = true>

template<template< typename > class Atomic, bool TimePublishing>

folly::detail::distributed_mutex::DistributedMutex< Atomic, TimePublishing >::DistributedMutexStateProxy< Atomic, TimePublishing >::DistributedMutexStateProxy ( CachelinePadded< Waiter< Atomic >> *  next, std::uintptr_t  expected, bool  timedWaiter = false, WakerMetadata  wakerMetadata = {}, CachelinePadded< Waiter< Atomic >> *  waiters = nullptr, CachelinePadded< Waiter< Atomic >> *  ready = nullptr  )

inline

Definition at line 251 of file DistributedMutex-inl.h.

References cpp.ast::next().

                                    {},
      CachelinePadded<Waiter<Atomic>>* waiters = nullptr,
      CachelinePadded<Waiter<Atomic>>* ready = nullptr)
      : next_{next},
        expected_{expected},
        timedWaiters_{timedWaiter},
        wakerMetadata_{wakerMetadata},
        waiters_{waiters},
        ready_{ready} {}

Member Function Documentation

template<template< typename > class Atomic = std::atomic, bool TimePublishing = true>

template<template< typename > class Atomic, bool TimePublishing>

folly::detail::distributed_mutex::DistributedMutex< Atomic, TimePublishing >::DistributedMutexStateProxy< Atomic, TimePublishing >::operator bool ( ) const

inlineexplicit

The proxy is valid when a mutex acquisition attempt was successful, lock() is guaranteed to return a valid proxy, try_lock() is not

Definition at line 242 of file DistributedMutex-inl.h.

                                 {
    return expected_;
  }

Friends And Related Function Documentation

template<template< typename > class Atomic = std::atomic, bool TimePublishing = true>

template<template< typename > class Atomic, bool TimePublishing>

friend class DistributedMutex< Atomic, TimePublishing >

friend

friend the mutex class, since that will be accessing state private to this class

Definition at line 249 of file DistributedMutex-inl.h.

Member Data Documentation

template<template< typename > class Atomic = std::atomic, bool TimePublishing = true>

template<template< typename > class Atomic, bool TimePublishing>

std::uintptr_t folly::detail::distributed_mutex::DistributedMutex< Atomic, TimePublishing >::DistributedMutexStateProxy< Atomic, TimePublishing >::expected_ {0}

Definition at line 281 of file DistributedMutex-inl.h.

Referenced by folly::detail::distributed_mutex::DistributedMutex< Atomic, TimePublishing >::unlock().

template<template< typename > class Atomic = std::atomic, bool TimePublishing = true>

template<template< typename > class Atomic, bool TimePublishing>

CachelinePadded<Waiter<Atomic> >* folly::detail::distributed_mutex::DistributedMutex< Atomic, TimePublishing >::DistributedMutexStateProxy< Atomic, TimePublishing >::next_ {nullptr}

Definition at line 268 of file DistributedMutex-inl.h.

Referenced by folly::detail::distributed_mutex::DistributedMutex< Atomic, TimePublishing >::unlock().

template<template< typename > class Atomic = std::atomic, bool TimePublishing = true>

template<template< typename > class Atomic, bool TimePublishing>

CachelinePadded<Waiter<Atomic> >* folly::detail::distributed_mutex::DistributedMutex< Atomic, TimePublishing >::DistributedMutexStateProxy< Atomic, TimePublishing >::ready_ {nullptr}

Definition at line 301 of file DistributedMutex-inl.h.

Referenced by folly::detail::distributed_mutex::DistributedMutex< Atomic, TimePublishing >::unlock().

template<template< typename > class Atomic = std::atomic, bool TimePublishing = true>

template<template< typename > class Atomic, bool TimePublishing>

bool folly::detail::distributed_mutex::DistributedMutex< Atomic, TimePublishing >::DistributedMutexStateProxy< Atomic, TimePublishing >::timedWaiters_ {false}

Definition at line 289 of file DistributedMutex-inl.h.

Referenced by folly::detail::distributed_mutex::DistributedMutex< Atomic, TimePublishing >::unlock().

template<template< typename > class Atomic = std::atomic, bool TimePublishing = true>

template<template< typename > class Atomic, bool TimePublishing>

CachelinePadded<Waiter<Atomic> >* folly::detail::distributed_mutex::DistributedMutex< Atomic, TimePublishing >::DistributedMutexStateProxy< Atomic, TimePublishing >::waiters_ {nullptr}

Definition at line 296 of file DistributedMutex-inl.h.

Referenced by folly::detail::distributed_mutex::DistributedMutex< Atomic, TimePublishing >::unlock().

template<template< typename > class Atomic = std::atomic, bool TimePublishing = true>

template<template< typename > class Atomic, bool TimePublishing>

WakerMetadata folly::detail::distributed_mutex::DistributedMutex< Atomic, TimePublishing >::DistributedMutexStateProxy< Atomic, TimePublishing >::wakerMetadata_ {}

Definition at line 291 of file DistributedMutex-inl.h.

Referenced by folly::detail::distributed_mutex::DistributedMutex< Atomic, TimePublishing >::unlock().

---

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

• proxygen/folly/folly/synchronization/DistributedMutex-inl.h