OpenDDS::DCPS::RcHandle< T > Class Template Reference

#include <RcHandle_T.h>

Collaboration diagram for OpenDDS::DCPS::RcHandle< T >:

Public Member Functions
	RcHandle ()
	RcHandle (T *p, keep_count)
template<typename U >
	RcHandle (unique_ptr< U > p)
	RcHandle (T *p, inc_count)
template<typename U >
	RcHandle (const RcHandle< U > &other)
	RcHandle (const RcHandle &b)
	~RcHandle ()
void	reset ()
template<typename U >
void	reset (T *p, U counting_strategy)
RcHandle &	operator= (const RcHandle &b)
template<class U >
RcHandle &	operator= (const RcHandle< U > &b)
template<typename U >
RcHandle &	operator= (unique_ptr< U > b)
void	swap (RcHandle &rhs)
T *	operator-> () const
T &	operator* () const
bool	is_nil () const
T *	in () const
T *	get () const
T *&	inout ()
T *&	out ()
T *	_retn ()
	operator bool () const
bool	operator== (const RcHandle &rhs) const
bool	operator!= (const RcHandle &rhs) const
bool	operator< (const RcHandle &rhs) const

Private Member Functions
void	bump_up ()
void	bump_down ()

Private Attributes
T *	ptr_
	The actual "unsmart" pointer to the T object. More...

Detailed Description

template<typename T>
class OpenDDS::DCPS::RcHandle< T >

Templated Reference counted handle to a pointer. A non-DDS specific helper class.

Definition at line 24 of file RcHandle_T.h.

Constructor & Destructor Documentation

RcHandle() [1/6]

template<typename T>

OpenDDS::DCPS::RcHandle< T >::RcHandle ( )

inline

Definition at line 26 of file RcHandle_T.h.

    : ptr_(0)
  {
  }

RcHandle() [2/6]

template<typename T>

OpenDDS::DCPS::RcHandle< T >::RcHandle ( T *  p, keep_count    )

inline

Definition at line 31 of file RcHandle_T.h.

    : ptr_(p)
  {
  }

RcHandle() [3/6]

template<typename T>

template<typename U >

OpenDDS::DCPS::RcHandle< T >::RcHandle ( unique_ptr< U >  p )

inline

Definition at line 37 of file RcHandle_T.h.

    : ptr_(p.release())
  {
  }

RcHandle() [4/6]

template<typename T>

OpenDDS::DCPS::RcHandle< T >::RcHandle ( T *  p, inc_count    )

inline

Definition at line 42 of file RcHandle_T.h.

    : ptr_(p)
  {
    this->bump_up();
  }

RcHandle() [5/6]

template<typename T>

template<typename U >

OpenDDS::DCPS::RcHandle< T >::RcHandle ( const RcHandle< U > &  other )

inline

Definition at line 49 of file RcHandle_T.h.

    : ptr_(other.in())
  {
    this->bump_up();
  }

RcHandle() [6/6]

template<typename T>

OpenDDS::DCPS::RcHandle< T >::RcHandle ( const RcHandle< T > &  b )

inline

Definition at line 55 of file RcHandle_T.h.

    : ptr_(b.ptr_)
  {
    this->bump_up();
  }

~RcHandle()

template<typename T>

OpenDDS::DCPS::RcHandle< T >::~RcHandle ( )

inline

Definition at line 61 of file RcHandle_T.h.

  {
    this->bump_down();
  }

Member Function Documentation

_retn()

template<typename T>

T* OpenDDS::DCPS::RcHandle< T >::_retn ( void  )

inline

Definition at line 147 of file RcHandle_T.h.

Referenced by OpenDDS::DCPS::DomainParticipantFactoryImpl::create_participant(), OpenDDS::DCPS::DataWriterImpl::find_instance(), and OpenDDS::XTypes::DynamicDataWriterImpl::get_key_value().

  {
    T* retval = this->ptr_;
    this->ptr_ = 0;
    return retval;
  }

bump_down()

template<typename T>

void OpenDDS::DCPS::RcHandle< T >::bump_down ( )

inlineprivate

Definition at line 182 of file RcHandle_T.h.

  {
    if (ptr_ != 0) {
      ptr_->_remove_ref();
      ptr_ = 0;
    }
  }

bump_up()

template<typename T>

void OpenDDS::DCPS::RcHandle< T >::bump_up ( )

inlineprivate

Definition at line 175 of file RcHandle_T.h.

  {
    if (ptr_ != 0) {
      ptr_->_add_ref();
    }
  }

get()

template<typename T>

T* OpenDDS::DCPS::RcHandle< T >::get ( void  ) const

inline

Definition at line 131 of file RcHandle_T.h.

Referenced by TAO_DDS_DCPSInfo_i::add_domain_participant(), OpenDDS::DCPS::DataReaderImpl::data_received(), OpenDDS::DCPS::SubscriberImpl::delete_datareader(), OpenDDS::DCPS::Service_Participant::get_static_xtypes_lock(), and DCPS_IR_Domain::remove_participant().

  {
    return this->ptr_;
  }

in()

template<typename T>

T* OpenDDS::DCPS::RcHandle< T >::in ( void  ) const

inline

Definition at line 126 of file RcHandle_T.h.

Referenced by OpenDDS::DCPS::TcpTransport::accept_datalink(), OpenDDS::DCPS::DataReaderImpl::accept_sample_processing(), OpenDDS::DCPS::DataWriterRemoteImpl::add_association(), OpenDDS::DCPS::RecorderImpl::add_association(), TAO_DDS_DCPSInfo_i::add_domain_participant(), DCPS_IR_Domain::add_participant(), OpenDDS::DCPS::ReplayerImpl::association_complete_i(), OpenDDS::DCPS::DataWriterImpl::association_complete_i(), OpenDDS::DCPS::TcpTransport::async_connect_failed(), OpenDDS::DCPS::DataReaderImpl::coherent_changes_completed(), OpenDDS::DCPS::ComparatorBase::compare(), OpenDDS::DCPS::TcpTransport::connect_datalink(), OpenDDS::DCPS::const_rchandle_cast(), OpenDDS::DCPS::SubscriberImpl::create_datareader(), OpenDDS::DCPS::DomainParticipantFactoryImpl::create_participant(), OpenDDS::DCPS::TransportImpl::create_reactor_task(), OpenDDS::DCPS::RecorderImpl::data_received(), OpenDDS::DCPS::DataReaderImpl::data_received(), OpenDDS::DCPS::DataLink::data_received_i(), OpenDDS::DCPS::PublisherImpl::delete_contained_entities(), OpenDDS::DCPS::TransportClient::disassociate(), OpenDDS::DCPS::dynamic_rchandle_cast(), OpenDDS::DCPS::TransportClient::PendingAssocTimer::ScheduleCommand::execute(), OpenDDS::DCPS::DataReaderImpl::OnDataOnReaders::execute(), OpenDDS::DCPS::DataReaderImpl::OnDataAvailable::execute(), OpenDDS::DCPS::TcpTransport::find_datalink_i(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::finish_store_instance_data(), OpenDDS::DCPS::TcpTransport::fresh_link(), OpenDDS::DCPS::GroupRakeData::get_datareaders(), OpenDDS::DCPS::DataReaderImpl::get_matched_publication_data(), OpenDDS::DCPS::DataWriterImpl::get_matched_subscription_data(), OpenDDS::DCPS::MulticastLoader::init(), OpenDDS::RTPS::RtpsDiscovery::init_bit(), OpenDDS::DCPS::StaticDiscovery::init_bit(), OpenDDS::DCPS::MonitorFactoryImpl::initialize(), OpenDDS::Federator::ManagerImpl::initialize(), OpenDDS::RTPS::Sedp::match_continue(), OpenDDS::DCPS::RcHandle< OpenDDS::DCPS::DataReaderImpl::LivelinessTimer >::operator!=(), OpenDDS::DCPS::RakeResults< MessageType >::SortedSetCmp::operator()(), OpenDDS::DCPS::RcHandle< OpenDDS::DCPS::DataReaderImpl::LivelinessTimer >::operator<(), OpenDDS::DCPS::RcHandle< OpenDDS::DCPS::DataReaderImpl::LivelinessTimer >::operator==(), DCPS_IR_Domain::participant(), OpenDDS::DCPS::MulticastDataLink::receive_strategy(), OpenDDS::DCPS::TcpDataLink::reconnect(), OpenDDS::DCPS::WriteDataContainer::register_instance(), OpenDDS::DCPS::TcpTransport::release_datalink(), OpenDDS::DCPS::DataWriterRemoteImpl::remove_associations(), OpenDDS::DCPS::ReplayerImpl::remove_associations(), OpenDDS::DCPS::RecorderImpl::remove_associations_i(), DCPS_IR_Domain::remove_dead_participants(), DCPS_IR_Domain::remove_participant(), OpenDDS::DCPS::DataWriterImpl::replay_durable_data_for(), OpenDDS::DCPS::TcpDataLink::reuse_existing_connection(), OpenDDS::DCPS::RtpsUdpDataLink::RtpsWriter::RtpsWriter(), OpenDDS::DCPS::DataLinkSet::send_control(), OpenDDS::DCPS::TransportClient::send_i(), OpenDDS::DCPS::MulticastDataLink::send_strategy(), OpenDDS::DCPS::OwnershipManager::set_instance_map(), OpenDDS::DCPS::TcpReceiveStrategy::start_i(), OpenDDS::DCPS::static_rchandle_cast(), OpenDDS::DCPS::DataWriterRemoteImpl::update_incompatible_qos(), OpenDDS::DCPS::DataWriterRemoteImpl::update_subscription_params(), OpenDDS::DCPS::TransportClient::use_datalink_i(), and OpenDDS::DCPS::PublisherImpl::wait_for_acknowledgments().

  {
    return this->ptr_;
  }

inout()

template<typename T>

T*& OpenDDS::DCPS::RcHandle< T >::inout ( void  )

inline

Definition at line 136 of file RcHandle_T.h.

  {
    return this->ptr_;
  }

is_nil()

template<typename T>

bool OpenDDS::DCPS::RcHandle< T >::is_nil ( void  ) const

inline

Definition at line 121 of file RcHandle_T.h.

Referenced by OpenDDS::DCPS::MulticastTransport::accept_datalink(), OpenDDS::DCPS::TcpTransport::accept_datalink(), OpenDDS::DCPS::StaticDiscovery::add_domain_participant(), OpenDDS::DCPS::DataLink::add_on_start_callback(), OpenDDS::DCPS::TransportClient::associate(), OpenDDS::DCPS::TransportRegistry::bind_config(), OpenDDS::DCPS::InfoRepoDiscovery::bit_config(), OpenDDS::DCPS::UdpTransport::connect_datalink(), OpenDDS::DCPS::MulticastTransport::connect_datalink(), OpenDDS::Security::SecurityRegistry::create_config(), OpenDDS::DCPS::DataLink::data_received_i(), OpenDDS::DCPS::DomainParticipantImpl::enable(), OpenDDS::DCPS::TransportClient::enable_transport(), OpenDDS::DCPS::MulticastDataLink::find_or_create_session(), OpenDDS::DCPS::TransportRegistry::fix_empty_default(), OpenDDS::DCPS::TcpTransport::fresh_link(), OpenDDS::DCPS::MonitorFactoryImpl::initialize(), OpenDDS::DCPS::TransportClient::PendingAssoc::initiate_connect(), OpenDDS::DCPS::ReceiveListenerSetMap::insert(), OpenDDS::DCPS::RtpsUdpDataLink::MultiSendBuffer::insert(), OpenDDS::DCPS::Service_Participant::load_domain_configuration(), OpenDDS::DCPS::DataLink::make_reservation(), OpenDDS::FaceTSS::config::Parser::parse(), OpenDDS::DCPS::StaticDiscovery::parse_endpoints(), OpenDDS::DCPS::TcpTransport::passive_connection(), OpenDDS::DCPS::TransportImpl::reactor(), FACE::TS::Receive_Message(), OpenDDS::DCPS::DataLink::release_reservations(), OpenDDS::FileSystemStorage::Directory::remove(), OpenDDS::DCPS::DataLink::remove_all_msgs(), OpenDDS::DCPS::DataLink::remove_sample(), OpenDDS::Federator::ManagerImpl::repository(), OpenDDS::DCPS::TcpDataLink::reuse_existing_connection(), OpenDDS::DCPS::TransportClient::send_i(), OpenDDS::DCPS::DataLink::send_start_i(), OpenDDS::DCPS::DataLink::send_stop_i(), OpenDDS::DCPS::TransportImpl::shutdown(), OpenDDS::DCPS::DataLink::start(), OpenDDS::DCPS::MulticastTransport::start_session(), OpenDDS::DCPS::DataLink::stop(), OpenDDS::DCPS::TransportClient::use_datalink_i(), and OpenDDS::DCPS::DataReaderImpl::writer_activity().

  {
    return this->ptr_ == 0;
  }

operator bool()

template<typename T>

OpenDDS::DCPS::RcHandle< T >::operator bool ( ) const

inline

Definition at line 154 of file RcHandle_T.h.

  {
    return in() != 0;
  }

operator!=()

template<typename T>

bool OpenDDS::DCPS::RcHandle< T >::operator!= ( const RcHandle< T > &  rhs ) const

inline

Definition at line 164 of file RcHandle_T.h.

  {
    return in() != rhs.in();
  }

operator*()

template<typename T>

T& OpenDDS::DCPS::RcHandle< T >::operator* ( void  ) const

inline

Definition at line 115 of file RcHandle_T.h.

  {
    OPENDDS_ASSERT(ptr_);
    return *this->ptr_;
  }

operator->()

template<typename T>

T* OpenDDS::DCPS::RcHandle< T >::operator-> ( void  ) const

inline

Definition at line 109 of file RcHandle_T.h.

  {
    OPENDDS_ASSERT(ptr_);
    return this->ptr_;
  }

operator<()

template<typename T>

bool OpenDDS::DCPS::RcHandle< T >::operator< ( const RcHandle< T > &  rhs ) const

inline

Definition at line 169 of file RcHandle_T.h.

  {
    return in() < rhs.in();
  }

operator=() [1/3]

template<typename T>

RcHandle& OpenDDS::DCPS::RcHandle< T >::operator= ( const RcHandle< T > &  b )

inline

Definition at line 79 of file RcHandle_T.h.

  {
    RcHandle tmp(b);
    swap(tmp);
    return *this;
  }

operator=() [2/3]

template<typename T>

template<class U >

RcHandle& OpenDDS::DCPS::RcHandle< T >::operator= ( const RcHandle< U > &  b )

inline

Definition at line 87 of file RcHandle_T.h.

  {
    RcHandle<T> tmp(b);
    swap(tmp);
    return *this;
  }

operator=() [3/3]

template<typename T>

template<typename U >

RcHandle& OpenDDS::DCPS::RcHandle< T >::operator= ( unique_ptr< U >  b )

inline

Definition at line 95 of file RcHandle_T.h.

  {
    RcHandle<T> tmp(b.release(), keep_count());
    swap(tmp);
    return *this;
  }

operator==()

template<typename T>

bool OpenDDS::DCPS::RcHandle< T >::operator== ( const RcHandle< T > &  rhs ) const

inline

Definition at line 159 of file RcHandle_T.h.

  {
    return in() == rhs.in();
  }

out()

template<typename T>

T*& OpenDDS::DCPS::RcHandle< T >::out ( void  )

inline

Definition at line 141 of file RcHandle_T.h.

  {
    this->bump_down();
    return this->ptr_;
  }

reset() [1/2]

template<typename T>

void OpenDDS::DCPS::RcHandle< T >::reset ( void  )

inline

Definition at line 66 of file RcHandle_T.h.

Referenced by OpenDDS::DCPS::MulticastTransport::accept_datalink(), OpenDDS::DCPS::TcpTransport::accept_datalink(), OpenDDS::DCPS::DataReaderImpl::data_received(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::dds_demarshal(), OpenDDS::RTPS::Spdp::SendStun::execute(), OpenDDS::DCPS::TcpTransport::find_datalink_i(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::finish_store_instance_data(), OpenDDS::DCPS::RtpsUdpDataLink::RtpsWriter::gather_nack_replies_i(), OpenDDS::DCPS::Service_Participant::get_domain_participant_factory(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::lookup_instance(), OpenDDS::DCPS::RtpsUdpDataLink::RtpsWriter::process_acknack(), OpenDDS::DCPS::TcpDataLink::reconnect(), OpenDDS::DCPS::WriteDataContainer::register_instance(), OpenDDS::DCPS::TransportRegistry::release(), OpenDDS::FileSystemStorage::Directory::remove(), OpenDDS::DCPS::TcpConnection::set_datalink(), OpenDDS::DCPS::Service_Participant::shutdown(), OpenDDS::DCPS::UdpTransport::shutdown_i(), OpenDDS::DCPS::RtpsUdpTransport::shutdown_i(), OpenDDS::DCPS::DataLink::stop(), and OpenDDS::RTPS::Sedp::~Sedp().

  {
    RcHandle tmp;
    swap(tmp);
  }

reset() [2/2]

template<typename T>

template<typename U >

void OpenDDS::DCPS::RcHandle< T >::reset ( T *  p, U  counting_strategy  )

inline

Definition at line 73 of file RcHandle_T.h.

  {
    RcHandle tmp(p, counting_strategy);
    swap(tmp);
  }

swap()

template<typename T>

void OpenDDS::DCPS::RcHandle< T >::swap ( RcHandle< T > &  rhs )

inline

Definition at line 102 of file RcHandle_T.h.

Referenced by OpenDDS::DCPS::RtpsUdpDataLink::RtpsWriter::process_acknack(), OpenDDS::DCPS::ServiceEventDispatcher::shutdown(), OpenDDS::DCPS::TransportInst::shutdown(), and OpenDDS::DCPS::swap().

  {
    T* t = this->ptr_;
    this->ptr_ = rhs.ptr_;
    rhs.ptr_ = t;
  }

Member Data Documentation

ptr_

template<typename T>

T* OpenDDS::DCPS::RcHandle< T >::ptr_

private

The actual "unsmart" pointer to the T object.

Definition at line 191 of file RcHandle_T.h.

Referenced by OpenDDS::DCPS::RcHandle< OpenDDS::DCPS::DataReaderImpl::LivelinessTimer >::swap().

---

The documentation for this class was generated from the following file:

• RcHandle_T.h