Botan 3.0.0-alpha0
Crypto and TLS for C&
Public Member Functions | List of all members
Botan::Atomic< T > Class Template Referencefinal

#include <atomic.h>

Public Member Functions

 Atomic ()=default
 
 Atomic (const Atomic &data)
 
 Atomic (const std::atomic< T > &data)
 
 operator std::atomic< T > & ()
 
 operator T ()
 
Atomicoperator= (const Atomic &a)
 
Atomicoperator= (const std::atomic< T > &a)
 
 ~Atomic ()=default
 

Detailed Description

template<typename T>
class Botan::Atomic< T >

Simple helper class to expand std::atomic with copy constructor and copy assignment operator, i.e. for use as element in a container like std::vector. The construction of instances of this wrapper is NOT atomic and needs to be properly guarded.

Definition at line 24 of file atomic.h.

Constructor & Destructor Documentation

◆ Atomic() [1/3]

template<typename T >
Botan::Atomic< T >::Atomic ( )
default

◆ Atomic() [2/3]

template<typename T >
Botan::Atomic< T >::Atomic ( const Atomic< T > &  data)
inline

Definition at line 28 of file atomic.h.

28: m_data(data.m_data.load()) {}

◆ Atomic() [3/3]

template<typename T >
Botan::Atomic< T >::Atomic ( const std::atomic< T > &  data)
inline

Definition at line 29 of file atomic.h.

29: m_data(data.load()) {}

◆ ~Atomic()

template<typename T >
Botan::Atomic< T >::~Atomic ( )
default

Member Function Documentation

◆ operator std::atomic< T > &()

template<typename T >
Botan::Atomic< T >::operator std::atomic< T > & ( )
inline

Definition at line 44 of file atomic.h.

44{ return m_data; }

◆ operator T()

template<typename T >
Botan::Atomic< T >::operator T ( )
inline

Definition at line 45 of file atomic.h.

45{ return m_data.load(); }

◆ operator=() [1/2]

template<typename T >
Atomic & Botan::Atomic< T >::operator= ( const Atomic< T > &  a)
inline

Definition at line 32 of file atomic.h.

33 {
34 m_data.store(a.m_data.load());
35 return *this;
36 }

◆ operator=() [2/2]

template<typename T >
Atomic & Botan::Atomic< T >::operator= ( const std::atomic< T > &  a)
inline

Definition at line 38 of file atomic.h.

39 {
40 m_data.store(a.load());
41 return *this;
42 }

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