net.sf.jrtps

Class QualityOfService

java.lang.Object

net.sf.jrtps.QualityOfService

public class QualityOfService
extends Object

QualityOfService holds a collection QosPolicies.

Author:

mcr70

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	QualityOfService.PolicyListener PolicyChangedListener can be used to track changes to QualityOfService.

Constructor Summary

Constructors

Constructor and Description
QualityOfService() Constructor with default QosPolicies.

Method Summary

Modifier and Type	Method and Description
void	addPolicyListener(QualityOfService.PolicyListener listener)
QosDataRepresentation	getDataRepresentation() Gets the DataRepresentation QosPolicy
QosDeadline	getDeadline() Gets the Deadline QosPolicy
QosDestinationOrder	getDestinationOrder() Gets the Deadline QosPolicy
QosDurability	getDurability() Gets the Durability QosPolicy
QosDurabilityService	getDurabilityService() Gets the DurabilityService QosPolicy
QosGroupData	getGroupData() Gets the GroupData QosPolicy
QosHistory	getHistory() Gets the History QosPolicy
Set<QosPolicy<?>>	getIncompatibleQos(QualityOfService other) Gets all the incompatible policies that are found from either QualityOfService.
Set<QosPolicy<?>>	getInlinePolicies() Gets all the inlineable QosPolicies from this QualityOfService.
QosLatencyBudget	getLatencyBudget() Gets the LatencyBudget QosPolicy
QosLifespan	getLifespan() Gets the Lifespan QosPolicy
QosLiveliness	getLiveliness() Gets the Liveliness QosPolicy
QosOwnership	getOwnership() Gets the Ownership QosPolicy
QosOwnershipStrength	getOwnershipStrength() Gets the OwnershipStrength QosPolicy
QosPartition	getPartition() Gets the Partition QosPolicy
QosPresentation	getPresentation() Gets the Presentation QosPolicy
Set<DataReaderPolicy>	getReaderPolicies() Gets all the DataReaderPolicies from this QualityOfService.
QosReliability	getReliability() Gets the Reliability QosPolicy
QosResourceLimits	getResourceLimits() Gets the ResourceLimits QosPolicy
static QualityOfService	getSEDPQualityOfService() Gets the QualityOfService used in Simple Endpoint Discovery Protocol(SEDP)
static QualityOfService	getSPDPQualityOfService() Gets the QualityOfService used in Simple Participant Discovery Protocol(SPDP)
QosTimeBasedFilter	getTimeBasedFilter() Gets the TimeBasedFilter QosPolicy
QosTopicData	getTopicData() Gets the TopicData QosPolicy
Set<TopicPolicy>	getTopicPolicies() Gets all the TopicPolicies from this QualityOfService.
QosTransportPriority	getTransportPriority() Gets the TransportPriority QosPolicy
QosTypeConsistencyEnforcement	getTypeConsistencyEnforcement()
QosUserData	getUserData() Gets the TransportPriority QosPolicy
Set<DataWriterPolicy>	getWriterPolicies() Gets all the DataWriterPolicies from this QualityOfService.
boolean	isCompatibleWith(QualityOfService other) Checks wheter or not this QualityOfService is compatible with the other.
void	setPolicy(QosPolicy policy) Sets a given QosPolicy.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

QualityOfService

public QualityOfService()

Constructor with default QosPolicies.

Method Detail

setPolicy

public void setPolicy(QosPolicy policy)
               throws InconsistentPolicy

Sets a given QosPolicy. Old value will be overridden.

Parameters:

policy - QosPolicy to set.

Throws:

InconsistentPolicy - is thrown if there is some inconsistent value with the policy

getReaderPolicies

public Set<DataReaderPolicy> getReaderPolicies()

Gets all the DataReaderPolicies from this QualityOfService. A new Set is always created when calling this method. Changes to returned Set is not reflected back to this QualityOfService.

Returns:

Data reader policies

getWriterPolicies

public Set<DataWriterPolicy> getWriterPolicies()

Gets all the DataWriterPolicies from this QualityOfService. A new Set is always created when calling this method. Changes to returned Set is not reflected back to this QualityOfService.

Returns:

Data writer policies

getTopicPolicies

public Set<TopicPolicy> getTopicPolicies()

Gets all the TopicPolicies from this QualityOfService. A new Set is always created when calling this method. Changes to returned Set is not reflected back to this QualityOfService.

Returns:

Topic policies

getInlinePolicies

public Set<QosPolicy<?>> getInlinePolicies()

Gets all the inlineable QosPolicies from this QualityOfService. A new Set is always created when calling this method. Changes to returned Set is not reflected back to this QualityOfService.

Returns:

Inlineable QosPolicies

getIncompatibleQos

public Set<QosPolicy<?>> getIncompatibleQos(QualityOfService other)

Gets all the incompatible policies that are found from either QualityOfService. I.e. check only policies that are explicitly set on either QualityOfService.

Parameters:

other - Other QoS

Returns:

a Set of QosPolicies. If all the policies are compatible, return an empty Set.

isCompatibleWith

public boolean isCompatibleWith(QualityOfService other)

Checks wheter or not this QualityOfService is compatible with the other.

Parameters:

other - Other QualityOfService

Returns:

true, if compatible

getSEDPQualityOfService

public static QualityOfService getSEDPQualityOfService()

Gets the QualityOfService used in Simple Endpoint Discovery Protocol(SEDP)

Returns:

QualityOfService for SEDP

getSPDPQualityOfService

public static QualityOfService getSPDPQualityOfService()

Gets the QualityOfService used in Simple Participant Discovery Protocol(SPDP)

Returns:

QualityOfService for SPDP

getDataRepresentation

public QosDataRepresentation getDataRepresentation()

Gets the DataRepresentation QosPolicy

Returns:

QosDataRepresentation

getDeadline

public QosDeadline getDeadline()

Gets the Deadline QosPolicy

Returns:

QosDeadline

getDestinationOrder

public QosDestinationOrder getDestinationOrder()

Gets the Deadline QosPolicy

Returns:

QosDeadline

getDurability

public QosDurability getDurability()

Gets the Durability QosPolicy

Returns:

QosDurability

getDurabilityService

public QosDurabilityService getDurabilityService()

Gets the DurabilityService QosPolicy

Returns:

QosDurability

getGroupData

public QosGroupData getGroupData()

Gets the GroupData QosPolicy

Returns:

QosGroupData

getHistory

public QosHistory getHistory()

Gets the History QosPolicy

Returns:

QosHistory

getLatencyBudget

public QosLatencyBudget getLatencyBudget()

Gets the LatencyBudget QosPolicy

Returns:

QosLatencyBudget

getLifespan

public QosLifespan getLifespan()

Gets the Lifespan QosPolicy

Returns:

QosLifespan

getLiveliness

public QosLiveliness getLiveliness()

Gets the Liveliness QosPolicy

Returns:

QosLiveliness

getOwnership

public QosOwnership getOwnership()

Gets the Ownership QosPolicy

Returns:

QosOwnership

getOwnershipStrength

public QosOwnershipStrength getOwnershipStrength()

Gets the OwnershipStrength QosPolicy

Returns:

QosOwnershipStrength

getPartition

public QosPartition getPartition()

Gets the Partition QosPolicy

Returns:

QosPartition

getPresentation

public QosPresentation getPresentation()

Gets the Presentation QosPolicy

Returns:

QosPresentation

getReliability

public QosReliability getReliability()

Gets the Reliability QosPolicy

Returns:

QosReliability

getResourceLimits

public QosResourceLimits getResourceLimits()

Gets the ResourceLimits QosPolicy

Returns:

QosResourceLimits

getTopicData

public QosTopicData getTopicData()

Gets the TopicData QosPolicy

Returns:

QosTopicData

getTransportPriority

public QosTransportPriority getTransportPriority()

Gets the TransportPriority QosPolicy

Returns:

QosTransportPriority

getTimeBasedFilter

public QosTimeBasedFilter getTimeBasedFilter()

Gets the TimeBasedFilter QosPolicy

Returns:

QosTimeBasedFilter

getUserData

public QosUserData getUserData()

Gets the TransportPriority QosPolicy

Returns:

QosTransportPriority

getTypeConsistencyEnforcement

public QosTypeConsistencyEnforcement getTypeConsistencyEnforcement()

toString

public String toString()

Overrides:

toString in class Object

addPolicyListener

public void addPolicyListener(QualityOfService.PolicyListener listener)