QoS policies supported by a Subscriber. More...

Inherits IEquatable< SubscriberQos >.

Public Member Functions
SubscriberQos	WithPresentation (Presentation policy)
	Creates an instance with a new Presentation policy. More...

SubscriberQos	WithPresentation (Action< PresentationBuilder > build)
	Creates a new instance with a new Presentation policy as configured by a build action More...

SubscriberQos	WithPartition (Partition policy)
	Creates an instance with a new Partition policy. More...

SubscriberQos	WithPartition (Action< ImmutableList< string >.Builder > build)
	Creates a new instance with a new Partition policy as configured by a build action More...

SubscriberQos	WithGroupData (GroupData policy)
	Creates an instance with a new GroupData policy. More...

SubscriberQos	WithGroupData (Action< ImmutableList< byte >.Builder > build)
	Creates a new instance with a new GroupData policy as configured by a build action More...

SubscriberQos	WithEntityFactory (EntityFactory policy)
	Creates an instance with a new EntityFactory policy. More...

SubscriberQos	WithExclusiveArea (ExclusiveArea policy)
	Creates an instance with a new ExclusiveArea policy. More...

SubscriberQos	WithExclusiveArea (Action< ExclusiveAreaBuilder > build)
	Creates a new instance with a new ExclusiveArea policy as configured by a build action More...

SubscriberQos	WithSubscriberName (EntityName policy)
	Creates an instance with a new SubscriberName policy. More...

SubscriberQos	WithSubscriberName (Action< EntityNameBuilder > build)
	Creates a new instance with a new SubscriberName policy as configured by a build action More...

bool	Equals (SubscriberQos 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 (SubscriberQos 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 SubscriberQos	Default `[get]`
	Singleton containing the documented default value of a SubscriberQos More...

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

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

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

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

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

EntityName	SubscriberName `[get]`
	Gets the EntityName policy. More...

Detailed Description

QoS policies supported by a Subscriber.

The full documentation is available in the C API: DDS_SubscriberQos

Member Function Documentation

◆ Equals() [1/2]

override bool Equals ( object obj )

Compares all the policies for equality

◆ Equals() [2/2]

bool Equals ( SubscriberQos other )

Compares all the policies for equality

◆ GetHashCode()

override int GetHashCode ( )

Returns the hash code by combining that of each policy

◆ 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 SubscriberQos object being printed and the baseQos are included in the output.

◆ ToString() [4/4]

string ToString	(	SubscriberQos	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 SubscriberQos object being printed and the baseQos are included in the output.

◆ WithEntityFactory()

SubscriberQos WithEntityFactory ( EntityFactory policy )

Creates an instance with a new EntityFactory policy.

Parameters

policy The new policy

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

◆ WithExclusiveArea() [1/2]

SubscriberQos WithExclusiveArea ( Action< ExclusiveAreaBuilder > build )

Creates a new instance with a new ExclusiveArea 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

◆ WithExclusiveArea() [2/2]

SubscriberQos WithExclusiveArea ( ExclusiveArea policy )

Creates an instance with a new ExclusiveArea policy.

Parameters

policy The new policy

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

◆ WithGroupData() [1/2]

SubscriberQos WithGroupData ( Action< ImmutableList< byte >.Builder > build )

Creates a new instance with a new GroupData 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

◆ WithGroupData() [2/2]

SubscriberQos WithGroupData ( GroupData policy )

Creates an instance with a new GroupData policy.

Parameters

policy The new policy

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

◆ WithPartition() [1/2]

SubscriberQos WithPartition ( Action< ImmutableList< string >.Builder > build )

Creates a new instance with a new Partition 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

◆ WithPartition() [2/2]

SubscriberQos WithPartition ( Partition policy )

Creates an instance with a new Partition policy.

Parameters

policy The new policy

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

◆ WithPresentation() [1/2]

SubscriberQos WithPresentation ( Action< PresentationBuilder > build )

Creates a new instance with a new Presentation 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

◆ WithPresentation() [2/2]

SubscriberQos WithPresentation ( Presentation policy )

Creates an instance with a new Presentation policy.

Parameters

policy The new policy

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

◆ WithSubscriberName() [1/2]

SubscriberQos WithSubscriberName ( Action< EntityNameBuilder > build )

Creates a new instance with a new SubscriberName 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

◆ WithSubscriberName() [2/2]

SubscriberQos WithSubscriberName ( EntityName policy )

Creates an instance with a new SubscriberName 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

◆ Default

SubscriberQos Default

staticget

Singleton containing the documented default value of a SubscriberQos

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

◆ EntityFactory

EntityFactory EntityFactory

get

Gets the EntityFactory policy.

◆ ExclusiveArea

ExclusiveArea ExclusiveArea

get

Gets the ExclusiveArea policy.

◆ GroupData

GroupData GroupData

get

Gets the GroupData policy.

◆ Partition

Partition Partition

get

Gets the Partition policy.

◆ Presentation

Presentation Presentation

get

Gets the Presentation policy.

◆ SubscriberName

EntityName SubscriberName

get

Gets the EntityName policy.

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToString() [1/4]

◆ ToString() [2/4]

◆ ToString() [3/4]

◆ ToString() [4/4]

◆ WithEntityFactory()

◆ WithExclusiveArea() [1/2]

◆ WithExclusiveArea() [2/2]

◆ WithGroupData() [1/2]

◆ WithGroupData() [2/2]

◆ WithPartition() [1/2]

◆ WithPartition() [2/2]

◆ WithPresentation() [1/2]

◆ WithPresentation() [2/2]

◆ WithSubscriberName() [1/2]

◆ WithSubscriberName() [2/2]

Property Documentation

◆ Default

◆ EntityFactory

◆ ExclusiveArea

◆ GroupData

◆ Partition

◆ Presentation

◆ SubscriberName