RTI Connext Java API  Version 5.1.0
DomainParticipantFactory

com.rti.dds.domain.DomainParticipantFactory entity and associated elements More...

Classes

class  DomainParticipantFactory
 <<singleton>> <<interface>> Allows creation and destruction of com.rti.dds.domain.DomainParticipant objects. More...
 
class  DomainParticipantFactoryQos
 QoS policies supported by a com.rti.dds.domain.DomainParticipantFactory. More...
 

Variables

static final DomainParticipantQos PARTICIPANT_QOS_DEFAULT
 Special value for creating a DomainParticipant with default QoS.
 
static DomainParticipantFactory TheParticipantFactory = create_singletonI()
 Can be used as an alias for the singleton factory returned by the operation com.rti.dds.domain.DomainParticipantFactory.get_instance().
 
static
DomainParticipantConfigParams_t 
PARTICIPANT_CONFIG_PARAMS_DEFAULT
 Special value for creating a com.rti.dds.domain.DomainParticipant from configuration using default parameters.
 

Detailed Description

com.rti.dds.domain.DomainParticipantFactory entity and associated elements

Variable Documentation

final DomainParticipantQos PARTICIPANT_QOS_DEFAULT
static
Initial value:
=
new DomainParticipantQos()

Special value for creating a DomainParticipant with default QoS.

When used in com.rti.dds.domain.DomainParticipantFactory.create_participant, this special value is used to indicate that the com.rti.dds.domain.DomainParticipant should be created with the default com.rti.dds.domain.DomainParticipant QoS by means of the operation com.rti.dds.domain.DomainParticipantFactory.get_default_participant_qos() and using the resulting QoS to create the com.rti.dds.domain.DomainParticipant.

When used in com.rti.dds.domain.DomainParticipantFactory.set_default_participant_qos, this special value is used to indicate that the default QoS should be reset back to the initial value that would be used if the com.rti.dds.domain.DomainParticipantFactory.set_default_participant_qos operation had never been called.

When used in com.rti.dds.domain.DomainParticipant.set_qos, this special value is used to indicate that the QoS of the com.rti.dds.domain.DomainParticipant should be changed to match the current default QoS set in the com.rti.dds.domain.DomainParticipantFactory that the com.rti.dds.domain.DomainParticipant belongs to.

RTI Connext treats this special value as a constant.

Note: You cannot use this value to get the default QoS values from the DomainParticipant factory; for this purpose, use com.rti.dds.domain.DomainParticipantFactory.get_default_participant_qos.

See Also
NDDS_DISCOVERY_PEERS
com.rti.dds.domain.DomainParticipantFactory.create_participant()
com.rti.dds.domain.DomainParticipantFactory.set_default_participant_qos()
com.rti.dds.domain.DomainParticipant.set_qos()
DomainParticipantFactory TheParticipantFactory = create_singletonI()
static

Can be used as an alias for the singleton factory returned by the operation com.rti.dds.domain.DomainParticipantFactory.get_instance().

See Also
com.rti.dds.domain.DomainParticipantFactory.get_instance
DomainParticipantConfigParams_t PARTICIPANT_CONFIG_PARAMS_DEFAULT
static
Initial value:
=
new DomainParticipantConfigParams_t()

Special value for creating a com.rti.dds.domain.DomainParticipant from configuration using default parameters.

This value can be used only in com.rti.dds.domain.DomainParticipantFactory.create_participant_from_config_w_params and indicates that the com.rti.dds.domain.DomainParticipant must be created applying the information defined in the participant configuration. That is, the domain ID, participant entity name, and QoS profiles for all the entities will be retrieved from the configuration.

RTI Connext treats this special value as a constant.

See Also
com.rti.dds.infrastructure.DomainParticipantConfigParams_t
com.rti.dds.domain.DomainParticipantFactory.create_participant_from_config_w_params

RTI Connext Java API Version 5.1.0 Copyright © Mon Feb 3 2014 Real-Time Innovations, Inc