QoS policies supported by a Topic<T>. More...

Inherits IEquatable< TopicQos >.

Public Member Functions
TopicQos	WithTopicData (TopicData policy)
	Creates an instance with a new TopicData policy. More...

TopicQos	WithTopicData (Action< ImmutableList< byte >.Builder > build)
	Creates a new instance with a new TopicData policy as configured by a build action More...

TopicQos	WithDurability (Durability policy)
	Creates an instance with a new Durability policy. More...

TopicQos	WithDurability (Action< DurabilityBuilder > build)
	Creates a new instance with a new Durability policy as configured by a build action More...

TopicQos	WithDurabilityService (DurabilityService policy)
	Creates an instance with a new DurabilityService policy. More...

TopicQos	WithDurabilityService (Action< DurabilityServiceBuilder > build)
	Creates a new instance with a new DurabilityService policy as configured by a build action More...

TopicQos	WithDeadline (Deadline policy)
	Creates an instance with a new Deadline policy. More...

TopicQos	WithDeadline (Action< DeadlineBuilder > build)
	Creates a new instance with a new Deadline policy as configured by a build action More...

TopicQos	WithLatencyBudget (LatencyBudget policy)
	Creates an instance with a new LatencyBudget policy. More...

TopicQos	WithLatencyBudget (Action< LatencyBudgetBuilder > build)
	Creates a new instance with a new LatencyBudget policy as configured by a build action More...

TopicQos	WithLiveliness (Liveliness policy)
	Creates an instance with a new Liveliness policy. More...

TopicQos	WithLiveliness (Action< LivelinessBuilder > build)
	Creates a new instance with a new Liveliness policy as configured by a build action More...

TopicQos	WithReliability (Reliability policy)
	Creates an instance with a new Reliability policy. More...

TopicQos	WithReliability (Action< ReliabilityBuilder > build)
	Creates a new instance with a new Reliability policy as configured by a build action More...

TopicQos	WithDestinationOrder (DestinationOrder policy)
	Creates an instance with a new DestinationOrder policy. More...

TopicQos	WithDestinationOrder (Action< DestinationOrderBuilder > build)
	Creates a new instance with a new DestinationOrder policy as configured by a build action More...

TopicQos	WithHistory (History policy)
	Creates an instance with a new History policy. More...

TopicQos	WithHistory (Action< HistoryBuilder > build)
	Creates a new instance with a new History policy as configured by a build action More...

TopicQos	WithResourceLimits (ResourceLimits policy)
	Creates an instance with a new ResourceLimits policy. More...

TopicQos	WithResourceLimits (Action< ResourceLimitsBuilder > build)
	Creates a new instance with a new ResourceLimits policy as configured by a build action More...

TopicQos	WithTransportPriority (TransportPriority policy)
	Creates an instance with a new TransportPriority policy. More...

TopicQos	WithTransportPriority (Action< TransportPriorityBuilder > build)
	Creates a new instance with a new TransportPriority policy as configured by a build action More...

TopicQos	WithLifespan (Lifespan policy)
	Creates an instance with a new Lifespan policy. More...

TopicQos	WithLifespan (Action< LifespanBuilder > build)
	Creates a new instance with a new Lifespan policy as configured by a build action More...

TopicQos	WithOwnership (Ownership policy)
	Creates an instance with a new Ownership policy. More...

TopicQos	WithOwnership (Action< OwnershipBuilder > build)
	Creates a new instance with a new Ownership policy as configured by a build action More...

TopicQos	WithRepresentation (DataRepresentation policy)
	Creates an instance with a new DataRepresentation policy. More...

TopicQos	WithRepresentation (Action< DataRepresentationBuilder > build)
	Creates a new instance with a new DataRepresentation policy as configured by a build action More...

DataWriterQos	ToDataWriterQos ()
	Creates a DataWriterQos object with the policies of this TopicQos. More...

DataReaderQos	ToDataReaderQos ()
	Creates a DataReaderQos object with the policies of this TopicQos. More...

bool	Equals (TopicQos other)
	Compares all the policies for equality More...

override int	GetHashCode ()
	Returns the hash code by combining that of each policy More...

override bool	Equals (object obj)
	Compares all the policies for equality More...

override string	ToString ()
	Returns an XML representation of the QoS object. More...

string	ToString (QosPrintFormat format)
	Returns an XML representation of the QoS object. More...

string	ToString (TopicQos baseQos, QosPrintFormat format=null)
	Returns an XML representation of the QoS object. More...

string	ToString (QosPrintAll baseQos, QosPrintFormat format=null)
	Returns an XML representation of the QoS object. More...

Properties
static TopicQos	Default `[get]`
	Singleton containing the documented default value of a TopicQos More...

TopicData	TopicData `[get]`
	Gets the TopicData policy. More...

Durability	Durability `[get]`
	Gets the Durability policy. More...

DurabilityService	DurabilityService `[get]`
	Gets the DurabilityService policy. More...

Deadline	Deadline `[get]`
	Gets the Deadline policy. More...

LatencyBudget	LatencyBudget `[get]`
	Gets the LatencyBudget policy. More...

Liveliness	Liveliness `[get]`
	Gets the Liveliness policy. More...

Reliability	Reliability `[get]`
	Gets the Reliability policy. More...

DestinationOrder	DestinationOrder `[get]`
	Gets the DestinationOrder policy. More...

History	History `[get]`
	Gets the History policy. More...

ResourceLimits	ResourceLimits `[get]`
	Gets the ResourceLimits policy. More...

TransportPriority	TransportPriority `[get]`
	Gets the TransportPriority policy. More...

Lifespan	Lifespan `[get]`
	Gets the Lifespan policy. More...

Ownership	Ownership `[get]`
	Gets the Ownership policy. More...

DataRepresentation	Representation `[get]`
	Gets the DataRepresentation policy. More...

Detailed Description

QoS policies supported by a Topic<T>.

The full documentation is available in the C API: DDS_TopicQos

Member Function Documentation

◆ Equals() [1/2]

override bool Equals ( object obj )

Compares all the policies for equality

◆ Equals() [2/2]

bool Equals ( TopicQos other )

Compares all the policies for equality

◆ GetHashCode()

override int GetHashCode ( )

Returns the hash code by combining that of each policy

◆ ToDataReaderQos()

DataReaderQos ToDataReaderQos ( )

Creates a DataReaderQos object with the policies of this TopicQos.

◆ ToDataWriterQos()

DataWriterQos ToDataWriterQos ( )

Creates a DataWriterQos object with the policies of this TopicQos.

◆ ToString() [1/4]

override string ToString ( )

Returns an XML representation of the QoS object.

The output is formatted using the default values for the QosPrintFormat and only QoS policies which differ from the documented default are included.

◆ ToString() [2/4]

string ToString	(	QosPrintAll	baseQos,
		QosPrintFormat	format = `null`
	)

Returns an XML representation of the QoS object.

Parameters

baseQos	Used to indicate that the entire QoS object should be included in the output. The only value which should be provided for this argument is QosPrintAll.Value
format	The format used to configure the output. If not supplied, the output is formatted using the default format.

This overload accepts a parameter of type QosPrintAll. Unlike the other ToString overloads, the entire QoS object will be included in the output.

◆ ToString() [3/4]

string ToString ( QosPrintFormat format )

Returns an XML representation of the QoS object.

Parameters

format The baseQos profile.

This overload accepts a value for the baseQos. Only the differences between the TopicQos object being printed and the baseQos are included in the output.

◆ ToString() [4/4]

string ToString	(	TopicQos	baseQos,
		QosPrintFormat	format = `null`
	)

Returns an XML representation of the QoS object.

Parameters

baseQos	The baseQos profile.
format	the format used to configure the output. If not supplied the output is formatted using the default format.

This overload accepts a value for the baseQos. Only the differences between the TopicQos object being printed and the baseQos are included in the output.

◆ WithDeadline() [1/2]

TopicQos WithDeadline ( Action< DeadlineBuilder > build )

Creates a new instance with a new Deadline policy as configured by a build action

Parameters

build A function receiving the current values of the policy as an argument. The changes performed by this build function will be used to create the new policy.

Returns: A new instance with the sames policies as the current instance, except for the policy being modified

◆ WithDeadline() [2/2]

TopicQos WithDeadline ( Deadline policy )

Creates an instance with a new Deadline policy.

Parameters

policy The new policy

Returns: A new instance with the same policies as the current instance, except for the one being set

◆ WithDestinationOrder() [1/2]

TopicQos WithDestinationOrder ( Action< DestinationOrderBuilder > build )

Creates a new instance with a new DestinationOrder policy as configured by a build action

Parameters

build A function receiving the current values of the policy as an argument. The changes performed by this build function will be used to create the new policy.

Returns: A new instance with the sames policies as the current instance, except for the policy being modified

◆ WithDestinationOrder() [2/2]

TopicQos WithDestinationOrder ( DestinationOrder policy )

Creates an instance with a new DestinationOrder policy.

Parameters

policy The new policy

Returns: A new instance with the same policies as the current instance, except for the one being set

◆ WithDurability() [1/2]

TopicQos WithDurability ( Action< DurabilityBuilder > build )

Creates a new instance with a new Durability policy as configured by a build action

Parameters

build A function receiving the current values of the policy as an argument. The changes performed by this build function will be used to create the new policy.

Returns: A new instance with the sames policies as the current instance, except for the policy being modified

◆ WithDurability() [2/2]

TopicQos WithDurability ( Durability policy )

Creates an instance with a new Durability policy.

Parameters

policy The new policy

Returns: A new instance with the same policies as the current instance, except for the one being set

◆ WithDurabilityService() [1/2]

TopicQos WithDurabilityService ( Action< DurabilityServiceBuilder > build )

Creates a new instance with a new DurabilityService policy as configured by a build action

Parameters

build A function receiving the current values of the policy as an argument. The changes performed by this build function will be used to create the new policy.

Returns: A new instance with the sames policies as the current instance, except for the policy being modified

◆ WithDurabilityService() [2/2]

TopicQos WithDurabilityService ( DurabilityService policy )

Creates an instance with a new DurabilityService policy.

Parameters

policy The new policy

Returns: A new instance with the same policies as the current instance, except for the one being set

◆ WithHistory() [1/2]

TopicQos WithHistory ( Action< HistoryBuilder > build )

Creates a new instance with a new History policy as configured by a build action

Parameters

build A function receiving the current values of the policy as an argument. The changes performed by this build function will be used to create the new policy.

Returns: A new instance with the sames policies as the current instance, except for the policy being modified

◆ WithHistory() [2/2]

TopicQos WithHistory ( History policy )

Creates an instance with a new History policy.

Parameters

policy The new policy

Returns: A new instance with the same policies as the current instance, except for the one being set

◆ WithLatencyBudget() [1/2]

TopicQos WithLatencyBudget ( Action< LatencyBudgetBuilder > build )

Creates a new instance with a new LatencyBudget policy as configured by a build action

Parameters

build A function receiving the current values of the policy as an argument. The changes performed by this build function will be used to create the new policy.

Returns: A new instance with the sames policies as the current instance, except for the policy being modified

◆ WithLatencyBudget() [2/2]

TopicQos WithLatencyBudget ( LatencyBudget policy )

Creates an instance with a new LatencyBudget policy.

Parameters

policy The new policy

Returns: A new instance with the same policies as the current instance, except for the one being set

◆ WithLifespan() [1/2]

TopicQos WithLifespan ( Action< LifespanBuilder > build )

Creates a new instance with a new Lifespan policy as configured by a build action

Parameters

build A function receiving the current values of the policy as an argument. The changes performed by this build function will be used to create the new policy.

Returns: A new instance with the sames policies as the current instance, except for the policy being modified

◆ WithLifespan() [2/2]

TopicQos WithLifespan ( Lifespan policy )

Creates an instance with a new Lifespan policy.

Parameters

policy The new policy

Returns: A new instance with the same policies as the current instance, except for the one being set

◆ WithLiveliness() [1/2]

TopicQos WithLiveliness ( Action< LivelinessBuilder > build )

Creates a new instance with a new Liveliness policy as configured by a build action

Parameters

build A function receiving the current values of the policy as an argument. The changes performed by this build function will be used to create the new policy.

Returns: A new instance with the sames policies as the current instance, except for the policy being modified

◆ WithLiveliness() [2/2]

TopicQos WithLiveliness ( Liveliness policy )

Creates an instance with a new Liveliness policy.

Parameters

policy The new policy

Returns: A new instance with the same policies as the current instance, except for the one being set

◆ WithOwnership() [1/2]

TopicQos WithOwnership ( Action< OwnershipBuilder > build )

Creates a new instance with a new Ownership policy as configured by a build action

Parameters

build A function receiving the current values of the policy as an argument. The changes performed by this build function will be used to create the new policy.

Returns: A new instance with the sames policies as the current instance, except for the policy being modified

◆ WithOwnership() [2/2]

TopicQos WithOwnership ( Ownership policy )

Creates an instance with a new Ownership policy.

Parameters

policy The new policy

Returns: A new instance with the same policies as the current instance, except for the one being set

◆ WithReliability() [1/2]

TopicQos WithReliability ( Action< ReliabilityBuilder > build )

Creates a new instance with a new Reliability policy as configured by a build action

Parameters

build A function receiving the current values of the policy as an argument. The changes performed by this build function will be used to create the new policy.

Returns: A new instance with the sames policies as the current instance, except for the policy being modified

◆ WithReliability() [2/2]

TopicQos WithReliability ( Reliability policy )

Creates an instance with a new Reliability policy.

Parameters

policy The new policy

Returns: A new instance with the same policies as the current instance, except for the one being set

◆ WithRepresentation() [1/2]

TopicQos WithRepresentation ( Action< DataRepresentationBuilder > build )

Creates a new instance with a new DataRepresentation policy as configured by a build action

Parameters

build A function receiving the current values of the policy as an argument. The changes performed by this build function will be used to create the new policy.

Returns: A new instance with the sames policies as the current instance, except for the policy being modified

◆ WithRepresentation() [2/2]

TopicQos WithRepresentation ( DataRepresentation policy )

Creates an instance with a new DataRepresentation policy.

Parameters

policy The new policy

Returns: A new instance with the same policies as the current instance, except for the one being set

◆ WithResourceLimits() [1/2]

TopicQos WithResourceLimits ( Action< ResourceLimitsBuilder > build )

Creates a new instance with a new ResourceLimits policy as configured by a build action

Parameters

build A function receiving the current values of the policy as an argument. The changes performed by this build function will be used to create the new policy.

Returns: A new instance with the sames policies as the current instance, except for the policy being modified

◆ WithResourceLimits() [2/2]

TopicQos WithResourceLimits ( ResourceLimits policy )

Creates an instance with a new ResourceLimits policy.

Parameters

policy The new policy

Returns: A new instance with the same policies as the current instance, except for the one being set

◆ WithTopicData() [1/2]

TopicQos WithTopicData ( Action< ImmutableList< byte >.Builder > build )

Creates a new instance with a new TopicData policy as configured by a build action

Parameters

build A function receiving the current values of the policy as an argument. The changes performed by this build function will be used to create the new policy.

Returns: A new instance with the sames policies as the current instance, except for the policy being modified

◆ WithTopicData() [2/2]

TopicQos WithTopicData ( TopicData policy )

Creates an instance with a new TopicData policy.

Parameters

policy The new policy

Returns: A new instance with the same policies as the current instance, except for the one being set

◆ WithTransportPriority() [1/2]

TopicQos WithTransportPriority ( Action< TransportPriorityBuilder > build )

Creates a new instance with a new TransportPriority policy as configured by a build action

Parameters

build A function receiving the current values of the policy as an argument. The changes performed by this build function will be used to create the new policy.

Returns: A new instance with the sames policies as the current instance, except for the policy being modified

◆ WithTransportPriority() [2/2]

TopicQos WithTransportPriority ( TransportPriority policy )

Creates an instance with a new TransportPriority policy.

Parameters

policy The new policy

Returns: A new instance with the same policies as the current instance, except for the one being set

Property Documentation

◆ Deadline

Deadline Deadline

get

Gets the Deadline policy.

◆ Default

TopicQos Default

staticget

Singleton containing the documented default value of a TopicQos

This is a static value containing the documented default values for each policy. Use Domain.DomainParticipant.DefaultTopicQos for the runtime default value that takes into consideration the current configuration.

◆ DestinationOrder

DestinationOrder DestinationOrder

get

Gets the DestinationOrder policy.

◆ Durability

Durability Durability

get

Gets the Durability policy.

◆ DurabilityService

DurabilityService DurabilityService

get

Gets the DurabilityService policy.

◆ History

History History

get

Gets the History policy.

◆ LatencyBudget

LatencyBudget LatencyBudget

get

Gets the LatencyBudget policy.

◆ Lifespan

Lifespan Lifespan

get

Gets the Lifespan policy.

◆ Liveliness

Liveliness Liveliness

get

Gets the Liveliness policy.

◆ Ownership

Ownership Ownership

get

Gets the Ownership policy.

◆ Reliability

Reliability Reliability

get

Gets the Reliability policy.

◆ Representation

DataRepresentation Representation

get

Gets the DataRepresentation policy.

◆ ResourceLimits

ResourceLimits ResourceLimits

get

Gets the ResourceLimits policy.

◆ TopicData

TopicData TopicData

get

Gets the TopicData policy.

◆ TransportPriority

TransportPriority TransportPriority

get

Gets the TransportPriority policy.

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToDataReaderQos()

◆ ToDataWriterQos()

◆ ToString() [1/4]

◆ ToString() [2/4]

◆ ToString() [3/4]

◆ ToString() [4/4]

◆ WithDeadline() [1/2]

◆ WithDeadline() [2/2]

◆ WithDestinationOrder() [1/2]

◆ WithDestinationOrder() [2/2]

◆ WithDurability() [1/2]

◆ WithDurability() [2/2]

◆ WithDurabilityService() [1/2]

◆ WithDurabilityService() [2/2]

◆ WithHistory() [1/2]

◆ WithHistory() [2/2]

◆ WithLatencyBudget() [1/2]

◆ WithLatencyBudget() [2/2]

◆ WithLifespan() [1/2]

◆ WithLifespan() [2/2]

◆ WithLiveliness() [1/2]

◆ WithLiveliness() [2/2]

◆ WithOwnership() [1/2]

◆ WithOwnership() [2/2]

◆ WithReliability() [1/2]

◆ WithReliability() [2/2]

◆ WithRepresentation() [1/2]

◆ WithRepresentation() [2/2]

◆ WithResourceLimits() [1/2]

◆ WithResourceLimits() [2/2]

◆ WithTopicData() [1/2]

◆ WithTopicData() [2/2]

◆ WithTransportPriority() [1/2]

◆ WithTransportPriority() [2/2]

Property Documentation

◆ Deadline

◆ Default

◆ DestinationOrder

◆ Durability

◆ DurabilityService

◆ History

◆ LatencyBudget

◆ Lifespan

◆ Liveliness

◆ Ownership

◆ Reliability

◆ Representation

◆ ResourceLimits

◆ TopicData

◆ TransportPriority