std::shared_ptr<T>::use_count
来自 cppreference.cn
< cpp | memory | shared ptr
long use_count() const noexcept; |
||
返回管理当前对象的不同 shared_ptr
实例的数量(包括 *this)。如果没有被管理的对象,则返回 0。
在多线程环境中,use_count 原子地检索实例的数量(典型实现使用 memory_order_relaxed 加载)。
目录 |
[编辑] 参数
(无)
[编辑] 返回值
管理当前对象的 std::shared_ptr 实例的数量,如果没有被管理的对象,则返回 0。
[编辑] 注释
常见用例包括
- 与 0 比较。如果
use_count
返回零,则共享指针是空的,并且不管理任何对象(无论其存储的指针是否为 nullptr)。 - 与 1 比较。如果
use_count
返回 1,则没有其他所有者。已弃用(自 C++17 起) 成员函数 unique() 提供了此用例。(直到 C++20)
在多线程环境中
use_count
返回的值应被视为近似值,因为共享所有者的数量可能在原子检索和值的有意义使用之间在其他线程中发生变化。当 use_count
返回 1 时,并不意味着可以安全地修改对象,因为先前共享所有者对被管理对象的访问可能尚未完成,并且因为新的共享所有者可能会并发引入,例如通过 std::weak_ptr::lock。仅当 use_count
返回 0 时,计数才是准确的。
[编辑] 示例
运行此代码
#include <iostream> #include <memory> void fun(std::shared_ptr<int> sp) { std::cout << "in fun(): sp.use_count() == " << sp.use_count() << " (object @ " << sp << ")\n"; } int main() { auto sp1 = std::make_shared<int>(5); std::cout << "in main(): sp1.use_count() == " << sp1.use_count() << " (object @ " << sp1 << ")\n"; fun(sp1); }
可能的输出
in main(): sp1.use_count() == 1 (object @ 0x20eec30) in fun(): sp.use_count() == 2 (object @ 0x20eec30)
[编辑] 参见
(直到 C++20) |
检查被管理对象是否仅由当前 shared_ptr 对象管理(公共成员函数) |