OpenSplice Java 5 DCPS  v6.x
OpenSplice Java 5 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
DomainParticipantFactory.java
Go to the documentation of this file.
1 /* Copyright 2010, Object Management Group, Inc.
2  * Copyright 2010, PrismTech, Inc.
3  * Copyright 2010, Real-Time Innovations, Inc.
4  * All rights reserved.
5  *
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 
19 package org.omg.dds.domain;
20 
21 import java.util.Collection;
22 
23 import org.omg.dds.core.DDSObject;
25 import org.omg.dds.core.status.Status;
26 
27 
49 public abstract class DomainParticipantFactory implements DDSObject
50 {
51  // -----------------------------------------------------------------------
52  // Singleton Access
53  // -----------------------------------------------------------------------
54 
66  {
67  return env.getSPI().getParticipantFactory();
68  }
69 
70 
71 
72  // -----------------------------------------------------------------------
73  // Instance Methods
74  // -----------------------------------------------------------------------
75 
88  public abstract DomainParticipant createParticipant();
89 
107  public abstract DomainParticipant createParticipant(
108  int domainId);
109 
162  public abstract DomainParticipant createParticipant(
163  int domainId,
165  DomainParticipantListener listener,
166  Collection<Class<? extends Status>> statuses);
167 
220  public abstract DomainParticipant createParticipant(
221  int domainId,
223  DomainParticipantListener listener,
224  Class<? extends Status>... statuses);
225 
238  public abstract DomainParticipant lookupParticipant(int domainId);
239 
246  public abstract DomainParticipantFactoryQos getQos();
247 
266  public abstract void setQos(DomainParticipantFactoryQos qos);
267 
283 
302  public abstract void setDefaultParticipantQos(DomainParticipantQos qos);
303 
304 }
static DomainParticipantFactory getInstance(ServiceEnvironment env)
This operation returns the per-ServiceEnvironment DomainParticipantFactory singleton.
The DomainParticipant object plays several roles:
abstract DomainParticipantFactoryQos getQos()
This operation returns the value of the DomainParticipantFactory QoS policies.
abstract ServiceProviderInterface getSPI()
This method is not intended for use by applications.
abstract DomainParticipant lookupParticipant(int domainId)
This operation retrieves a previously created DomainParticipant belonging to specified domain ID...
abstract DomainParticipant createParticipant()
Create a new participant in the domain with ID 0 having default QoS and no listener.
abstract void setQos(DomainParticipantFactoryQos qos)
This operation sets the value of the DomainParticipantFactory QoS policies.
abstract void setDefaultParticipantQos(DomainParticipantQos qos)
This operation sets a default value of the DomainParticipant QoS policies which will be used for newl...
abstract DomainParticipantQos getDefaultParticipantQos()
This operation retrieves the default value of the DomainParticipant QoS, that is, the QoS policies wh...
A supertype of all DDS classes and interfaces.
Definition: DDSObject.java:25
The sole purpose of this class is to allow the creation and destruction of org.omg.dds.domain.DomainParticipant objects.
This is the interface that can be implemented by an application-provided class and then registered wi...
DDS implementations are rooted in this class, a concrete subclass of which can be instantiated based ...
Status is the abstract root class for all communication status objects.
Definition: Status.java:41