OpenSplice Java 5 DCPS  v6.x
OpenSplice Java 5 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
org.opensplice.dds.core.policy.ReliabilityImpl Class Reference
Inheritance diagram for org.opensplice.dds.core.policy.ReliabilityImpl:
Inheritance graph
Collaboration diagram for org.opensplice.dds.core.policy.ReliabilityImpl:
Collaboration graph

Public Member Functions

 ReliabilityImpl (OsplServiceEnvironment environment)
 
 ReliabilityImpl (OsplServiceEnvironment environment, Kind kind, Duration maxBlockingTime, boolean synchronous)
 
int compareTo (org.omg.dds.core.policy.Reliability o)
 
boolean equals (Object other)
 
ServiceEnvironment getEnvironment ()
 
Kind getKind ()
 
Duration getMaxBlockingTime ()
 
Class<? extends QosPolicygetPolicyClass ()
 
int hashCode ()
 
boolean isSynchronous ()
 
Comparable< org.omg.dds.core.policy.ReliabilityrequestedOfferedContract ()
 
Reliability withBestEffort ()
 
Reliability withKind (Kind kind)
 Copy this policy and override the value of the property. More...
 
Reliability withKind (Kind kind)
 
Reliability withMaxBlockingTime (Duration maxBlockingTime)
 Copy this policy and override the value of the property. More...
 
Reliability withMaxBlockingTime (long maxBlockingTime, TimeUnit unit)
 Copy this policy and override the value of the property. More...
 
Reliability withReliable ()
 
Reliability withSynchronous (boolean synchronous)
 

Protected Attributes

OsplServiceEnvironment environment
 

Detailed Description

Definition at line 30 of file ReliabilityImpl.java.

Constructor & Destructor Documentation

◆ ReliabilityImpl() [1/2]

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

Definition at line 36 of file ReliabilityImpl.java.

◆ ReliabilityImpl() [2/2]

org.opensplice.dds.core.policy.ReliabilityImpl.ReliabilityImpl ( OsplServiceEnvironment  environment,
Kind  kind,
Duration  maxBlockingTime,
boolean  synchronous 
)

Definition at line 44 of file ReliabilityImpl.java.

Member Function Documentation

◆ compareTo()

int org.opensplice.dds.core.policy.ReliabilityImpl.compareTo ( org.omg.dds.core.policy.Reliability  o)

Definition at line 67 of file ReliabilityImpl.java.

◆ equals()

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

Definition at line 90 of file ReliabilityImpl.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.ReliabilityImpl.getKind ( )
Returns
the kind

Implements org.omg.dds.core.policy.Reliability.

Definition at line 106 of file ReliabilityImpl.java.

◆ getMaxBlockingTime()

Duration org.opensplice.dds.core.policy.ReliabilityImpl.getMaxBlockingTime ( )
Returns
the maximum blocking time

Implements org.omg.dds.core.policy.Reliability.

Definition at line 111 of file ReliabilityImpl.java.

◆ getPolicyClass()

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

Definition at line 158 of file ReliabilityImpl.java.

◆ hashCode()

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

Definition at line 163 of file ReliabilityImpl.java.

◆ isSynchronous()

boolean org.opensplice.dds.core.policy.ReliabilityImpl.isSynchronous ( )

Definition at line 147 of file ReliabilityImpl.java.

◆ requestedOfferedContract()

Comparable<org.omg.dds.core.policy.Reliability> org.opensplice.dds.core.policy.ReliabilityImpl.requestedOfferedContract ( )

Definition at line 62 of file ReliabilityImpl.java.

◆ withBestEffort()

Reliability org.opensplice.dds.core.policy.ReliabilityImpl.withBestEffort ( )
Returns
a best effort Reliability policy

Implements org.omg.dds.core.policy.Reliability.

Definition at line 135 of file ReliabilityImpl.java.

◆ withKind() [1/2]

Reliability org.omg.dds.core.policy.Reliability.withKind ( Kind  kind)
inherited

Copy this policy and override the value of the property.

Parameters
kindSpecifies the type of reliability which may be BEST_EFFORT or RELIABLE.
Returns
a new Reliability policy

◆ withKind() [2/2]

Reliability org.opensplice.dds.core.policy.ReliabilityImpl.withKind ( Kind  kind)

Definition at line 116 of file ReliabilityImpl.java.

◆ withMaxBlockingTime() [1/2]

Reliability org.opensplice.dds.core.policy.ReliabilityImpl.withMaxBlockingTime ( Duration  maxBlockingTime)

Copy this policy and override the value of the property.

Parameters
maxBlockingTimeSpecifies a duration which is the maximum time the write operation may block when the DataWriter does not have space to store the value or when synchronous communication is specified and all expected acknowledgments are not yet received.
Returns
a new Reliability policy

Implements org.omg.dds.core.policy.Reliability.

Definition at line 122 of file ReliabilityImpl.java.

◆ withMaxBlockingTime() [2/2]

Reliability org.opensplice.dds.core.policy.ReliabilityImpl.withMaxBlockingTime ( long  maxBlockingTime,
TimeUnit  unit 
)

Copy this policy and override the value of the property.

Parameters
maxBlockingTimeSpecifies a long maxBlockingTime which is the maximum time the write operation may block when the DataWriter does not have space to store the value or when synchronous communication is specified and all expected acknowledgments are not yet received.
unitThe TimeUnit which the period describes (i.e. TimeUnit.SECONDS or TimeUnit.MILLISECONDS)
Returns
a new Reliability policy

Implements org.omg.dds.core.policy.Reliability.

Definition at line 128 of file ReliabilityImpl.java.

◆ withReliable()

Reliability org.opensplice.dds.core.policy.ReliabilityImpl.withReliable ( )
Returns
a reliable Reliability policy

Implements org.omg.dds.core.policy.Reliability.

Definition at line 141 of file ReliabilityImpl.java.

◆ withSynchronous()

Reliability org.opensplice.dds.core.policy.ReliabilityImpl.withSynchronous ( boolean  synchronous)

Definition at line 152 of file ReliabilityImpl.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: