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)
Défini dans l'en-tête <memory>
template < class T >
class enable_shared_from_this ;
(depuis C++11)

std::enable_shared_from_this permet à un objet t actuellement géré par un std::shared_ptr nommé pt de générer de manière sécurisée des instances supplémentaires de std::shared_ptr telles que pt1 , pt2 etc., qui partagent toutes la propriété de t avec pt .

L'héritage public de std::enable_shared_from_this<T> fournit au type T une fonction membre shared_from_this . Si un objet t de type T est géré par un std:: shared_ptr < T > nommé pt , alors l'appel à T::shared_from_this retournera un nouveau std:: shared_ptr < T > qui partage la propriété de t avec pt .

Table des matières

Membres de données

Membre Description
mutable std:: weak_ptr < T > weak_this l'objet suivant le bloc de contrôle du premier propriétaire partagé de * this
( objet membre d'exposition uniquement* )

Fonctions membres

construit un objet enable_shared_from_this
(fonction membre protégée)
détruit un objet enable_shared_from_this
(fonction membre protégée)
retourne une référence vers * this
(fonction membre protégée)
retourne un std::shared_ptr qui partage la propriété de * this
(fonction membre publique)
retourne un std::weak_ptr qui partage la propriété de * this
(fonction membre publique)

Notes

Les constructeurs de std::shared_ptr détectent la présence d'une base enable_shared_from_this non ambiguë et accessible (c'est-à-dire que l'héritage public est obligatoire) et assignent le nouveau std::shared_ptr créé à weak_this s'il n'est pas déjà détenu par un std::shared_ptr actif. Construire un std::shared_ptr pour un objet déjà géré par un autre std::shared_ptr ne consultera pas weak_this et conduira donc à un comportement indéfini.

Il est permis d'appeler shared_from_this uniquement sur un objet préalablement partagé, c'est-à-dire sur un objet géré par std:: shared_ptr < T > . Sinon, std::bad_weak_ptr est levée (par le constructeur de std::shared_ptr à partir d'un weak_this construit par défaut).

enable_shared_from_this fournit l'alternative sûre à une expression comme std:: shared_ptr < T > ( this ) , ce qui risquerait d'entraîner this d'être détruit plusieurs fois par de multiples propriétaires qui ne sont pas conscients les uns des autres (voir l'exemple ci-dessous).

Exemple

#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:
    // Le constructeur est uniquement utilisable par cette classe
    Best(Private) {}
    // Tous les autres doivent utiliser cette fonction de fabrique
    // Ainsi tous les objets Best seront contenus dans 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()
{
    // Bon : les deux shared_ptr partagent le même objet
    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()
{
    // Mauvais : shared_from_this est appelé sans avoir std::shared_ptr possédant l'appelant
    try
    {
        Good not_so_good;
        std::shared_ptr<Good> gp1 = not_so_good.getptr();
    }
    catch (std::bad_weak_ptr& e)
    {
        // comportement indéfini (avant C++17) et std::bad_weak_ptr levé (depuis C++17)
        std::cout << e.what() << '\n';
    }
}
void testBest()
{
    // Meilleur : Identique mais ne peut pas être alloué sur la pile :
    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; // <- Ne compilera pas car Best::Best() est privé.
}
void testBad()
{
    // Mauvais, chaque shared_ptr pense être le seul propriétaire de l'objet
    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';
} // CU : double suppression de Bad
int main()
{
    testGood();
    misuseGood();
    testBest();
    testBad();
}

Sortie possible :

good1.use_count() = 2
bad_weak_ptr
best1.use_count() = 2
bad1.use_count() = 1
Bad::~Bad() appelé
Bad::~Bad() appelé
*** glibc détecté *** ./test : double libération ou corruption

Rapports de défauts

Les rapports de défauts modifiant le comportement suivants ont été appliqués rétroactivement aux normes C++ précédemment publiées.

DR Applicable à Comportement publié Comportement corrigé
LWG 2179
( P0033R1 )
C++11 pour un type T dérivé de enable_shared_from_this , le comportement de
construction de deux std:: shared_ptr < T > à partir du même objet T * était ambigu
le comportement est
indéfini dans ce cas
LWG 2529
( P0033R1 )
C++11 il n'était pas clair comment le std::weak_ptr sous-jacent est mis à jour clarifié

Voir aussi

(C++11)
pointeur intelligent avec sémantique de propriété partagée d'objet
(modèle de classe)
crée un pointeur partagé qui gère un nouvel objet
(modèle de fonction)