CoreDX DDS Java Reference Manual
|
DomainParticipantFactory constructs DomainParticipants. The. More...
Public Member Functions | |
| DomainParticipant | create_participant (long domain_id, DomainParticipantQos qos, DomainParticipantListener listener, long mask) |
| ReturnCode_t | delete_participant (DomainParticipant participant) |
| DomainParticipant | lookup_participant (long domain_id) |
| ReturnCode_t | set_default_participant_qos (DomainParticipantQos qos) |
| ReturnCode_t | get_default_participant_qos (DomainParticipantQos qos) |
| ReturnCode_t | set_qos (DomainParticipantFactoryQos qos) |
| ReturnCode_t | get_qos (DomainParticipantFactoryQos qos) |
Static Public Member Functions | |
| static DomainParticipantFactory | get_instance () |
DomainParticipantFactory constructs DomainParticipants. The.
DomainParticipantFactory is used to configure, create and destroy DomainParticipant instances.
| DomainParticipant create_participant | ( | long | domain_id, |
| DomainParticipantQos | qos, | ||
| DomainParticipantListener | listener, | ||
| long | mask | ||
| ) |
Create and initialize a DomainParticipant. 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 DDS.PARTICIPANT_QOS_DEFAULT to instruct CoreDX to use the default qos settings held in the DomainParticipantFactory.
This routine will return NULL if it fails to create a DomainParticipant.
| domain_id | The DomainId of the created DomainParticipant. |
| qos | The QoS to use for the create DP. |
| listener | The listener that will receive event notifications, can be null |
| mask | A mask indicating which methods within 'listener' should be invoked. |
| ReturnCode_t delete_participant | ( | DomainParticipant | participant | ) |
Destroy a DomainParticipant. This routine will fail if all Entities (Publishers, Subscribers, etc) created through this DomainParticipant have not yet been deleted. (In this case, RETCODE_PRECONDITION_NOT_MET will be returned.)
| participant | A DomainParticipant previosly created by a call to create_participant() |
| ReturnCode_t 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 |
Get access to the singleton DomainParticipantFactory.
| ReturnCode_t get_qos | ( | DomainParticipantFactoryQos | qos | ) |
Gets the current QoS settings of the DomainParticipantFactory.
| DomainParticipant lookup_participant | ( | long | domain_id | ) |
Find a DomainParticipant with the provided domain_id. If there are multiple participants in existence with the specified id, then one of them will be returned. (Which one is not specified.)
| ReturnCode_t set_default_participant_qos | ( | 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 DDS.PARTICIPANT_QOS_DEFAULT value is provided for qos.
This routine may fail if the provided qos argument is not internally consistent. In this case, ReturnCode_t.RETCODE_INCONSISTENT_POLICY will be returned, and no changes will be made to the DomainParticipantFactory.
| ReturnCode_t set_qos | ( | 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, ReturnCode_t.RETCODE_INCONSISTENT_POLICY will be returned, and no changes will be made to the DomainParticipantFactory.
