quickcpplib::_xxx::configurable_spinlock::lockable_ptr< T > Struct Template Reference

Lets you use a pointer to memory as a spinlock :) More...

#include "spinlock.hpp"

Inheritance diagram for quickcpplib::_xxx::configurable_spinlock::lockable_ptr< T >:

Public Member Functions
constexpr	lockable_ptr (T *v=nullptr)
T *	get () noexcept
	Returns the memory pointer part of the atomic.
const T *	get () const noexcept
	Returns the memory pointer part of the atomic.
T &	operator* () noexcept
const T &	operator* () const noexcept
T *	operator-> () noexcept
const T *	operator-> () const noexcept

Public Attributes
T	ptr
	STL member.

Detailed Description

template<typename T>
struct quickcpplib::_xxx::configurable_spinlock::lockable_ptr< T >

Lets you use a pointer to memory as a spinlock :)

Template Parameters

T	The type of the pointer

Constructor & Destructor Documentation

lockable_ptr()

template<typename T >

constexpr quickcpplib::_xxx::configurable_spinlock::lockable_ptr< T >::lockable_ptr ( T *  v = nullptr )

inlineconstexpr

        : atomic<T *>(v)
    {
    }

Member Function Documentation

get() [1/2]

template<typename T >

T * quickcpplib::_xxx::configurable_spinlock::lockable_ptr< T >::get ( )

inlinenoexcept

Returns the memory pointer part of the atomic.

    {
      union
      {
        T *v;
        size_t n;
      } value;
      value.v = atomic<T *>::load(memory_order_relaxed);
      value.n &= ~(size_t) 1;
      return value.v;
    }

get() [2/2]

template<typename T >

const T * quickcpplib::_xxx::configurable_spinlock::lockable_ptr< T >::get ( ) const

inlinenoexcept

Returns the memory pointer part of the atomic.

    {
      union
      {
        T *v;
        size_t n;
      } value;
      value.v = atomic<T *>::load(memory_order_relaxed);
      value.n &= ~(size_t) 1;
      return value.v;
    }

operator*() [1/2]

template<typename T >

T & quickcpplib::_xxx::configurable_spinlock::lockable_ptr< T >::operator* ( )

inlinenoexcept

{ return *get(); }

operator*() [2/2]

template<typename T >

const T & quickcpplib::_xxx::configurable_spinlock::lockable_ptr< T >::operator* ( ) const

inlinenoexcept

{ return *get(); }

operator->() [1/2]

template<typename T >

T * quickcpplib::_xxx::configurable_spinlock::lockable_ptr< T >::operator-> ( )

inlinenoexcept

{ return get(); }

operator->() [2/2]

template<typename T >

const T * quickcpplib::_xxx::configurable_spinlock::lockable_ptr< T >::operator-> ( ) const

inlinenoexcept

{ return get(); }

Member Data Documentation

ptr

T std::atomic< T >::ptr

inherited

STL member.

---

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

• include/quickcpplib/spinlock.hpp