DDS::DomainParticipantFactory Class Reference

DomainParticipantFactory constructs DomainParticipants. The. More...

Public Member Functions
DomainParticipant *	create_participant (DomainId_t domain_id, const DomainParticipantQos &qos, DomainParticipantListener *a_listener, StatusMask mask)
	This operation creates a new DomainParticipant object. More...
ReturnCode_t	delete_participant (DomainParticipant *a_participant)
	Destroys the provided DomainParticipant. More...
DomainParticipant *	lookup_participant (DomainId_t domain_id)
	Returns a previously created DomainParticipant belonging to the specified domain_id. More...
ReturnCode_t	set_default_participant_qos (const DomainParticipantQos &qos)
	Sets the default DomainParticipantQos held in the factory. More...
ReturnCode_t	get_default_participant_qos (DomainParticipantQos &qos)
	Provides access to the default Participant qos held in the factory. More...
ReturnCode_t	set_qos (const DomainParticipantFactoryQos &qos)
	Sets the DomainParticipantFactory QoS values. More...
ReturnCode_t	get_qos (DomainParticipantFactoryQos &qos)
	Provides access to the QoS settings of the DomainParticipantFactory.

Static Public Member Functions
static DomainParticipantFactory *	get_instance ()

Detailed Description

DomainParticipantFactory constructs DomainParticipants. The.

DomainParticipantFactory is used to configure, create and destroy DomainParticipant instances.

Member Function Documentation

DomainParticipant* DDS::DomainParticipantFactory::create_participant	(	DomainId_t	domain_id,
		const DomainParticipantQos &	qos,
		DomainParticipantListener *	a_listener,
		StatusMask	mask
	)

This operation creates a new DomainParticipant object.

The caller provides the domain_id to which the Participant should belong. The listener and mask arguments are used to specify a set of callback routines which will be invoked upon detection of certain events. The qos argument specifies the DomainParticipant Quality of Service settings that should be used when creating the DomainParticipant. It may be specified as PARTICIPANT_QOS_DEFAULT to instruct CoreDX DDS to use the default qos settings held in the DomainParticipantFactory.
This routine will return NULL if it fails to create a DomainParticipant.

ReturnCode_t DDS::DomainParticipantFactory::delete_participant

(

DomainParticipant *

a_participant

)

Destroys the provided DomainParticipant.

This routine will fail if all Entities (Publishers, Subscribers, etc) created through the specified DomainParticipant have not yet been deleted. (In this case, RETCODE_PRECONDITION_NOT_MET will be returned.)

ReturnCode_t DDS::DomainParticipantFactory::get_default_participant_qos

(

DomainParticipantQos &

qos

)

Provides access to the default Participant qos held in the factory.

The provided qos argument is populated with the default qos settings.

static DomainParticipantFactory* DDS::DomainParticipantFactory::get_instance ( )

static

Get access to the singleton DomainParticipantFactory.

DomainParticipant* DDS::DomainParticipantFactory::lookup_participant

(

DomainId_t

domain_id

)

Returns a previously created DomainParticipant belonging to the specified domain_id.

If there are multiple DomainParticipants in existence within the specified domain, one of them will be returned.

ReturnCode_t DDS::DomainParticipantFactory::set_default_participant_qos

(

const DomainParticipantQos &

qos

)

Sets the default DomainParticipantQos held in the factory.

This default qos will be used during subsequent calls to DomainParticipantFactory_create_participant() if the special PARTICIPANT_QOS_DEFAULT value is provided for qos.
This routine may fail if the provided qos argument is not internally consistent. In this case, INCONSISTENT_POLICY will be returned, and no changes will be made to the DomainParticipantFactory.

ReturnCode_t DDS::DomainParticipantFactory::set_qos

(

const DomainParticipantFactoryQos &

qos

)

Sets the DomainParticipantFactory QoS values.

These QoS values affect the behavior of the factory.

This routine may fail if the provided qos argument is not internally consistent. In this case, INCONSISTENT_POLICY will be returned, and no changes will be made to the DomainParticipantFactory.