net.sf.jrtps.message.parameter

Class QosReliability

java.lang.Object

net.sf.jrtps.message.parameter.Parameter

net.sf.jrtps.message.parameter.QosReliability

All Implemented Interfaces:

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

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

This QoS policy controls whether or not communication between entities are established as reliable or best effort.

Author:

mcr70

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QosReliability.Kind

Constructor Summary

Constructors

Constructor and Description
QosReliability(QosReliability.Kind kind, Duration max_blocking_time)

Method Summary

Modifier and Type	Method and Description
static QosReliability	defaultReliability() get the default QosReliability: BEST_EFFORT, 0
QosReliability.Kind	getKind()
Duration	getMaxBlockingTime()
boolean	isCompatible(QosReliability other) Checks, if this QosPolicy is compatible with other QosPolicy.
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

QosReliability

public QosReliability(QosReliability.Kind kind,
                      Duration max_blocking_time)

Method Detail

getMaxBlockingTime

public Duration getMaxBlockingTime()

getKind

public QosReliability.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(QosReliability 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<QosReliability>

Parameters:

other - Requested QosPolicy

Returns:

true, if QosPolicy is compatible

defaultReliability

public static QosReliability defaultReliability()

get the default QosReliability: BEST_EFFORT, 0

Returns:

default QosReliability

toString

public String toString()

Overrides:

toString in class Parameter