org.omg.dds.core.ServiceEnvironment.ServiceProviderInterface Interface Reference

This interface is for the use of the DDS implementation, not of DDS applications. More...

Inheritance diagram for org.omg.dds.core.ServiceEnvironment.ServiceProviderInterface:

Collaboration diagram for org.omg.dds.core.ServiceEnvironment.ServiceProviderInterface:

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

Detailed Description

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.

Definition at line 378 of file ServiceEnvironment.java.

Member Function Documentation

allStatusKinds()

Set<Class<? extends Status> > org.omg.dds.core.ServiceEnvironment.ServiceProviderInterface.allStatusKinds

(

)

Implemented in org.opensplice.dds.core.OsplServiceEnvironment.OpenSpliceServiceProviderInterface.

getDynamicDataFactory()

abstract DynamicDataFactory org.omg.dds.core.ServiceEnvironment.ServiceProviderInterface.getDynamicDataFactory ( )

abstract

Implemented in org.opensplice.dds.core.OsplServiceEnvironment.OpenSpliceServiceProviderInterface.

getParticipantFactory()

DomainParticipantFactory org.omg.dds.core.ServiceEnvironment.ServiceProviderInterface.getParticipantFactory

(

)

Implemented in org.opensplice.dds.core.OsplServiceEnvironment.OpenSpliceServiceProviderInterface.

getPolicyFactory()

abstract PolicyFactory org.omg.dds.core.ServiceEnvironment.ServiceProviderInterface.getPolicyFactory ( )

abstract

Provides an instance of org.omg.dds.core.policy.PolicyFactory.

Returns

An instance of org.omg.dds.core.policy.PolicyFactory

Implemented in org.opensplice.dds.core.OsplServiceEnvironment.OpenSpliceServiceProviderInterface.

getTypeFactory()

DynamicTypeFactory org.omg.dds.core.ServiceEnvironment.ServiceProviderInterface.getTypeFactory

(

)

Implemented in org.opensplice.dds.core.OsplServiceEnvironment.OpenSpliceServiceProviderInterface.

infiniteDuration()

Duration org.omg.dds.core.ServiceEnvironment.ServiceProviderInterface.infiniteDuration

(

)

Returns

A org.omg.dds.core.Duration of infinite length.

Implemented in org.opensplice.dds.core.OsplServiceEnvironment.OpenSpliceServiceProviderInterface.

invalidTime()

Time org.omg.dds.core.ServiceEnvironment.ServiceProviderInterface.invalidTime

(

)

Returns

A org.omg.dds.core.Time that is not valid.

Implemented in org.opensplice.dds.core.OsplServiceEnvironment.OpenSpliceServiceProviderInterface.

newDuration()

Duration org.omg.dds.core.ServiceEnvironment.ServiceProviderInterface.newDuration	(	long	duration,
		TimeUnit	unit
	)

Construct a org.omg.dds.core.Duration of the given magnitude.

A duration of magnitude Long#MAX_VALUE indicates an infinite duration, regardless of the units specified.

Implemented in org.opensplice.dds.core.OsplServiceEnvironment.OpenSpliceServiceProviderInterface.

newGuardCondition()

GuardCondition org.omg.dds.core.ServiceEnvironment.ServiceProviderInterface.newGuardCondition

(

)

Implemented in org.opensplice.dds.core.OsplServiceEnvironment.OpenSpliceServiceProviderInterface.

newKeyedBytes()

abstract KeyedBytes org.omg.dds.core.ServiceEnvironment.ServiceProviderInterface.newKeyedBytes ( )

abstract

Implemented in org.opensplice.dds.core.OsplServiceEnvironment.OpenSpliceServiceProviderInterface.

newKeyedString()

abstract KeyedString org.omg.dds.core.ServiceEnvironment.ServiceProviderInterface.newKeyedString ( )

abstract

Implemented in org.opensplice.dds.core.OsplServiceEnvironment.OpenSpliceServiceProviderInterface.

newQosProvider()

abstract QosProvider org.omg.dds.core.ServiceEnvironment.ServiceProviderInterface.newQosProvider ( String  uri, String  profile  )

abstract

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

Implemented in org.opensplice.dds.core.OsplServiceEnvironment.OpenSpliceServiceProviderInterface.

newTime()

ModifiableTime org.omg.dds.core.ServiceEnvironment.ServiceProviderInterface.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

Implemented in org.opensplice.dds.core.OsplServiceEnvironment.OpenSpliceServiceProviderInterface.

newTypeSupport()

public<TYPE> TypeSupport<TYPE> org.omg.dds.core.ServiceEnvironment.ServiceProviderInterface.newTypeSupport	(	Class< TYPE >	type,
		String	registeredName
	)

Create a new org.omg.dds.type.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.

Parameters

<TYPE>	The physical type of all samples read or written by any org.omg.dds.sub.DataReader or org.omg.dds.pub.DataWriter typed by the resulting TypeSupport.
type	The physical type of all samples read or written by any org.omg.dds.sub.DataReader or org.omg.dds.pub.DataWriter typed by the resulting TypeSupport.
registeredName	The logical name under which this type will be registered with any org.omg.dds.domain.DomainParticipant with which the resulting TypeSupport is used.

Returns

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

newWaitSet()

WaitSet org.omg.dds.core.ServiceEnvironment.ServiceProviderInterface.newWaitSet

(

)

Implemented in org.opensplice.dds.core.OsplServiceEnvironment.OpenSpliceServiceProviderInterface.

nilHandle()

InstanceHandle org.omg.dds.core.ServiceEnvironment.ServiceProviderInterface.nilHandle

(

)

Implemented in org.opensplice.dds.core.OsplServiceEnvironment.OpenSpliceServiceProviderInterface.

noStatusKinds()

Set<Class<? extends Status> > org.omg.dds.core.ServiceEnvironment.ServiceProviderInterface.noStatusKinds

(

)

Implemented in org.opensplice.dds.core.OsplServiceEnvironment.OpenSpliceServiceProviderInterface.

zeroDuration()

Duration org.omg.dds.core.ServiceEnvironment.ServiceProviderInterface.zeroDuration

(

)

Returns

A org.omg.dds.core.Duration of zero length.

Implemented in org.opensplice.dds.core.OsplServiceEnvironment.OpenSpliceServiceProviderInterface.

---

The documentation for this interface was generated from the following file:

• java5/common/java/code/org/omg/dds/core/ServiceEnvironment.java