Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. — Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

Boost: enable_shared_from_this.hpp documentation

	enable_shared_from_this.hpp

Purpose

The header defines the class template enable_shared_from_this. It is used as a base class that allows a shared_ptr to the current object to be obtained from within a member function.

enable_shared_from_this defines two member functions called shared_from_this that return a shared_ptr and shared_ptr, depending on constness, to this.

Example

#include 
#include 
#include 

class Y: public boost::enable_shared_from_this
{
public:

    boost::shared_ptr f()
    {
        return shared_from_this();
    }
};

int main()
{
    boost::shared_ptr p(new Y);
    boost::shared_ptr q = p->f();
    assert(p == q);
    assert(!(p < q || q < p)); // p and q must share ownership
}

Synopsis

namespace boost
{

template class enable_shared_from_this
{
public:

    shared_ptr shared_from_this();
    shared_ptr shared_from_this() const;
}

}

template shared_ptr enable_shared_from_this::shared_from_this();

template shared_ptr enable_shared_from_this::shared_from_this() const;

Requires: enable_shared_from_this must be an accessible base class of T. *this must be a subobject of an instance t of type T . There must exist at least one shared_ptr instance p that owns t.

Returns: A shared_ptr instance r that shares ownership with p.

Postconditions: r.get() == this.