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

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

Public Member Functions
	DurabilityServiceImpl (OsplServiceEnvironment environment)

	DurabilityServiceImpl (OsplServiceEnvironment environment, Duration serviceCleanupDelay, Kind historyKind, int historyDepth, int maxSamples, int maxInstances, int maxSamplesPerInstance)

boolean	equals (Object other)

ServiceEnvironment	getEnvironment ()

int	getHistoryDepth ()

Kind	getHistoryKind ()

int	getMaxInstances ()

int	getMaxSamples ()

int	getMaxSamplesPerInstance ()

Class<? extends QosPolicy >	getPolicyClass ()

Duration	getServiceCleanupDelay ()

int	hashCode ()

DurabilityService	withHistoryDepth (int historyDepth)
	Copy this policy and override the value of the property. More...

DurabilityService	withHistoryKind (History.Kind historyKind)
	Copy this policy and override the value of the property. More...

DurabilityService	withHistoryKind (Kind historyKind)

DurabilityService	withMaxInstances (int maxInstances)
	Copy this policy and override the value of the property. More...

DurabilityService	withMaxSamples (int maxSamples)
	Copy this policy and override the value of the property. More...

DurabilityService	withMaxSamplesPerInstance (int maxSamplesPerInstance)
	Copy this policy and override the value of the property. More...

DurabilityService	withServiceCleanupDelay (Duration serviceCleanupDelay)
	Copy this policy and override the value of the property. More...

DurabilityService	withServiceCleanupDelay (long serviceCleanupDelay, TimeUnit unit)
	Copy this policy and override the value of the property. More...

Protected Attributes
OsplServiceEnvironment	environment

Detailed Description

Definition at line 33 of file DurabilityServiceImpl.java.

Constructor & Destructor Documentation

◆ DurabilityServiceImpl() [1/2]

org.opensplice.dds.core.policy.DurabilityServiceImpl.DurabilityServiceImpl ( OsplServiceEnvironment environment )

Definition at line 42 of file DurabilityServiceImpl.java.

◆ DurabilityServiceImpl() [2/2]

org.opensplice.dds.core.policy.DurabilityServiceImpl.DurabilityServiceImpl	(	OsplServiceEnvironment	environment,
		Duration	serviceCleanupDelay,
		Kind	historyKind,
		int	historyDepth,
		int	maxSamples,
		int	maxInstances,
		int	maxSamplesPerInstance
	)

Definition at line 51 of file DurabilityServiceImpl.java.

Member Function Documentation

◆ equals()

boolean org.opensplice.dds.core.policy.DurabilityServiceImpl.equals ( Object other )

Definition at line 155 of file DurabilityServiceImpl.java.

◆ getEnvironment()

ServiceEnvironment org.opensplice.dds.core.policy.QosPolicyImpl.getEnvironment ( )

inherited

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

Implements org.omg.dds.core.DDSObject.

Definition at line 40 of file QosPolicyImpl.java.

◆ getHistoryDepth()

int org.opensplice.dds.core.policy.DurabilityServiceImpl.getHistoryDepth ( )

Returns: the historyDepth

Implements org.omg.dds.core.policy.DurabilityService.

Definition at line 78 of file DurabilityServiceImpl.java.

◆ getHistoryKind()

Kind org.opensplice.dds.core.policy.DurabilityServiceImpl.getHistoryKind ( )

Returns: the historyKind

Implements org.omg.dds.core.policy.DurabilityService.

Definition at line 73 of file DurabilityServiceImpl.java.

◆ getMaxInstances()

int org.opensplice.dds.core.policy.DurabilityServiceImpl.getMaxInstances ( )

Returns: the maxInstances

Implements org.omg.dds.core.policy.DurabilityService.

Definition at line 88 of file DurabilityServiceImpl.java.

◆ getMaxSamples()

int org.opensplice.dds.core.policy.DurabilityServiceImpl.getMaxSamples ( )

Returns: the maxSamples

Implements org.omg.dds.core.policy.DurabilityService.

Definition at line 83 of file DurabilityServiceImpl.java.

◆ getMaxSamplesPerInstance()

int org.opensplice.dds.core.policy.DurabilityServiceImpl.getMaxSamplesPerInstance ( )

Returns: the maxSamplesPerInstance

Implements org.omg.dds.core.policy.DurabilityService.

Definition at line 93 of file DurabilityServiceImpl.java.

◆ getPolicyClass()

Class<? extends QosPolicy> org.opensplice.dds.core.policy.DurabilityServiceImpl.getPolicyClass ( )

Definition at line 150 of file DurabilityServiceImpl.java.

◆ getServiceCleanupDelay()

Duration org.opensplice.dds.core.policy.DurabilityServiceImpl.getServiceCleanupDelay ( )

Implements org.omg.dds.core.policy.DurabilityService.

Definition at line 68 of file DurabilityServiceImpl.java.

◆ hashCode()

int org.opensplice.dds.core.policy.DurabilityServiceImpl.hashCode ( )

Definition at line 177 of file DurabilityServiceImpl.java.

◆ withHistoryDepth()

DurabilityService org.opensplice.dds.core.policy.DurabilityServiceImpl.withHistoryDepth ( int historyDepth )

Copy this policy and override the value of the property.

Parameters

historyDepth Specifies the number of samples of each instance of data (identified by its key) that is managed by the durability service for the transient or persistent topic data-instances. If history_kind is KEEP_LAST, history_depth must be smaller than or equal to max_samples_per_instance for this QosPolicy to be consistent.

Returns: a new DurabilityService policy

Implements org.omg.dds.core.policy.DurabilityService.

Definition at line 122 of file DurabilityServiceImpl.java.

◆ withHistoryKind() [1/2]

DurabilityService org.omg.dds.core.policy.DurabilityService.withHistoryKind ( History.Kind historyKind )

inherited

Copy this policy and override the value of the property.

Parameters

historyKind Specifies the type of history, which may be KEEP_LAST or KEEP_ALL, the durability service must apply for the transient or persistent topic data-instances.

Returns: a new DurabilityService policy

◆ withHistoryKind() [2/2]

DurabilityService org.opensplice.dds.core.policy.DurabilityServiceImpl.withHistoryKind ( Kind historyKind )

Definition at line 115 of file DurabilityServiceImpl.java.

◆ withMaxInstances()

DurabilityService org.opensplice.dds.core.policy.DurabilityServiceImpl.withMaxInstances ( int maxInstances )

Copy this policy and override the value of the property.

Parameters

maxInstances Specifies the maximum number of instances the durability service - manage for the transient or persistent topic data-instances.

Returns: a new DurabilityService policy

Implements org.omg.dds.core.policy.DurabilityService.

Definition at line 136 of file DurabilityServiceImpl.java.

◆ withMaxSamples()

DurabilityService org.opensplice.dds.core.policy.DurabilityServiceImpl.withMaxSamples ( int maxSamples )

Copy this policy and override the value of the property.

Parameters

maxSamples Specifies the maximum number of data samples for all instances the durability service will manage for the transient or persistent topic data-instances.

Returns: a new DurabilityService policy

Implements org.omg.dds.core.policy.DurabilityService.

Definition at line 129 of file DurabilityServiceImpl.java.

◆ withMaxSamplesPerInstance()

DurabilityService org.opensplice.dds.core.policy.DurabilityServiceImpl.withMaxSamplesPerInstance ( int maxSamplesPerInstance )

Copy this policy and override the value of the property.

Parameters

maxSamplesPerInstance Specifies the maximum number of samples of any single instance the durability service will manage for the transient or persistent topic data-instances. If history_kind is KEEP_LAST, max_samples_per_instance must be greater than or equal to history_depth for this QosPolicy to be consistent.

Returns: a new DurabilityService policy

Implements org.omg.dds.core.policy.DurabilityService.

Definition at line 143 of file DurabilityServiceImpl.java.

◆ withServiceCleanupDelay() [1/2]

DurabilityService org.opensplice.dds.core.policy.DurabilityServiceImpl.withServiceCleanupDelay ( Duration serviceCleanupDelay )

Copy this policy and override the value of the property.

Parameters

serviceCleanupDelay A duration on how long the durability service must wait before it is allowed to remove the information on the transient or persistent topic data-instances as a result of incoming dispose messages.

Returns: a new DurabilityService policy

Implements org.omg.dds.core.policy.DurabilityService.

Definition at line 98 of file DurabilityServiceImpl.java.

◆ withServiceCleanupDelay() [2/2]

DurabilityService org.opensplice.dds.core.policy.DurabilityServiceImpl.withServiceCleanupDelay	(	long	serviceCleanupDelay,
		TimeUnit	unit
	)

Copy this policy and override the value of the property.

Parameters

serviceCleanupDelay	A long on how long the durability service must wait before it is allowed to remove the information on the transient or persistent topic data-instances as a result of incoming dispose messages.
unit	The TimeUnit which the serviceCleanupDelay long describes (i.e. TimeUnit.SECONDS or TimeUnit.MILLISECONDS)

Returns: a new DurabilityService policy

Implements org.omg.dds.core.policy.DurabilityService.

Definition at line 106 of file DurabilityServiceImpl.java.

Member Data Documentation

◆ environment

OsplServiceEnvironment org.opensplice.dds.core.policy.QosPolicyImpl.environment

protectedinherited

Definition at line 29 of file QosPolicyImpl.java.

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

java5/common/java/code/org/opensplice/dds/core/policy/DurabilityServiceImpl.java

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DurabilityServiceImpl() [1/2]

◆ DurabilityServiceImpl() [2/2]

Member Function Documentation

◆ equals()

◆ getEnvironment()

◆ getHistoryDepth()

◆ getHistoryKind()

◆ getMaxInstances()

◆ getMaxSamples()

◆ getMaxSamplesPerInstance()

◆ getPolicyClass()

◆ getServiceCleanupDelay()

◆ hashCode()

◆ withHistoryDepth()

◆ withHistoryKind() [1/2]

◆ withHistoryKind() [2/2]

◆ withMaxInstances()

◆ withMaxSamples()

◆ withMaxSamplesPerInstance()

◆ withServiceCleanupDelay() [1/2]

◆ withServiceCleanupDelay() [2/2]

Member Data Documentation

◆ environment