atomic< T > 模板结构体 参考

通用原子类型模板 更多...

#include <atomic.hpp>

Public 类型
using	value_type = T
	值类型

Public 成员函数
constexpr	atomic (T value) noexcept
	构造函数
	operator T () const noexcept
	类型转换运算符
	operator T () const volatile noexcept
	volatile版本的类型转换运算符
T	operator= (T value) noexcept
	赋值运算符
T	operator= (T value) volatile noexcept
	volatile版本的赋值运算符
bool	is_lock_free () const noexcept
	检查是否支持无锁操作
bool	is_lock_free () const volatile noexcept
	volatile版本的检查是否支持无锁操作
void	store (T value, const memory_order mo=memory_order_seq_cst) noexcept
	原子存储操作
void	store (T value, const memory_order mo=memory_order_seq_cst) volatile noexcept
	volatile版本的原子存储操作
T	load (const memory_order mo=memory_order_seq_cst) const noexcept
	原子加载操作
T	load (const memory_order mo=memory_order_seq_cst) const volatile noexcept
	volatile版本的原子加载操作
T	exchange (T value, const memory_order mo=memory_order_seq_cst) noexcept
	原子交换操作
T	exchange (T value, const memory_order mo=memory_order_seq_cst) volatile noexcept
	volatile版本的原子交换操作
bool	compare_exchange_weak (T &expected, T desired, const memory_order success, const memory_order failure) noexcept
	弱比较交换操作
bool	compare_exchange_weak (T &expected, T desired, const memory_order success, const memory_order failure) volatile noexcept
	volatile版本的弱比较交换操作
bool	compare_exchange_weak (T &expected, T desired, const memory_order mo=memory_order_seq_cst) noexcept
	简化版弱比较交换操作
bool	compare_exchange_weak (T &expected, T desired, const memory_order mo=memory_order_seq_cst) volatile noexcept
	volatile版本的简化版弱比较交换操作
bool	compare_exchange_strong (T &expected, T desired, const memory_order success, const memory_order failure) noexcept
	强比较交换操作
bool	compare_exchange_strong (T &expected, T desired, const memory_order success, const memory_order failure) volatile noexcept
	volatile版本的强比较交换操作
bool	compare_exchange_strong (T &expected, T value, const memory_order mo=memory_order_seq_cst) noexcept
	简化版强比较交换操作
bool	compare_exchange_strong (T &expected, T value, const memory_order mo=memory_order_seq_cst) volatile noexcept
	volatile版本的简化版强比较交换操作

静态 Public 属性
static constexpr bool	is_always_lock_free = _MSTL is_always_lock_free<sizeof(value_), align_inner>()
	是否总是无锁

详细描述

template<typename T>
struct atomic< T >

通用原子类型模板

模板参数

T

值类型

提供通用类型的原子操作，支持任意可平凡复制的类型。

在文件 atomic.hpp 第 40 行定义.

构造及析构函数说明

atomic()

template<typename T>

atomic< T >::atomic ( T value )

inlineconstexprnoexcept

构造函数

参数

value

初始值

在文件 atomic.hpp 第 66 行定义.

成员函数说明

compare_exchange_strong() [1/2]

template<typename T>

bool atomic< T >::compare_exchange_strong ( T & expected, T desired, const memory_order success, const memory_order failure )

inlinenoexcept

强比较交换操作

参数

expected	期望值
desired	期望设置的值
success	成功时的内存顺序
failure	失败时的内存顺序

返回

是否交换成功

在文件 atomic.hpp 第 217 行定义.

被这些函数引用 once_flag::call_once, atomic< int8_t >::compare_exchange_strong(), atomic< int8_t >::compare_exchange_strong() , 以及 lock_free_queue< T >::push().

compare_exchange_strong() [2/2]

template<typename T>

bool atomic< T >::compare_exchange_strong ( T & expected, T value, const memory_order mo = memory_order_seq_cst )

inlinenoexcept

简化版强比较交换操作

参数

expected	期望值
value	期望设置的值
mo	内存顺序

返回

是否交换成功

在文件 atomic.hpp 第 243 行定义.

compare_exchange_weak() [1/2]

template<typename T>

bool atomic< T >::compare_exchange_weak ( T & expected, T desired, const memory_order mo = memory_order_seq_cst )

inlinenoexcept

简化版弱比较交换操作

参数

expected	期望值
desired	期望设置的值
mo	内存顺序

返回

是否交换成功

在文件 atomic.hpp 第 196 行定义.

compare_exchange_weak() [2/2]

template<typename T>

bool atomic< T >::compare_exchange_weak ( T & expected, T desired, const memory_order success, const memory_order failure )

inlinenoexcept

弱比较交换操作

参数

expected	期望值
desired	期望设置的值
success	成功时的内存顺序
failure	失败时的内存顺序

返回

是否交换成功

在文件 atomic.hpp 第 174 行定义.

被这些函数引用 atomic< int8_t >::compare_exchange_weak() , 以及 atomic< int8_t >::compare_exchange_weak().

exchange()

template<typename T>

T atomic< T >::exchange ( T value, const memory_order mo = memory_order_seq_cst )

inlinenoexcept

原子交换操作

参数

value	要交换的值
mo	内存顺序

返回

交换前的值

在文件 atomic.hpp 第 155 行定义.

被这些函数引用 lock_free_queue< T >::pop() , 以及 lock_free_queue< T >::try_pop().

is_lock_free()

template<typename T>

bool atomic< T >::is_lock_free ( ) const

inlinenoexcept

检查是否支持无锁操作

返回

是否支持无锁

在文件 atomic.hpp 第 106 行定义.

load()

template<typename T>

T atomic< T >::load ( const memory_order mo = memory_order_seq_cst ) const

inlinenoexcept

原子加载操作

参数

mo

内存顺序

返回

加载的值

在文件 atomic.hpp 第 138 行定义.

被这些函数引用 once_flag::call_once, atomic< bool >::operator bool(), atomic< bool >::operator bool(), lock_free_queue< T >::pop(), lock_free_queue< T >::push() , 以及 lock_free_queue< T >::try_pop().

operator T()

template<typename T>

atomic< T >::operator T ( ) const

inlinenoexcept

类型转换运算符

返回

当前值

在文件 atomic.hpp 第 73 行定义.

operator=()

template<typename T>

T atomic< T >::operator= ( T value )

inlinenoexcept

赋值运算符

参数

value

要设置的值

返回

设置后的值

在文件 atomic.hpp 第 89 行定义.

store()

template<typename T>

void atomic< T >::store ( T value, const memory_order mo = memory_order_seq_cst )

inlinenoexcept

原子存储操作

参数

value	要存储的值
mo	内存顺序

在文件 atomic.hpp 第 122 行定义.

被这些函数引用 once_flag::call_once, atomic< int8_t >::operator=() , 以及 atomic< int8_t >::operator=().

---

该结构体的文档由以下文件生成:

• atomic.hpp