std::enable_shared_from_this
Определён в заголовочном файле <memory> | ||
|---|---|---|
template< class T > class enable_shared_from_this; | (начиная с C++11) |
std::enable_shared_from_this позволяет объекту t, которым в данный момент управляет std::shared_ptr с именем pt, безопасно создавать дополнительные экземпляры std::shared_ptr pt1, pt2 и т. д., которые совместно владеют t вместе с pt.
Публичное наследование от std::enable_shared_from_this<T> предоставляет типу T функцию-член shared_from_this. Если объект t типа T находится под управлением std::shared_ptr<T> с именем pt, то вызов T::shared_from_this вернёт новый std::shared_ptr<T>, который совместно владеет t вместе с pt.
Поля данных
| Член | Описание |
|---|---|
mutablestd::weak_ptr<T> weak_this | объект, отслеживающий управляющий блок первого совместного владельца *this(объект-член, используемый только для описания) |
Функции-члены
создаёт объект enable_shared_from_this (защищённая функция-член) |
|
уничтожает объект enable_shared_from_this (защищённая функция-член) |
|
возвращает ссылку на *this (защищённая функция-член) |
|
возвращает std::shared_ptr, который совместно владеет *this (открытая функция-член) |
|
|
(C++17) | возвращает std::weak_ptr, который совместно владеет *this (открытая функция-член) |
Примечания
Конструкторы std::shared_ptr обнаруживают наличие однозначной и доступной (т. е. публичной) базовой части enable_shared_from_this и присваивают вновь созданный std::shared_ptr объекту weak_this, если он ещё не принадлежит существующему std::shared_ptr. Создание std::shared_ptr для объекта, которым уже управляет другой std::shared_ptr, не обновит weak_this и не приведёт к совместному владению с ним, что повлечёт неопределённое поведение.
Вызов shared_from_this для объекта, которым не управляет std::shared_ptr<T>, приведёт к выбросу std::bad_weak_ptr (поскольку член weak_this находится в состоянии «истёк», а создание std::shared_ptr из истёкшего std::weak_ptr приводит к выбросу исключения).
enable_shared_from_this представляет собой безопасную альтернативу выражению наподобие std::shared_ptr<T>(this), которое, вероятно, приведёт к уничтожению this более одного раза несколькими владельцами, не знающими друг о друге (см. пример ниже).
| Макрос проверки поддержки | Значение | Стандарт | Функция |
|---|---|---|---|
__cpp_lib_constexpr_memory | 202506L | (C++26) | Константные выражения std::enable_shared_from_this |
Пример
#include <iostream>
#include <memory>
class Good : public std::enable_shared_from_this<Good>
{
public:
std::shared_ptr<Good> getptr()
{
return shared_from_this();
}
};
class Best : public std::enable_shared_from_this<Best>
{
struct Private{ explicit Private() = default; };
public:
// Constructor is only usable by this class
Best(Private) {}
// Everyone else has to use this factory function
// Hence all Best objects will be contained in shared_ptr
static std::shared_ptr<Best> create()
{
return std::make_shared<Best>(Private());
}
std::shared_ptr<Best> getptr()
{
return shared_from_this();
}
};
struct Bad
{
std::shared_ptr<Bad> getptr()
{
return std::shared_ptr<Bad>(this);
}
~Bad() { std::cout << "Bad::~Bad() called\n"; }
};
void testGood()
{
// Good: the two shared_ptr's share the same object
std::shared_ptr<Good> good0 = std::make_shared<Good>();
std::shared_ptr<Good> good1 = good0->getptr();
std::cout << "good1.use_count() = " << good1.use_count() << '\n';
}
void misuseGood()
{
// Bad: shared_from_this is called without having std::shared_ptr owning the caller
try
{
Good not_so_good;
std::shared_ptr<Good> gp1 = not_so_good.getptr();
}
catch (std::bad_weak_ptr& e)
{
// undefined behavior (until C++17) and std::bad_weak_ptr thrown (since C++17)
std::cout << e.what() << '\n';
}
}
void testBest()
{
// Best: Same but cannot stack-allocate it:
std::shared_ptr<Best> best0 = Best::create();
std::shared_ptr<Best> best1 = best0->getptr();
std::cout << "best1.use_count() = " << best1.use_count() << '\n';
// Best stackBest; // <- Will not compile: Best::Best() is missing.
// Best stackBest(Best::Private{}); // <- Will not compile: Best::Private is private
}
void testBad()
{
// Bad, each shared_ptr thinks it is the only owner of the object
std::shared_ptr<Bad> bad0 = std::make_shared<Bad>();
std::shared_ptr<Bad> bad1 = bad0->getptr();
std::cout << "bad1.use_count() = " << bad1.use_count() << '\n';
} // UB: double-delete of Bad
int main()
{
testGood();
misuseGood();
testBest();
testBad();
}
Возможный вывод:
good1.use_count() = 2 bad_weak_ptr best1.use_count() = 2 bad1.use_count() = 1 Bad::~Bad() called Bad::~Bad() called *** glibc detected *** ./test: double free or corruption
Отчёты об ошибках
Следующие отчёты об ошибках, изменяющие поведение, были применены ретроактивно к ранее опубликованным стандартам C++.
| DR | Применено к | Опубликованное поведение | Корректное поведение |
|---|---|---|---|
|
LWG 2179 (P0033R1) | C++11 | для типа T, производного от enable_shared_from_this, поведение присоздании двух объектов std::shared_ptr<T> из одного и того же объекта T* было неясным | в этом случае поведение является неопределённым |
|
LWG 2529 (P0033R1) | C++11 | не было ясно, как обновляется базовый std::weak_ptr | прояснено |
См. также
|
(C++11) | умный указатель с семантикой совместного владения объектом (шаблон класса) |
|
(C++20) | создаёт умный указатель совместного владения, управляющий новым объектом (шаблон функции) |
© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/memory/enable_shared_from_this