org.omg.dds.domain

Class DomainParticipantFactory

java.lang.Object

org.omg.dds.domain.DomainParticipantFactory

All Implemented Interfaces:

DDSObject

public abstract class DomainParticipantFactory
extends Object
implements DDSObject

The sole purpose of this class is to allow the creation and destruction of DomainParticipant objects. DomainParticipantFactory itself has no factory. It is a pre-existing per-ServiceEnvironment singleton object that can be accessed by means of the getInstance(ServiceEnvironment) operation.

Constructor Summary

Constructors

Constructor and Description
DomainParticipantFactory()

Method Summary

Methods

Modifier and Type	Method and Description
abstract DomainParticipant	createParticipant() Create a new participant in the domain with ID 0 having default QoS and no listener.
abstract DomainParticipant	createParticipant(int domainId) This operation creates a new DomainParticipant object.
abstract DomainParticipant	createParticipant(int domainId, DomainParticipantQos qos, DomainParticipantListener listener, Collection<Class<? extends Status>> statuses) This operation creates a new DomainParticipant object having default QoS and no listener.
abstract DomainParticipantQos	getDefaultParticipantQos() This operation retrieves the default value of the DomainParticipant QoS, that is, the QoS policies which will be used for newly created DomainParticipant entities in the case where the QoS policies are defaulted in the createParticipant() operation.
static DomainParticipantFactory	getInstance(ServiceEnvironment env) This operation returns the per-ServiceEnvironment DomainParticipantFactory singleton.
abstract DomainParticipantFactoryQos	getQos() This operation returns the value of the DomainParticipantFactory QoS policies.
abstract DomainParticipant	lookupParticipant(int domainId) This operation retrieves a previously created DomainParticipant belonging to specified domain ID.
abstract void	setDefaultParticipantQos(DomainParticipantQos qos) This operation sets a default value of the DomainParticipant QoS policies which will be used for newly created DomainParticipant entities in the case where the QoS policies are defaulted in the createParticipant() operation.
abstract void	setQos(DomainParticipantFactoryQos qos) This operation sets the value of the DomainParticipantFactory QoS policies.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.omg.dds.core.DDSObject

getEnvironment

Constructor Detail

DomainParticipantFactory

public DomainParticipantFactory()

Method Detail

getInstance

public static DomainParticipantFactory getInstance(ServiceEnvironment env)

This operation returns the per-ServiceEnvironment DomainParticipantFactory singleton. The operation is idempotent, that is, it can be called multiple times without side effects, and each time it will return a DomainParticipantFactory instance that is equal to the previous results.

Parameters:

env - Identifies the Service instance to which the object will belong.

createParticipant

public abstract DomainParticipant createParticipant()

Create a new participant in the domain with ID 0 having default QoS and no listener.

See Also:

createParticipant(int), createParticipant(int, DomainParticipantQos, DomainParticipantListener, Collection)

createParticipant

public abstract DomainParticipant createParticipant(int domainId)

This operation creates a new DomainParticipant object. The DomainParticipant signifies that the calling application intends to join the domain identified by the domainId argument.

See Also:

createParticipant(), createParticipant(int, DomainParticipantQos, DomainParticipantListener, Collection)

createParticipant

public abstract DomainParticipant createParticipant(int domainId,
                                  DomainParticipantQos qos,
                                  DomainParticipantListener listener,
                                  Collection<Class<? extends Status>> statuses)

This operation creates a new DomainParticipant object having default QoS and no listener. The DomainParticipant signifies that the calling application intends to join the domain identified by the domainId argument.

Parameters:

statuses - Of which status changes the listener should be notified. A null collection signifies all status changes.

Throws:

InconsistentPolicyException - if the specified QoS policies are not consistent.

See Also:

createParticipant(), createParticipant(int)

lookupParticipant

public abstract DomainParticipant lookupParticipant(int domainId)

This operation retrieves a previously created DomainParticipant belonging to specified domain ID. If no such DomainParticipant exists, the operation will return null. If multiple DomainParticipant entities belonging to that domain ID exist, then the operation will return one of them. It is not specified which one.

getQos

public abstract DomainParticipantFactoryQos getQos()

This operation returns the value of the DomainParticipantFactory QoS policies.

See Also:

setQos(DomainParticipantFactoryQos)

setQos

public abstract void setQos(DomainParticipantFactoryQos qos)

This operation sets the value of the DomainParticipantFactory QoS policies. These policies control the behavior of the object, a factory for entities. Note that despite having QoS, the DomainParticipantFactory is not an Entity.

Throws:

InconsistentPolicyException - if the resulting policies are not self consistent; in that case, the operation will have no effect.

See Also:

getQos()

getDefaultParticipantQos

public abstract DomainParticipantQos getDefaultParticipantQos()

This operation retrieves the default value of the DomainParticipant QoS, that is, the QoS policies which will be used for newly created DomainParticipant entities in the case where the QoS policies are defaulted in the createParticipant() operation. The values retrieved will match the set of values specified on the last successful call to setDefaultParticipantQos(DomainParticipantQos), or else, if the call was never made, the default values identified by the DDS specification.

See Also:

setDefaultParticipantQos(DomainParticipantQos)

setDefaultParticipantQos

public abstract void setDefaultParticipantQos(DomainParticipantQos qos)

This operation sets a default value of the DomainParticipant QoS policies which will be used for newly created DomainParticipant entities in the case where the QoS policies are defaulted in the createParticipant() operation.

Throws:

InconsistentPolicyException - if the resulting policies are not self consistent; in that case, the operation will have no effect.

See Also:

getDefaultParticipantQos()