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.

Члены-функции

(конструктор)	создаёт объект `enable_shared_from_this` (защищённая член-функция)
(деструктор)	уничтожает объект `enable_shared_from_this` (защищённая член-функция)
operator=	возвращает ссылку на `*this` (защищённая член-функция)
shared_from_this	возвращает `std::shared_ptr`, который разделяет владение `*this` (общедоступная член-функция)
weak_from_this (C++17)	возвращает `std::weak_ptr`, который разделяет владение `*this` (общедоступная член-функция)

Члены-объекты

Имя члена	Определение
`weak-this` (только для экспонирования)	Объект `std::weak_ptr`, отслеживающий блок управления первым общим владельцем `*this`.

Примечания

Общим реализацией для enable_shared_from_this является хранение слабой ссылки (такой как std::weak_ptr) на *this. Для целей экспонирования слабая ссылка называется weak-this и рассматривается как изменяемый std::weak_ptr член.

Конструкторы 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 (конструктором shared_ptr из созданного по умолчанию weak-this).

enable_shared_from_this предоставляет безопасную альтернативу выражению вроде std::shared_ptr<T>(this), которое, вероятно, приведёт к тому, что 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{};
 
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 can't 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 because Best::Best() is private.
}
 
void testBad()
{
    // Bad, each shared_ptr thinks it's 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++.

Отчёт об ошибке	Применяется к	Поведение при публикации	Корректное поведение
LWG 2529	C++11	Спецификация для `enable_shared_from_this` была неясной и, возможно, нереализуемой	Прояснили и исправили

См. также

shared_ptr (C++11)	смарт-указатель со семантикой совместного владения объектом (шаблон класса)
make_sharedmake_shared_for_overwrite (C++20)	создаёт смарт-указатель, управляющий новым объектом (шаблон функции)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/memory/enable_shared_from_this