boost库share_from_this类的作用和实现原理
使用boost库时,经常会看到如下的类
class A:public enable_share_from_this<A>
在什么情况下要使类A继承enable_share_from_this?
使用场合 :当类A被share_ptr管理,且在类A的成员函数里需要把 当前类对象作为参数传给其他函数时,就需要传递一个指向自身的share_ptr。
我们就使类A继承enable_share_from_this,然后通过其成员函数 share_from_this()返回当指向自身的share_ptr。
以上有2个疑惑:
1.把当前类对象作为参数传给其他函数时,为什么要传递share_ptr呢?直接传递this指针不可以吗?
一个裸指针传递给调用者,谁也不知道调用者会干什么?假如调用者delete了该对象,而share_tr此时还指向该对象。
2.这样传递share_ptr可以吗?share_ptr<this>
这样会造成2个非共享的share_ptr指向一个对象,最后造成2次析构该对象。
1 class tcp_connection 2 : public boost::enable_shared_from_this<tcp_connection> 3 { 4 public: 5 typedef boost::shared_ptr<tcp_connection> pointer; 6 7 static pointer create(boost::asio::io_service& io_service) 8 { 9 return pointer(new tcp_connection(io_service)); 10 } 11 12 tcp::socket& socket() 13 { 14 return socket_; 15 } 16 17 void start() 18 { 19 message_ = make_daytime_string(); 20 21 boost::asio::async_write(socket_, boost::asio::buffer(message_), 22 boost::bind(&tcp_connection::handle_write, shared_from_this(), 23 boost::asio::placeholders::error, 24 boost::asio::placeholders::bytes_transferred)); 25 } 26 27 private: 28 tcp_connection(boost::asio::io_service& io_service) 29 : socket_(io_service) 30 { 31 } 32 33 void handle_write(const boost::system::error_code& /*error*/, 34 size_t /*bytes_transferred*/) 35 { 36 } 37 38 tcp::socket socket_; 39 std::string message_; 40 };
类tcp_connection继承enable_share_from_this,在22行里,它的成员函数start(),通过share_from_this返回指向自身的share_ptr。
实现原理:
share_from_this()是如何返回指向该对象的share_ptr的?显然它不能直接return share_ptr<this>。因为它返回的share_ptr必须和管理该对象的share_ptr是共享的,也就是说返回的share_ptr的引用计数和管理该对象的share_ptr的引用计数是相同的。其实enable_share_from_this就存储了管理该对象的share_ptr的引用计数,通过weak_ptr来实现。在enable_share_from_this,里有一个成员weak_this_。
但现在的问题是:何时初始化这个 weak_ptr ?因为类对象生成时还没有生成相应的用来管理这个对象的 shared_ptr 。其实是通过share_ptr的构造函数中初始化这个weak_ptr的.
shared_ptr 定义了如下构造函数:
template<class Y> explicit shared_ptr( Y * p ): px( p ), pn() // Y must be complete { boost::detail::sp_pointer_construct( this, p, pn ); }
里面调用了 boost::detail::sp_pointer_construct
template< class T, class Y > inline void sp_pointer_construct( boost::shared_ptr< T > * ppx, Y * p, boost::detail::shared_count & pn ) { boost::detail::shared_count( p ).swap( pn ); boost::detail::sp_enable_shared_from_this( ppx, p, p ); }
里面又调用了boost::detail::sp_enable_shared_from_this
share_ptr有2个该重载函数
template< class X, class Y, class T > inline void sp_enable_shared_from_this( boost::shared_ptr<X> const * ppx, Y const * py, boost::enable_shared_from_this< T > const * pe ) { if( pe != 0 ) { pe->_internal_accept_owner( ppx, const_cast< Y* >( py ) ); } }
inline void sp_enable_shared_from_this( ... ) { }
由于我们的类是继承enable_share_from_this,所以调用的是前者
里面又调用了 enable_shared_from_this 的 _internal_accept_owner :
template<class X, class Y> void _internal_accept_owner(shared_ptr<X> const * ppx, Y * py) const { if (weak_this_.expired()) { weak_this_ = shared_ptr<T>(*ppx, py); } }
最后,在这里对enable_shared_from_this 的成员 weak_this_ 进行拷贝赋值,使得整个 weak_ptr 作为类对象shared_ptr 的一个观察者。当调用share_from_this()时,就可以从这个 weak_ptr 来生成了,且引用计数是相同的。
shared_ptr<T const> shared_from_this() const { shared_ptr<T const> p( weak_this_ ); BOOST_ASSERT( p.get() == this ); return p; }