Participant Use Cases

Working with domain participants. More...

Working with domain participants.

Turning off auto-enable of newly created participant(s)

• Change the value of the ENTITY_FACTORY for the DomainParticipantFactory

The following #includes are needed for the examples on this page

#include <dds/domain/ddsdomain.hpp>

Setting up a DomainParticipant

• How to create DomainParticipants with each of the available constructors

      
      // When not explicitly provided to the constructor, the 
      // created DomainParticipants's QoS is default, has a NULL listener, and a 
      // status mask dds::core::status::StatusMask::all()
  
      // Creating a DomainParticipants on domain 0
      dds::domain::DomainParticipant participant1(0) ;
  
      // Creating a DomainParticipants with a non-default QoS values
      dds::domain::qos::DomainParticipantQos qos;
  
       // Set the initial peers. 
       // The peers stored in initial_peers are merely potential peers--there is 
       // no requirement that the peer DomainParticipants are actually up and
       // running or even will eventually exist. The Connext discovery process 
       // will try to contact all potential peer participants in the list 
       // periodically using unicast transports. 
       const char * initial_peers_array[] = {
         "host1",
         "10.10.30.192",
         "1@localhost",        
         "2@host2",
         "my://", /* all unicast addrs on transport plugins with alias "my" */
         "2@shmem://", /* shared memory */
         "FF00:ABCD::0",
         "1@FF00:0:1234::0",
         "225.1.2.3",
         "3@225.1.0.55",
         "FAA0::0#0/0/R"};
  
      const dds::core::StringSeq initial_peers_list(initial_peers_array, initial_peers_array+11);
  
      // Add the initial peers list to the DiscoveryQosPolicy while modifying
      // the participant's qos inline
      qos << rti::core::policy::Discovery().initial_peers(initial_peers_list);
  
      // Creating a DomainParticipants on domain 1 with modified QoS
      dds::domain::DomainParticipant participant2(1, qos);
  
      // Creating a DomainParticipants on domain 2, with modified QoS, and a listener
      ExampleParticipantListener *listener = new ExampleParticipantListener;
      dds::domain::DomainParticipant participant3(2, qos, listener);
  
      // Creating a DomainParticipants on domain 3, with modified QoS, a listener and 
      // a data_available() status mask
      dds::domain::DomainParticipant participant4(
         3, qos, listener, dds::core::status::StatusMask::data_available());
  
      // Creating an entity with a listener automatically retains the entity, so 
      // we must either explicitly close the DomainParticipant...
      participant3.close();
      
      // ... or set the listener to null
      participant4.listener(NULL, dds::core::status::StatusMask::none());

  
  
• Setting the DomainParticipantFactoryQos so that participants are created disabled (optional)

      dds::domain::qos::DomainParticipantFactoryQos qos;
  
      qos << dds::core::policy::EntityFactory::ManuallyEnable();
  
      dds::domain::DomainParticipant::participant_factory_qos(qos);

  
  

Looking up DomainParticipants

• Lookup DomainParticipants by domain id

      // Create and retain two DomainParticipants on domain 0 and one on domain 1
      create_and_retain_participant(0);
      create_and_retain_participant(0);
      create_and_retain_participant(1);
  
      // We don't have any references to the created DomainParticipants but we 
      // can look them up using the domain id they were created on
  
      // If there is more than one participant on the same domain then this
      // operation will return only one of them. It is unspecified which one it
      // will return
      dds::domain::DomainParticipant participant1 = dds::domain::find(0);
      dds::domain::DomainParticipant participant2 = dds::domain::find(1);

Tearing down a Participant

• See Tearing Down An Entity for eamples of the various ways to teardown a Participant

Finalizing the factory

• Finalizing the factory

  
      // The DomainParticipantFactory is a singleton that the C++ API uses 
      // implicitly to create participants. RTI Connext provides 
      // dds::domain::DomainParticipant::finalize_participant_factory() 
      // for users who want to release memory used by the participant factory. 
      dds::domain::DomainParticipant::finalize_participant_factory();