net.sf.jrtps.message.parameter

Class QosLifespan

java.lang.Object

net.sf.jrtps.message.parameter.Parameter

net.sf.jrtps.message.parameter.QosLifespan

All Implemented Interfaces:

Changeable, DataReaderPolicy<QosLifespan>, DataWriterPolicy<QosLifespan>, InlineQoS, QosPolicy<QosLifespan>, TopicPolicy<QosLifespan>

public class QosLifespan
extends Parameter
implements DataReaderPolicy<QosLifespan>, DataWriterPolicy<QosLifespan>, TopicPolicy<QosLifespan>, InlineQoS, Changeable

QosLifespan policy is used to automatically remove samples from history cache of entity. See DDS specification v1.2, ch 7.1.3.16

Author:

mcr70

Constructor Summary

Constructors

Constructor and Description
QosLifespan(Duration duration) Constructor for QosLifespan.
QosLifespan(long millis) Constructor for QosLifespan.

Method Summary

Modifier and Type	Method and Description
static QosLifespan	defaultLifespan() Get the default QosLifespan with infinite duration.
Duration	getDuration() Get the Duration of lifespan
boolean	isCompatible(QosLifespan other) Checks, if this QosPolicy is compatible with other QosPolicy.
void	read(RTPSByteBuffer bb, int length)
String	toString()
void	writeTo(RTPSByteBuffer bb) Writes this Parameter into given RTPSByteBuffer

Methods inherited from class net.sf.jrtps.message.parameter.Parameter

getBytes, getParameterId, readBytes, writeBytes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

QosLifespan

public QosLifespan(long millis)

Constructor for QosLifespan.

Parameters:

millis - Duration as millis

QosLifespan

public QosLifespan(Duration duration)

Constructor for QosLifespan.

Parameters:

duration - Duration

Method Detail

getDuration

public Duration getDuration()

Get the Duration of lifespan

Returns:

Duration

read

public void read(RTPSByteBuffer bb,
                 int length)

Specified by:

read in class Parameter

writeTo

public void writeTo(RTPSByteBuffer bb)

Description copied from class: Parameter

Writes this Parameter into given RTPSByteBuffer

Specified by:

writeTo in class Parameter

Parameters:

bb - RTPSByteBuffer

isCompatible

public boolean isCompatible(QosLifespan other)

Description copied from interface: QosPolicy

Checks, if this QosPolicy is compatible with other QosPolicy. 'this' QosPolicy should be considered as 'offered' policy, and 'other' should be considered as 'requested' policy.

Specified by:

isCompatible in interface QosPolicy<QosLifespan>

Parameters:

other - Requested QosPolicy

Returns:

true, if QosPolicy is compatible

defaultLifespan

public static QosLifespan defaultLifespan()

Get the default QosLifespan with infinite duration.

Returns:

default QosLifespan

toString

public String toString()

Overrides:

toString in class Parameter