OpenDDS::DCPS::Data_Types_Register Class Reference

#include <Registered_Data_Types.h>

Collaboration diagram for OpenDDS::DCPS::Data_Types_Register:

[legend]List of all members.

Public Member Functions
::DDS::ReturnCode_t	register_type (::DDS::DomainParticipant_ptr domain_participant, ACE_CString type_name, OpenDDS::DCPS::TypeSupport_ptr the_type)
::DDS::ReturnCode_t	unregister_participant (::DDS::DomainParticipant_ptr domain_participant)
OpenDDS::DCPS::TypeSupport_ptr	lookup (::DDS::DomainParticipant_ptr domain_participant, ACE_CString type_name)
Static Public Member Functions
static Data_Types_Register *	instance (void)
	Return a singleton instance of this class.
Private Member Functions
	Data_Types_Register (void)
	~Data_Types_Register (void)
Private Attributes
ACE_SYNCH_RECURSIVE_MUTEX	lock_
DomainHash	domains_
Friends
class	TAO_Singleton< Data_Types_Register, TAO_SYNCH_MUTEX >

---

Detailed Description

A singleton class that keeps track of the registered DDS data types local to this process. Data types are split into separate domains.

---

Constructor & Destructor Documentation

OpenDDS::DCPS::Data_Types_Register::Data_Types_Register

(

void

)

[private]

OpenDDS::DCPS::Data_Types_Register::~Data_Types_Register

(

void

)

[private]

---

Member Function Documentation

Data_Types_Register * OpenDDS::DCPS::Data_Types_Register::instance

(

void

)

[static]

Return a singleton instance of this class.

OpenDDS::DCPS::TypeSupport_ptr OpenDDS::DCPS::Data_Types_Register::lookup	(	::DDS::DomainParticipant_ptr	domain_participant,
		ACE_CString	type_name
	)

Find a data type by its type name.

Note:

This class retains Ownership of the memory returned

Returns:

a pointer to the memory registered to the type_name Otherwise returns TypeSupport::_nil()

DDS::ReturnCode_t OpenDDS::DCPS::Data_Types_Register::register_type	(	::DDS::DomainParticipant_ptr	domain_participant,
		ACE_CString	type_name,
		OpenDDS::DCPS::TypeSupport_ptr	the_type
	)

Register a type.

Note:

This class takes Ownership of the memory pointed to by the_type when this method returns RETCODE_OK It does this by calling _add_ref() on the TypeSupport_ptr

Returns:

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

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

(

::DDS::DomainParticipant_ptr

domain_participant

)

---

Friends And Related Function Documentation

friend class TAO_Singleton< Data_Types_Register, TAO_SYNCH_MUTEX > [friend]

---

Member Data Documentation

DomainHash OpenDDS::DCPS::Data_Types_Register::domains_ [private]

ACE_SYNCH_RECURSIVE_MUTEX OpenDDS::DCPS::Data_Types_Register::lock_ [private]

---

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

• Registered_Data_Types.h
• Registered_Data_Types.cpp

---