QoS policies supported by a Publisher. More...

Inherits IEquatable< PublisherQos >.

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

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

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

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

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

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

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

PublisherQos	WithAsynchronousPublisher (AsynchronousPublisher policy)
	Creates an instance with a new AsynchronousPublisher policy. More...

PublisherQos	WithAsynchronousPublisher (Action< AsynchronousPublisherBuilder > build)
	Creates a new instance with a new AsynchronousPublisher policy as configured by a build action More...

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

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

PublisherQos	WithPublisherName (EntityName policy)
	Creates an instance with a new PublisherName policy. More...

PublisherQos	WithPublisherName (Action< EntityNameBuilder > build)
	Creates a new instance with a new PublisherName policy as configured by a build action More...

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

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

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

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

Detailed Description

QoS policies supported by a Publisher.

The full documentation is available in the C API: DDS_PublisherQos

Member Function Documentation

◆ Equals() [1/2]

override bool Equals ( object obj )

Compares all the policies for equality

◆ Equals() [2/2]

bool Equals ( PublisherQos 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	(	PublisherQos	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 PublisherQos object being printed and the baseQos are included in the output.

◆ ToString() [3/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() [4/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 PublisherQos object being printed and the baseQos are included in the output.

◆ WithAsynchronousPublisher() [1/2]

PublisherQos WithAsynchronousPublisher ( Action< AsynchronousPublisherBuilder > build )

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

◆ WithAsynchronousPublisher() [2/2]

PublisherQos WithAsynchronousPublisher ( AsynchronousPublisher policy )

Creates an instance with a new AsynchronousPublisher policy.

Parameters

policy The new policy

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

◆ WithEntityFactory()

PublisherQos 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]

PublisherQos 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]

PublisherQos 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]

PublisherQos 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]

PublisherQos 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]

PublisherQos 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]

PublisherQos 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]

PublisherQos 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]

PublisherQos 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

◆ WithPublisherName() [1/2]

PublisherQos WithPublisherName ( Action< EntityNameBuilder > build )

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

◆ WithPublisherName() [2/2]

PublisherQos WithPublisherName ( EntityName policy )

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

◆ AsynchronousPublisher

AsynchronousPublisher AsynchronousPublisher

get

Gets the AsynchronousPublisher policy.

◆ Default

PublisherQos Default

staticget

Singleton containing the documented default value of a PublisherQos

This is a static value containing the documented default values for each policy. Use Domain.DomainParticipant.DefaultPublisherQos 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.

◆ PublisherName

EntityName PublisherName

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]

◆ WithAsynchronousPublisher() [1/2]

◆ WithAsynchronousPublisher() [2/2]

◆ 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]

◆ WithPublisherName() [1/2]

◆ WithPublisherName() [2/2]

Property Documentation

◆ AsynchronousPublisher

◆ Default

◆ EntityFactory

◆ ExclusiveArea

◆ GroupData

◆ Partition

◆ Presentation

◆ PublisherName