net.sf.jrtps.message.parameter

Class QosDeadline

java.lang.Object

net.sf.jrtps.message.parameter.Parameter

net.sf.jrtps.message.parameter.QosDeadline

All Implemented Interfaces:

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

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

This policy is useful for cases where a Topic is expected to have each instance updated periodically. On the publishing side this setting establishes a contract that the application must meet. On the subscribing side the setting establishes a minimum requirement for the remote publishers that are expected to supply the data values.

This policy must be consistent with QosTimeBasedFilter, so that period ≤ minimum_separation. See 7.1.3.7 DEADLINE

Author:

mcr70

Constructor Summary

Constructors

Constructor and Description
QosDeadline(Duration period) Constructor with period given as Duration
QosDeadline(long periodAsMillis) Constructor with period given as milliseconds

Method Summary

Modifier and Type	Method and Description
static QosDeadline	defaultDeadline() Gets a default QosDeadline with period Duration_t.INFINITE
Duration	getPeriod() Get the period of this DEADLINE policy.
boolean	isCompatible(QosDeadline other) Checks, if this QosDeadline is compatible with the 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

QosDeadline

public QosDeadline(long periodAsMillis)

Constructor with period given as milliseconds

Parameters:

periodAsMillis - milliseconds

QosDeadline

public QosDeadline(Duration period)

Constructor with period given as Duration

Parameters:

period - Duration

Method Detail

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

getPeriod

public Duration getPeriod()

Get the period of this DEADLINE policy.

Returns:

deadline

isCompatible

public boolean isCompatible(QosDeadline other)

Checks, if this QosDeadline is compatible with the other QosPolicy.

Specified by:

isCompatible in interface QosPolicy<QosDeadline>

Parameters:

other - Requested QosPolicy

Returns:

true, if this.period ≤ other.period

defaultDeadline

public static QosDeadline defaultDeadline()

Gets a default QosDeadline with period Duration_t.INFINITE

Returns:

default QosDeadline

toString

public String toString()

Overrides:

toString in class Parameter