org.omg.dds.core

Interface ServiceEnvironment.ServiceProviderInterface

Enclosing class:

ServiceEnvironment

public static interface ServiceEnvironment.ServiceProviderInterface

This interface is for the use of the DDS implementation, not of DDS applications. It simplifies the creation of objects of certain types in the DDS API.

Method Summary

Methods

Modifier and Type	Method and Description
Set<Class<? extends Status>>	allStatusKinds()
DynamicDataFactory	getDynamicDataFactory()
DomainParticipantFactory	getParticipantFactory()
PolicyFactory	getPolicyFactory() Provides an instance of PolicyFactory.
DynamicTypeFactory	getTypeFactory()
Duration	infiniteDuration()
Time	invalidTime()
Duration	newDuration(long duration, TimeUnit unit) Construct a Duration of the given magnitude.
GuardCondition	newGuardCondition()
ModifiableInstanceHandle	newInstanceHandle()
KeyedBytes	newKeyedBytes()
KeyedString	newKeyedString()
QosProvider	newQosProvider(String uri, String profile) Create a QosProvider fetching QoS configuration from the specified URI.
ModifiableTime	newTime(long time, TimeUnit units) Construct a specific instant in time.
<TYPE> TypeSupport<TYPE>	newTypeSupport(Class<TYPE> type, String registeredName) Create a new TypeSupport object for the given physical type.
WaitSet	newWaitSet()
InstanceHandle	nilHandle()
Set<Class<? extends Status>>	noStatusKinds()
Duration	zeroDuration()

Method Detail

getParticipantFactory

DomainParticipantFactory getParticipantFactory()

getTypeFactory

DynamicTypeFactory getTypeFactory()

newTypeSupport

<TYPE> TypeSupport<TYPE> newTypeSupport(Class<TYPE> type,
                                      String registeredName)

Create a new TypeSupport object for the given physical type. The Service will register this type under the given name with any participant with which the TypeSupport is used.

Type Parameters:

TYPE - The physical type of all samples read or written by any DataReader or DataWriter typed by the resulting TypeSupport.

Parameters:

type - The physical type of all samples read or written by any DataReader or DataWriter typed by the resulting TypeSupport.

registeredName - The logical name under which this type will be registered with any DomainParticipant with which the resulting TypeSupport is used.

Returns:

A new TypeSupport object, which can subsequently be used to create one or more Topics.

newDuration

Duration newDuration(long duration,
                   TimeUnit unit)

Construct a Duration of the given magnitude. A duration of magnitude Long.MAX_VALUE indicates an infinite duration, regardless of the units specified.

infiniteDuration

Duration infiniteDuration()

Returns:

A Duration of infinite length.

zeroDuration

Duration zeroDuration()

Returns:

A Duration of zero length.

newTime

ModifiableTime newTime(long time,
                     TimeUnit units)

Construct a specific instant in time. Negative values are considered invalid and will result in the construction of a time t such that: t.isValid() == false

invalidTime

Time invalidTime()

Returns:

A Time that is not valid.

newInstanceHandle

ModifiableInstanceHandle newInstanceHandle()

nilHandle

InstanceHandle nilHandle()

newGuardCondition

GuardCondition newGuardCondition()

newWaitSet

WaitSet newWaitSet()

allStatusKinds

Set<Class<? extends Status>> allStatusKinds()

noStatusKinds

Set<Class<? extends Status>> noStatusKinds()

newQosProvider

QosProvider newQosProvider(String uri,
                         String profile)

Create a QosProvider fetching QoS configuration from the specified URI. The URI determines the how the Qos configuration is fetched and the format in which it is represented. This specification requires compliant implementations to support at least one file based configuration using the XML syntax defined as part of the DDS for CCM specification (formal/12.02.01).

Parameters:

uri - The uniform resource identifier. For example, "file:///somewhere/on/disk/qos-config.xml" "http:///somewhere.org/here/json-config.json"

profile - Name of a profile in the document obtained via the uri

Returns:

a new QosProvider object

getPolicyFactory

PolicyFactory getPolicyFactory()

Provides an instance of PolicyFactory.

Returns:

An instance of PolicyFactory

getDynamicDataFactory

DynamicDataFactory getDynamicDataFactory()

newKeyedString

KeyedString newKeyedString()

newKeyedBytes

KeyedBytes newKeyedBytes()