DomainParticipantFactory constructs DomainParticipants. The. More...
Public Member Functions | |
| DomainParticipant | create_participant (uint domain_id, DomainParticipantQos qos, DomainParticipantListener listener, uint 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 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. | |
Static Public Member Functions | |
| static DomainParticipantFactory | get_instance () |
Properties | |
| static DomainParticipantFactory | Instance [get] |
Related Functions | |
(Note that these are not member functions.) | |
| ReturnCode_t | delete_participant (DomainParticipant participant) |
| Destroys the provided DomainParticipant. | |
| DomainParticipant | lookup_participant (uint domain_id) |
| Returns a previously created DomainParticipant belonging to the specified domain_id. | |
| ReturnCode_t | set_default_participant_qos (DomainParticipantQos qos) |
| Sets the default DDS_DomainParticipantQos held in the factory. | |
| ReturnCode_t | get_default_participant_qos (DomainParticipantQos qos) |
| Provides access to the default Participant qos held in the factory. | |
| ReturnCode_t | set_qos (DomainParticipantFactoryQos qos) |
| Sets the DomainParticipantFactory QoS values. | |
| ReturnCode_t | get_qos (DomainParticipantFactoryQos qos) |
| Provides access to the QoS settings of the DomainParticipantFactory. | |
DomainParticipantFactory constructs DomainParticipants. The.
DomainParticipantFactory is used to configure, create and destroy DomainParticipant instances.
| DomainParticipant create_participant | ( | uint | domain_id, | |
| DomainParticipantQos | qos, | |||
| DomainParticipantListener | listener, | |||
| uint | mask | |||
| ) | [inline] |
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 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.
| static DomainParticipantFactory get_instance | ( | ) | [inline, static] |
Get access to the singleton DomainParticipantFactory.
| ReturnCode_t delete_participant | ( | DomainParticipant | participant | ) | [related] |
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, DDS_RETCODE_PRECONDITION_NOT_MET will be returned.)
| ReturnCode_t get_default_participant_qos | ( | DomainParticipantQos | qos | ) | [related] |
Provides access to the default Participant qos held in the factory.
The provided qos argument is populated with the default qos settings.
| DomainParticipant lookup_participant | ( | uint | domain_id | ) | [related] |
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 set_default_participant_qos | ( | DomainParticipantQos | qos | ) | [related] |
Sets the default DDS_DomainParticipantQos held in the factory.
This default qos will be used during subsequent calls to DDS_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, DDS_INCONSISTENT_POLICY will be returned, and no changes will be made to the DomainParticipantFactory.
| ReturnCode_t set_qos | ( | DomainParticipantFactoryQos | qos | ) | [related] |
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, DDS_INCONSISTENT_POLICY will be returned, and no changes will be made to the DomainParticipantFactory.
DomainParticipantFactory Instance [static, get] |
A C# style property with accessor. use it like this: DomainParticipantFactory.Instance.create_participant()
