OpenDDS::DCPS::Data_Types_Register Class Reference

#include <Registered_Data_Types.h>

Public Member Functions
DDS::ReturnCode_t	register_type (DDS::DomainParticipant_ptr domain_participant, const char *type_name, TypeSupport_ptr the_type)
DDS::ReturnCode_t	unregister_type (DDS::DomainParticipant_ptr domain_participant, const char *type_name, TypeSupport_ptr the_type)
DDS::ReturnCode_t	unregister_participant (DDS::DomainParticipant_ptr domain_participant)
TypeSupport_ptr	lookup (DDS::DomainParticipant_ptr domain_participant, const char *type_name) const

Static Public Member Functions
static Data_Types_Register *	instance ()
	Return a singleton instance of this class. More...

Private Member Functions
	Data_Types_Register ()
	~Data_Types_Register ()

Private Attributes
ACE_SYNCH_MUTEX	lock_
ParticipantMap	participants_

Friends
class	ACE_Singleton< Data_Types_Register, ACE_SYNCH_MUTEX >

Detailed Description

A singleton class that keeps track of the registered DDS data types local to this process. Data types are registered by domain participant.

Definition at line 37 of file Registered_Data_Types.h.

Constructor & Destructor Documentation

Data_Types_Register()

OpenDDS::DCPS::Data_Types_Register::Data_Types_Register ( )

private

Definition at line 24 of file Registered_Data_Types.cpp.

{
}

~Data_Types_Register()

OpenDDS::DCPS::Data_Types_Register::~Data_Types_Register ( )

private

Definition at line 28 of file Registered_Data_Types.cpp.

{
}

Member Function Documentation

instance()

Data_Types_Register * OpenDDS::DCPS::Data_Types_Register::instance ( void  )

static

Return a singleton instance of this class.

Definition at line 33 of file Registered_Data_Types.cpp.

References ACE_Singleton< TYPE, ACE_LOCK >::instance().

{
  return ACE_Singleton<Data_Types_Register, ACE_SYNCH_MUTEX>::instance();
}

lookup()

TypeSupport_ptr OpenDDS::DCPS::Data_Types_Register::lookup	(	DDS::DomainParticipant_ptr	domain_participant,
		const char *	type_name
	)		const

Find a data type by its type name.

Returns

the TypeSupport object registered as type_name Otherwise returns TypeSupport::_nil()

Definition at line 95 of file Registered_Data_Types.cpp.

References ACE_GUARD_RETURN, ACE_SYNCH_MUTEX, lock_, OPENDDS_END_VERSIONED_NAMESPACE_DECL, and participants_.

{
  ACE_GUARD_RETURN(ACE_SYNCH_MUTEX, guard, lock_, 0);

  ParticipantMap::const_iterator iter1 = participants_.find(domain_participant);
  if (iter1 == participants_.end()) {
    return 0;
  }

  TypeSupportMap::const_iterator iter2 = iter1->second.find(type_name);
  if (iter2 == iter1->second.end()) {
    return 0;
  }

  TypeSupport_var typeSupport = iter2->second;
  return typeSupport._retn();
}

register_type()

DDS::ReturnCode_t OpenDDS::DCPS::Data_Types_Register::register_type	(	DDS::DomainParticipant_ptr	domain_participant,
		const char *	type_name,
		TypeSupport_ptr	the_type
	)

Register a type.

Returns

RETCODE_OK if the type_name is unique to the domain participant or the type_name is already registered to the_type's class. Otherwise returns RETCODE_ERROR

Definition at line 38 of file Registered_Data_Types.cpp.

References ACE_GUARD_RETURN, ACE_SYNCH_MUTEX, lock_, participants_, DDS::RETCODE_ERROR, and DDS::RETCODE_OK.

{
  ACE_GUARD_RETURN(ACE_SYNCH_MUTEX, guard, lock_, DDS::RETCODE_ERROR);

  TypeSupportMap& tsm = participants_[domain_participant];
  const TypeSupport_var typeSupport = TypeSupport::_duplicate(the_type);

  TypeSupportMap::iterator iter = tsm.find(type_name);
  if (iter == tsm.end()) {
    tsm[type_name] = typeSupport;
    return DDS::RETCODE_OK;
  }

  if (std::strcmp(typeSupport->_interface_repository_id(),
                  iter->second->_interface_repository_id()) == 0) {
    return DDS::RETCODE_OK;
  }

  return DDS::RETCODE_ERROR;
}

unregister_participant()

DDS::ReturnCode_t OpenDDS::DCPS::Data_Types_Register::unregister_participant

(

DDS::DomainParticipant_ptr

domain_participant

)

Definition at line 87 of file Registered_Data_Types.cpp.

References ACE_GUARD_RETURN, ACE_SYNCH_MUTEX, lock_, participants_, DDS::RETCODE_ERROR, and DDS::RETCODE_OK.

{
  ACE_GUARD_RETURN(ACE_SYNCH_MUTEX, guard, lock_, DDS::RETCODE_ERROR);
  participants_.erase(domain_participant);
  return DDS::RETCODE_OK;
}

unregister_type()

DDS::ReturnCode_t OpenDDS::DCPS::Data_Types_Register::unregister_type	(	DDS::DomainParticipant_ptr	domain_participant,
		const char *	type_name,
		TypeSupport_ptr	the_type
	)

Unregister a type.

Returns

RETCODE_OK if the type_name has been removed or if the type_name cannot be found in the map associated with the domain_participant. Otherwise returns RETCODE_ERROR

Definition at line 62 of file Registered_Data_Types.cpp.

References ACE_GUARD_RETURN, ACE_SYNCH_MUTEX, lock_, participants_, DDS::RETCODE_ERROR, and DDS::RETCODE_OK.

{
  ACE_GUARD_RETURN(ACE_SYNCH_MUTEX, guard, lock_, DDS::RETCODE_ERROR);

  TypeSupportMap& tsm = participants_[domain_participant];

  TypeSupportMap::iterator iter = tsm.find(type_name);
  if (iter == tsm.end()) {
    // Not in the map, can't delete
    return DDS::RETCODE_ERROR;
  }
  else {
    if (std::strcmp(the_type->_interface_repository_id(), iter->second->_interface_repository_id()) == 0) {
      tsm.erase(iter);
      return DDS::RETCODE_OK;
    }
    else {
      return DDS::RETCODE_ERROR;
    }
  }
}

Friends And Related Function Documentation

ACE_Singleton< Data_Types_Register, ACE_SYNCH_MUTEX >

friend class ACE_Singleton< Data_Types_Register, ACE_SYNCH_MUTEX >

friend

Definition at line 38 of file Registered_Data_Types.h.

Member Data Documentation

lock_

ACE_SYNCH_MUTEX OpenDDS::DCPS::Data_Types_Register::lock_

mutableprivate

Definition at line 80 of file Registered_Data_Types.h.

Referenced by lookup(), register_type(), unregister_participant(), and unregister_type().

participants_

ParticipantMap OpenDDS::DCPS::Data_Types_Register::participants_

private

Definition at line 81 of file Registered_Data_Types.h.

Referenced by lookup(), register_type(), unregister_participant(), and unregister_type().

---

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

• Registered_Data_Types.h
• Registered_Data_Types.cpp