OpenSplice Java 5 DCPS  v6.x
OpenSplice Java 5 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
Public Member Functions | Protected Attributes | List of all members
org.opensplice.dds.core.policy.LivelinessImpl Class Reference
Inheritance diagram for org.opensplice.dds.core.policy.LivelinessImpl:
Inheritance graph
Collaboration diagram for org.opensplice.dds.core.policy.LivelinessImpl:
Collaboration graph

Public Member Functions

 LivelinessImpl (OsplServiceEnvironment environment)
 
 LivelinessImpl (OsplServiceEnvironment environment, Kind kind, Duration leaseDuration)
 
int compareTo (Liveliness o)
 
boolean equals (Object other)
 
ServiceEnvironment getEnvironment ()
 
Kind getKind ()
 
Duration getLeaseDuration ()
 
Class<? extends QosPolicy > getPolicyClass ()
 
int hashCode ()
 
Comparable< Liveliness > requestedOfferedContract ()
 
Liveliness withAutomatic ()
 
Liveliness withKind (Kind kind)
 Copy this policy and override the value of the property. More...
 
Liveliness withLeaseDuration (Duration leaseDuration)
 Copy this policy and override the value of the property. More...
 
Liveliness withLeaseDuration (long leaseDuration, TimeUnit unit)
 Copy this policy and override the value of the property. More...
 
Liveliness withManualByParticipant ()
 
Liveliness withManualByTopic ()
 

Protected Attributes

OsplServiceEnvironment environment
 

Detailed Description

Definition at line 31 of file LivelinessImpl.java.

Constructor & Destructor Documentation

◆ LivelinessImpl() [1/2]

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

Definition at line 36 of file LivelinessImpl.java.

◆ LivelinessImpl() [2/2]

org.opensplice.dds.core.policy.LivelinessImpl.LivelinessImpl ( OsplServiceEnvironment  environment,
Kind  kind,
Duration  leaseDuration 
)

Definition at line 42 of file LivelinessImpl.java.

Member Function Documentation

◆ compareTo()

int org.opensplice.dds.core.policy.LivelinessImpl.compareTo ( Liveliness  o)

Definition at line 64 of file LivelinessImpl.java.

◆ equals()

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

Definition at line 83 of file LivelinessImpl.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.

◆ getKind()

Kind org.opensplice.dds.core.policy.LivelinessImpl.getKind ( )
Returns
the kind

Implements org.omg.dds.core.policy.Liveliness.

Definition at line 96 of file LivelinessImpl.java.

◆ getLeaseDuration()

Duration org.opensplice.dds.core.policy.LivelinessImpl.getLeaseDuration ( )
Returns
the lease duration

Implements org.omg.dds.core.policy.Liveliness.

Definition at line 101 of file LivelinessImpl.java.

◆ getPolicyClass()

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

Definition at line 140 of file LivelinessImpl.java.

◆ hashCode()

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

Definition at line 145 of file LivelinessImpl.java.

◆ requestedOfferedContract()

Comparable<Liveliness> org.opensplice.dds.core.policy.LivelinessImpl.requestedOfferedContract ( )

Definition at line 59 of file LivelinessImpl.java.

◆ withAutomatic()

Liveliness org.opensplice.dds.core.policy.LivelinessImpl.withAutomatic ( )
Returns
Liveliness automatic policy

Implements org.omg.dds.core.policy.Liveliness.

Definition at line 122 of file LivelinessImpl.java.

◆ withKind()

Liveliness org.opensplice.dds.core.policy.LivelinessImpl.withKind ( Kind  kind)

Copy this policy and override the value of the property.

Parameters
kindSpecifies the way the liveliness of an Entity is determined
Returns
a new Liveliness policy

Implements org.omg.dds.core.policy.Liveliness.

Definition at line 106 of file LivelinessImpl.java.

◆ withLeaseDuration() [1/2]

Liveliness org.opensplice.dds.core.policy.LivelinessImpl.withLeaseDuration ( Duration  leaseDuration)

Copy this policy and override the value of the property.

Parameters
leaseDurationSpecifies the duration of the interval within which the liveliness must be determined.
Returns
a new Liveliness policy

Implements org.omg.dds.core.policy.Liveliness.

Definition at line 111 of file LivelinessImpl.java.

◆ withLeaseDuration() [2/2]

Liveliness org.opensplice.dds.core.policy.LivelinessImpl.withLeaseDuration ( long  leaseDuration,
TimeUnit  unit 
)

Copy this policy and override the value of the property.

Parameters
leaseDurationSpecifies a long leaseDuration for the interval within which the liveliness must be determined.
unitThe TimeUnit which the duration describes (i.e. TimeUnit.SECONDS or TimeUnit.MILLISECONDS)
Returns
a new Liveliness policy

Implements org.omg.dds.core.policy.Liveliness.

Definition at line 116 of file LivelinessImpl.java.

◆ withManualByParticipant()

Liveliness org.opensplice.dds.core.policy.LivelinessImpl.withManualByParticipant ( )
Returns
Liveliness manual by participant policy

Implements org.omg.dds.core.policy.Liveliness.

Definition at line 128 of file LivelinessImpl.java.

◆ withManualByTopic()

Liveliness org.opensplice.dds.core.policy.LivelinessImpl.withManualByTopic ( )
Returns
Liveliness manual by topic policy

Implements org.omg.dds.core.policy.Liveliness.

Definition at line 134 of file LivelinessImpl.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: