org.opensplice.dds.core.policy.Scheduling Interface Reference

This QosPolicy specifies the scheduling parameters that will be used for a thread that is spawned by the DomainParticipant. More...

Inheritance diagram for org.opensplice.dds.core.policy.Scheduling:

Collaboration diagram for org.opensplice.dds.core.policy.Scheduling:

Classes
interface	ListenerScheduling
	Scheduling for the Listener thread of a org.omg.dds.domain.DomainParticipant. More...
enum	SchedulingClass
	specifies the scheduling class used by the Operating System, which may be DEFAULT, REALTIME or TIMESHARING. More...
enum	SchedulingKind
	specifies the priority type, which may be either RELATIVE or ABSOLUTE. More...
interface	WatchdogScheduling
	Scheduling for the Watchdog thread of a org.omg.dds.domain.DomainParticipant. More...

Public Member Functions
ServiceEnvironment	getEnvironment ()
SchedulingKind	getKind ()
int	getPriority ()
SchedulingClass	getSchedulingClass ()
Scheduling	withKind (SchedulingKind schedulingKind)
	Copy this policy and override the value of the property. More...
Scheduling	withPriority (int priority)
	Copy this policy and override the value of the priority that will be assigned to threads spawned by the org.omg.dds.domain.DomainParticipant. More...
Scheduling	withSchedulingClass (SchedulingClass schedulingClass)
	Copy this policy and override the value of the property. More...

Detailed Description

This QosPolicy specifies the scheduling parameters that will be used for a thread that is spawned by the DomainParticipant.

Note that some scheduling parameters may not be supported by the underlying Operating System, or that you may need special privileges to select particular settings.

Although the behaviour of the SchedulingClass is highly dependent on the underlying OS, in general it can be said that when running in a Timesharing class your thread will have to yield execution to other threads of equal priority regularly. In a Realtime class your thread normally runs until completion, and can only be pre-empted by higher priority threads. Often the highest range of priorities is not accessible through a Timesharing Class.

The SchedulingKind determines whether the specified priority should be interpreted as an absolute priority, or whether it should be interpreted relative to the priority of its creator, in this case the priority of the thread that created the org.omg.dds.domain.DomainParticipant.

Definition at line 45 of file Scheduling.java.

Member Function Documentation

getEnvironment()

ServiceEnvironment org.omg.dds.core.DDSObject.getEnvironment ( )

inherited

Returns

the org.omg.dds.core.ServiceEnvironment object that directly or indirectly was used to create this object.

Implemented in org.omg.dds.core.ServiceEnvironment, org.opensplice.dds.sub.ReflectionDataReader< TYPE, OUT_TYPE >, org.opensplice.dds.core.ModifiableTimeImpl, org.opensplice.dds.pub.ReflectionDataWriter< TYPE >, org.opensplice.dds.core.DurationImpl, org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >, org.opensplice.dds.sub.ReadConditionImpl< TYPE >, org.opensplice.dds.core.EntityQosImpl< T extends QosPolicy >, org.opensplice.dds.type.TypeSupportImpl< TYPE >, org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl, org.opensplice.dds.topic.SubscriptionBuiltinTopicDataImpl, org.opensplice.dds.topic.TopicBuiltinTopicDataImpl, org.opensplice.dds.domain.DomainParticipantFactoryImpl, org.opensplice.dds.core.QosProviderImpl, org.opensplice.dds.core.status.OfferedIncompatibleQosStatusImpl, org.opensplice.dds.core.status.RequestedIncompatibleQosStatusImpl, org.opensplice.dds.core.InstanceHandleImpl, org.opensplice.dds.core.StatusConditionImpl< T extends Entity<?, ?>, org.opensplice.dds.core.status.LivelinessChangedStatusImpl, org.opensplice.dds.core.status.PublicationMatchedStatusImpl, org.opensplice.dds.core.status.SubscriptionMatchedStatusImpl, org.opensplice.dds.sub.SampleImpl< TYPE >, org.opensplice.dds.core.policy.ShareImpl, org.opensplice.dds.core.status.OfferedDeadlineMissedStatusImpl, org.opensplice.dds.core.status.SampleRejectedStatusImpl, org.opensplice.dds.core.WaitSetImpl, org.opensplice.dds.topic.ParticipantBuiltinTopicDataImpl, org.opensplice.dds.core.status.RequestedDeadlineMissedStatusImpl, org.opensplice.dds.topic.BuiltinTopicKeyImpl, org.opensplice.dds.core.GuardConditionImpl, org.opensplice.dds.core.event.AllDataDisposedEventImpl< TYPE >, org.opensplice.dds.core.policy.QosPolicyCountImpl, org.opensplice.dds.core.status.InconsistentTopicStatusImpl, org.opensplice.dds.core.status.LivelinessLostStatusImpl, org.opensplice.dds.core.status.SampleLostStatusImpl, org.opensplice.dds.core.policy.QosPolicyImpl, org.opensplice.dds.core.status.AllDataDisposedStatusImpl, org.opensplice.dds.core.IllegalArgumentExceptionImpl, org.opensplice.dds.core.InconsistentPolicyExceptionImpl, org.opensplice.dds.core.policy.PolicyFactoryImpl, org.opensplice.dds.core.policy.TypeConsistencyEnforcementImpl, org.opensplice.dds.core.PreconditionNotMetExceptionImpl, org.opensplice.dds.core.AlreadyClosedExceptionImpl, org.opensplice.dds.core.IllegalOperationExceptionImpl, org.opensplice.dds.core.ImmutablePolicyExceptionImpl, org.opensplice.dds.core.NotEnabledExceptionImpl, org.opensplice.dds.core.OutOfResourcesExceptionImpl, org.opensplice.dds.core.DDSExceptionImpl, org.opensplice.dds.core.status.DataAvailableStatusImpl, and org.opensplice.dds.core.status.DataOnReadersStatusImpl.

getKind()

SchedulingKind org.opensplice.dds.core.policy.Scheduling.getKind

(

)

Returns

the value of the SchedulingKind.

Implemented in org.opensplice.dds.core.policy.SchedulingImpl.

getPriority()

int org.opensplice.dds.core.policy.Scheduling.getPriority

(

)

Returns

the value of the priority.

Implemented in org.opensplice.dds.core.policy.SchedulingImpl.

getSchedulingClass()

SchedulingClass org.opensplice.dds.core.policy.Scheduling.getSchedulingClass

(

)

Returns

the value of the SchedulingClass.

Implemented in org.opensplice.dds.core.policy.SchedulingImpl.

withKind()

Scheduling org.opensplice.dds.core.policy.Scheduling.withKind

(

SchedulingKind

schedulingKind

)

Copy this policy and override the value of the property.

Parameters

schedulingKind

Specifies the scheduling type, which may be either RELATIVE or ABSOLUTE.

Returns

a new Scheduling policy

Implemented in org.opensplice.dds.core.policy.SchedulingImpl.

withPriority()

Scheduling org.opensplice.dds.core.policy.Scheduling.withPriority

(

int

priority

)

Copy this policy and override the value of the priority that will be assigned to threads spawned by the org.omg.dds.domain.DomainParticipant.

Threads can only be spawned with priorities that are supported by the underlying Operating System.

Parameters

priority

The priority to be set.

Returns

a new Scheduling policy

Implemented in org.opensplice.dds.core.policy.SchedulingImpl.

withSchedulingClass()

Scheduling org.opensplice.dds.core.policy.Scheduling.withSchedulingClass

(

SchedulingClass

schedulingClass

)

Copy this policy and override the value of the property.

Parameters

schedulingClass

Specifies the scheduling class used by the Operating System, which may be DEFAULT, TIMESHARING or REALTIME. Threads can only be spawned within the scheduling classes that are supported by the underlying Operating System.

Returns

a new Scheduling policy

Implemented in org.opensplice.dds.core.policy.SchedulingImpl.

---

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

• java5/common/java/code/org/opensplice/dds/core/policy/Scheduling.java