net.sf.jrtps.message.parameter

Class QosLiveliness

java.lang.Object

net.sf.jrtps.message.parameter.Parameter

net.sf.jrtps.message.parameter.QosLiveliness

All Implemented Interfaces:

DataReaderPolicy<QosLiveliness>, DataWriterPolicy<QosLiveliness>, InlineQoS, QosPolicy<QosLiveliness>, TopicPolicy<QosLiveliness>

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

This policy controls the mechanism and parameters used by the Service to ensure that particular entities on the network are still “alive.”

See DDS specification v1.2, 7.1.3.11 Liveliness

Author:

mcr70

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QosLiveliness.Kind

Constructor Summary

Constructors

Constructor and Description
QosLiveliness(long millis) Constructs QosLiveliness with AUTOMATIC kind and given lease_duration
QosLiveliness(QosLiveliness.Kind kind, Duration lease_duration) Constructor of QosLiveliness.
QosLiveliness(QosLiveliness.Kind kind, long millis) Constructs QosLiveliness with given kind and lease_duration

Method Summary

Modifier and Type	Method and Description
static QosLiveliness	defaultLiveliness()
QosLiveliness.Kind	getKind()
Duration	getLeaseDuration() Get the lease_duration
boolean	isCompatible(QosLiveliness requested) Check if this QosLiveliness is compatible with requested.
void	read(RTPSByteBuffer bb, int length)
String	toString()
void	writeTo(RTPSByteBuffer buffer) 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

QosLiveliness

public QosLiveliness(QosLiveliness.Kind kind,
                     Duration lease_duration)

Constructor of QosLiveliness.

Parameters:

kind - Kind of liveliness

lease_duration - Duration of the lease. If a Writer fails to assert liveliness with lease_duration, it is assumed 'dead'

See Also:

QosLiveliness.Kind

QosLiveliness

public QosLiveliness(long millis)

Constructs QosLiveliness with AUTOMATIC kind and given lease_duration

Parameters:

millis - Lease duration in millis

QosLiveliness

public QosLiveliness(QosLiveliness.Kind kind,
                     long millis)

Constructs QosLiveliness with given kind and lease_duration

Parameters:

kind - Kind os QosLiveliness

millis - lease duration in milliseconds

Method Detail

getLeaseDuration

public Duration getLeaseDuration()

Get the lease_duration

Returns:

lease_duration

getKind

public QosLiveliness.Kind getKind()

read

public void read(RTPSByteBuffer bb,
                 int length)

Specified by:

read in class Parameter

writeTo

public void writeTo(RTPSByteBuffer buffer)

Description copied from class: Parameter

Writes this Parameter into given RTPSByteBuffer

Specified by:

writeTo in class Parameter

Parameters:

buffer - RTPSByteBuffer

isCompatible

public boolean isCompatible(QosLiveliness requested)

Check if this QosLiveliness is compatible with requested. It is considered compatible, if S *

this.kind ≥ requested.kind AND
this.lease_duration ≤s requested.lease_duration

For the comparison, Kind is ordered like AUTOMATIC < MANUAL_BY_PARTICIPANT < MANUAL_BY_TOPIC

Specified by:

isCompatible in interface QosPolicy<QosLiveliness>

Parameters:

requested - Requested QosLiveliness

Returns:

true, if compatible

See Also:

QosLiveliness.Kind

defaultLiveliness

public static QosLiveliness defaultLiveliness()

toString

public String toString()

Overrides:

toString in class Parameter