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)
Definiert im Header <memory>
template < class T >
class enable_shared_from_this ;
(seit C++11)

std::enable_shared_from_this ermöglicht es einem Objekt t , das aktuell von einem std::shared_ptr namens pt verwaltet wird, sicher zusätzliche std::shared_ptr -Instanzen pt1 , pt2 etc. zu erzeugen, die alle den Besitz von t mit pt teilen.

Das öffentliche Erben von std::enable_shared_from_this<T> stellt dem Typ T eine Memberfunktion shared_from_this zur Verfügung. Wenn ein Objekt t vom Typ T durch einen std:: shared_ptr < T > namens pt verwaltet wird, dann gibt der Aufruf von T::shared_from_this einen neuen std:: shared_ptr < T > zurück, der den Besitz von t mit pt teilt.

Inhaltsverzeichnis

Datenmitglieder

Member Beschreibung
mutable std:: weak_ptr < T > weak_this das Objekt, das den Kontrollblock des ersten gemeinsamen Besitzers von * this verfolgt
( Nur zur Veranschaulichung (exposition-only member object)* )

Memberfunktionen

konstruiert ein enable_shared_from_this Objekt
(geschützte Elementfunktion)
zerstört ein enable_shared_from_this Objekt
(geschützte Elementfunktion)
gibt eine Referenz auf * this zurück
(geschützte Elementfunktion)
gibt einen std::shared_ptr zurück, der den Besitz von * this teilt
(öffentliche Elementfunktion)
gibt einen std::weak_ptr zurück, der den Besitz von * this teilt
(öffentliche Elementfunktion)

Hinweise

Die Konstruktoren von std::shared_ptr erkennen das Vorhandensein einer eindeutigen und zugänglichen (d.h. öffentliche Vererbung ist zwingend erforderlich) enable_shared_from_this Basis und weisen den neu erstellten std::shared_ptr zu weak_this zu, falls nicht bereits im Besitz eines aktiven std::shared_ptr . Das Konstruieren eines std::shared_ptr für ein Objekt, das bereits von einem anderen std::shared_ptr verwaltet wird, wird nicht weak_this konsultieren und führt somit zu undefiniertem Verhalten.

Es ist erlaubt, shared_from_this nur auf einem zuvor geteilten Objekt aufzurufen, d.h. auf einem Objekt, das von std:: shared_ptr < T > verwaltet wird. Andernfalls wird std::bad_weak_ptr geworfen (vom std::shared_ptr -Konstruktor aus einem standardmäßig konstruierten weak_this ).

enable_shared_from_this bietet die sichere Alternative zu einem Ausdruck wie std:: shared_ptr < T > ( this ) , was wahrscheinlich dazu führt, dass this mehrfach durch mehrere voneinander unbekannte Besitzer zerstört wird (siehe Beispiel unten).

Beispiel

#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:
    // Konstruktor ist nur von dieser Klasse verwendbar
    Best(Private) {}
    // Alle anderen müssen diese Fabrikfunktion verwenden
    // Daher werden alle Best-Objekte in shared_ptr enthalten sein
    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()
{
    // Gut: Die beiden shared_ptr teilen sich dasselbe Objekt
    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()
{
    // Schlecht: shared_from_this wird aufgerufen, ohne dass std::shared_ptr den Aufrufer besitzt
    try
    {
        Good not_so_good;
        std::shared_ptr<Good> gp1 = not_so_good.getptr();
    }
    catch (std::bad_weak_ptr& e)
    {
        // undefiniertes Verhalten (bis C++17) und std::bad_weak_ptr geworfen (seit C++17)
        std::cout << e.what() << '\n';
    }
}
void testBest()
{
    // Best: Gleich, kann aber nicht auf dem Stack allokiert werden:
    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; // <- Wird nicht kompilieren, da Best::Best() privat ist.
}
void testBad()
{
    // Schlecht: Jeder shared_ptr denkt, er sei der alleinige Besitzer des Objekts
    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: Doppeltes Löschen von Bad
int main()
{
    testGood();
    misuseGood();
    testBest();
    testBad();
}

Mögliche Ausgabe:

good1.use_count() = 2
bad_weak_ptr
best1.use_count() = 2
bad1.use_count() = 1
Bad::~Bad() aufgerufen
Bad::~Bad() aufgerufen
*** glibc erkannt *** ./test: doppelte Freigabe oder Beschädigung

Fehlerberichte

Die folgenden verhaltensändernden Fehlerberichte wurden rückwirkend auf zuvor veröffentlichte C++-Standards angewendet.

DR Angewendet auf Verhalten wie veröffentlicht Korrektes Verhalten
LWG 2179
( P0033R1 )
C++11 Für einen von enable_shared_from_this abgeleiteten Typ T war das Verhalten beim
Konstruieren zweier std:: shared_ptr < T > vom selben T * Objekt unklar
Das Verhalten ist
in diesem Fall undefiniert
LWG 2529
( P0033R1 )
C++11 Es war unklar, wie der zugrundeliegende std::weak_ptr aktualisiert wird Klarstellung vorgenommen

Siehe auch

(C++11)
Intelligenter Zeiger mit Shared-Object-Ownership-Semantik
(Klassentemplate)
Erstellt einen Shared Pointer, der ein neues Objekt verwaltet
(Funktionstemplate)