Namespaces
Variants

std:: enable_shared_from_this

From cppreference.net
Memory management library
( exposition only* )
Allocators
Uninitialized memory algorithms
Constrained uninitialized memory algorithms
Memory resources
Uninitialized storage (until C++20)
( until C++20* )
( until C++20* )
( until C++20* )

Garbage collector support (until C++23)
(C++11) (until C++23)
(C++11) (until C++23)
(C++11) (until C++23)
(C++11) (until C++23)
(C++11) (until C++23)
(C++11) (until C++23)
Определено в заголовочном файле <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 .

Содержание

Члены данных

Участник Описание
mutable std:: weak_ptr < T > weak_this объект, отслеживающий блок управления первого общего владельца * this
( объект-участник только для демонстрации* )

Функции-члены

создает объект enable_shared_from_this
(защищенная функция-член)
уничтожает объект enable_shared_from_this
(защищенная функция-член)
возвращает ссылку на * this
(защищенная функция-член)
возвращает std::shared_ptr с разделяемым владением * this
(публичная функция-член)
возвращает 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 (конструктором std::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{ explicit Private() = default; };
public:
    // Конструктор доступен только для этого класса
    Best(Private) {}
    // Все остальные должны использовать эту фабричную функцию
    // Следовательно, все объекты Best будут содержаться в 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()
{
    // Хорошо: два shared_ptr разделяют один объект
    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()
{
    // Плохо: shared_from_this вызывается без наличия std::shared_ptr, владеющего вызывающим объектом
    try
    {
        Good not_so_good;
        std::shared_ptr<Good> gp1 = not_so_good.getptr();
    }
    catch (std::bad_weak_ptr& e)
    {
        // неопределенное поведение (до C++17) и исключение std::bad_weak_ptr (начиная с C++17)
        std::cout << e.what() << '\n';
    }
}
void testBest()
{
    // Лучше: То же самое, но нельзя разместить в стеке:
    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; // <- Не скомпилируется, потому что Best::Best() приватный.
}
void testBad()
{
    // Плохо: каждый shared_ptr считает себя единственным владельцем объекта
    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';
} // НП: двойное удаление 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)
умный указатель с семантикой совместного владения объектом
(шаблон класса)
создает shared pointer, который управляет новым объектом
(шаблон функции)