QoS policies supported by a DomainParticipant. More...

Inherits IEquatable< DomainParticipantQos >.

Public Member Functions
DomainParticipantQos	WithEntityFactory (EntityFactory policy)
	Creates an instance with a new EntityFactory policy. More...

DomainParticipantQos	WithUserData (UserData policy)
	Creates an instance with a new UserData policy. More...

DomainParticipantQos	WithWireProtocol (WireProtocol policy)
	Creates an instance with a new WireProtocol policy. More...

DomainParticipantQos	WithWireProtocol (Action< WireProtocolBuilder > build)
	Creates a new instance with a new WireProtocol policy as configured by a build action More...

DomainParticipantQos	WithTransportBuiltin (TransportBuiltin policy)
	Creates an instance with a new TransportBuiltin policy. More...

DomainParticipantQos	WithTransportBuiltin (Action< TransportBuiltinBuilder > build)
	Creates a new instance with a new TransportBuiltin policy as configured by a build action More...

DomainParticipantQos	WithTransportUnicast (TransportUnicast policy)
	Creates an instance with a new TransportUnicast policy. More...

DomainParticipantQos	WithTransportUnicast (Action< ImmutableList< TransportUnicastSettings >.Builder > build)
	Creates a new instance with a new TransportUnicast policy as configured by a build action More...

DomainParticipantQos	WithDiscovery (Discovery policy)
	Creates an instance with a new Discovery policy. More...

DomainParticipantQos	WithDiscovery (Action< DiscoveryBuilder > build)
	Creates a new instance with a new Discovery policy as configured by a build action More...

DomainParticipantQos	WithDatabase (Database policy)
	Creates an instance with a new Database policy. More...

DomainParticipantQos	WithDatabase (Action< DatabaseBuilder > build)
	Creates a new instance with a new Database policy as configured by a build action More...

DomainParticipantQos	WithDiscoveryConfig (DiscoveryConfig policy)
	Creates an instance with a new DiscoveryConfig policy. More...

DomainParticipantQos	WithDiscoveryConfig (Action< DiscoveryConfigBuilder > build)
	Creates a new instance with a new DiscoveryConfig policy as configured by a build action More...

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

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

DomainParticipantQos	WithEvent (Event policy)
	Creates an instance with a new Event policy. More...

DomainParticipantQos	WithEvent (Action< EventBuilder > build)
	Creates a new instance with a new Event policy as configured by a build action More...

DomainParticipantQos	WithReceiverPool (ReceiverPool policy)
	Creates an instance with a new ReceiverPool policy. More...

DomainParticipantQos	WithReceiverPool (Action< ReceiverPoolBuilder > build)
	Creates a new instance with a new ReceiverPool policy as configured by a build action More...

DomainParticipantQos	WithParticipantName (EntityName policy)
	Creates an instance with a new ParticipantName policy. More...

DomainParticipantQos	WithParticipantName (Action< EntityNameBuilder > build)
	Creates a new instance with a new ParticipantName policy as configured by a build action More...

DomainParticipantQos	WithProperty (Property policy)
	Creates an instance with a new Property policy. More...

DomainParticipantQos	WithProperty (Action< ImmutableDictionary< string, Property.Entry >.Builder > build)
	Creates a new instance with a new Property policy as configured by a build action More...

DomainParticipantQos	WithExclusiveArea (ExclusiveArea policy)
	Deprecated More...

DomainParticipantQos	WithExclusiveArea (Action< ExclusiveAreaBuilder > build)
	Deprecated More...

DomainParticipantQos	WithService (Service policy)
	Creates an instance with a new Service policy. More...

DomainParticipantQos	WithService (Action< ServiceBuilder > build)
	Creates a new instance with a new Service policy as configured by a build action More...

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

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

override int	GetHashCode ()
	Returns the hash code by combining that of each policy 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 (DomainParticipantQos 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 DomainParticipantQos	Default = new DomainParticipantQos() `[get]`
	Singleton containing the documented default value of a DomainParticipantQos More...

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

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

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

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

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

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

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

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

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

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

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

ExclusiveArea	ExclusiveArea `[get]`
	Deprecated More...

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

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

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

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

Detailed Description

QoS policies supported by a DomainParticipant.

The full documentation is available in the C API: DDS_DomainParticipantQos

Member Function Documentation

◆ WithEntityFactory()

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithEntityFactory ( EntityFactory policy )

inline

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

◆ WithUserData()

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithUserData ( UserData policy )

inline

Creates an instance with a new UserData policy.

Parameters

policy The new policy

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

◆ WithWireProtocol() [1/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithWireProtocol ( WireProtocol policy )

inline

Creates an instance with a new WireProtocol policy.

Parameters

policy The new policy

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

◆ WithWireProtocol() [2/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithWireProtocol ( Action< WireProtocolBuilder > build )

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

◆ WithTransportBuiltin() [1/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithTransportBuiltin ( TransportBuiltin policy )

inline

Creates an instance with a new TransportBuiltin policy.

Parameters

policy The new policy

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

◆ WithTransportBuiltin() [2/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithTransportBuiltin ( Action< TransportBuiltinBuilder > build )

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

◆ WithTransportUnicast() [1/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithTransportUnicast ( TransportUnicast policy )

inline

Creates an instance with a new TransportUnicast policy.

Parameters

policy The new policy

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

◆ WithTransportUnicast() [2/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithTransportUnicast ( Action< ImmutableList< TransportUnicastSettings >.Builder > build )

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

◆ WithDiscovery() [1/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithDiscovery ( Discovery policy )

inline

Creates an instance with a new Discovery policy.

Parameters

policy The new policy

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

◆ WithDiscovery() [2/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithDiscovery ( Action< DiscoveryBuilder > build )

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

◆ WithDatabase() [1/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithDatabase ( Database policy )

inline

Creates an instance with a new Database policy.

Parameters

policy The new policy

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

◆ WithDatabase() [2/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithDatabase ( Action< DatabaseBuilder > build )

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

◆ WithDiscoveryConfig() [1/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithDiscoveryConfig ( DiscoveryConfig policy )

inline

Creates an instance with a new DiscoveryConfig policy.

Parameters

policy The new policy

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

◆ WithDiscoveryConfig() [2/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithDiscoveryConfig ( Action< DiscoveryConfigBuilder > build )

Creates a new instance with a new DiscoveryConfig 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() [1/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithResourceLimits ( DomainParticipantResourceLimits policy )

inline

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

◆ WithResourceLimits() [2/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithResourceLimits ( Action< DomainParticipantResourceLimitsBuilder > 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

◆ WithEvent() [1/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithEvent ( Event policy )

inline

Creates an instance with a new Event policy.

Parameters

policy The new policy

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

◆ WithEvent() [2/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithEvent ( Action< EventBuilder > build )

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

◆ WithReceiverPool() [1/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithReceiverPool ( ReceiverPool policy )

inline

Creates an instance with a new ReceiverPool policy.

Parameters

policy The new policy

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

◆ WithReceiverPool() [2/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithReceiverPool ( Action< ReceiverPoolBuilder > build )

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

◆ WithParticipantName() [1/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithParticipantName ( EntityName policy )

inline

Creates an instance with a new ParticipantName policy.

Parameters

policy The new policy

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

◆ WithParticipantName() [2/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithParticipantName ( Action< EntityNameBuilder > build )

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

◆ WithProperty() [1/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithProperty ( Property policy )

inline

Creates an instance with a new Property policy.

Parameters

policy The new policy

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

◆ WithProperty() [2/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithProperty ( Action< ImmutableDictionary< string, Property.Entry >.Builder > build )

Creates a new instance with a new Property 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() [1/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithExclusiveArea ( ExclusiveArea policy )

inline

Deprecated

◆ WithExclusiveArea() [2/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithExclusiveArea ( Action< ExclusiveAreaBuilder > build )

Deprecated

◆ WithService() [1/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithService ( Service policy )

inline

Creates an instance with a new Service policy.

Parameters

policy The new policy

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

◆ WithService() [2/2]

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithService ( Action< ServiceBuilder > build )

Creates a new instance with a new Service 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()

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.WithPartition ( Partition policy )

inline

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

◆ Equals()

bool Rti.Dds.Domain.DomainParticipantQos.Equals ( DomainParticipantQos other )

inline

Compares all the policies for equality

◆ GetHashCode()

override int Rti.Dds.Domain.DomainParticipantQos.GetHashCode ( )

inline

Returns the hash code by combining that of each policy

◆ ToString() [1/4]

override string Rti.Dds.Domain.DomainParticipantQos.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 Rti.Dds.Domain.DomainParticipantQos.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 DomainParticipantQos object being printed and the baseQos are included in the output.

◆ ToString() [3/4]

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

◆ ToString() [4/4]

string Rti.Dds.Domain.DomainParticipantQos.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.

Property Documentation

◆ Default

DomainParticipantQos Rti.Dds.Domain.DomainParticipantQos.Default = new DomainParticipantQos()

staticget

Singleton containing the documented default value of a DomainParticipantQos

This is a static value containing the documented default values for each policy. In most cases, you should use DomainParticipantFactory.DefaultParticipantQos, to get the runtime default value that takes into consideration the current configuration.

◆ UserData

UserData Rti.Dds.Domain.DomainParticipantQos.UserData

get

Gets the UserData policy.

◆ EntityFactory

EntityFactory Rti.Dds.Domain.DomainParticipantQos.EntityFactory

get

Gets the EntityFactory policy.

◆ WireProtocol

WireProtocol Rti.Dds.Domain.DomainParticipantQos.WireProtocol

get

Gets the WireProtocol policy.

◆ TransportBuiltin

TransportBuiltin Rti.Dds.Domain.DomainParticipantQos.TransportBuiltin

get

Gets the TransportBuiltin policy.

◆ TransportUnicast

TransportUnicast Rti.Dds.Domain.DomainParticipantQos.TransportUnicast

get

Gets the TransportUnicast policy.

◆ Discovery

Discovery Rti.Dds.Domain.DomainParticipantQos.Discovery

get

Gets the Discovery policy.

◆ ResourceLimits

DomainParticipantResourceLimits Rti.Dds.Domain.DomainParticipantQos.ResourceLimits

get

Gets the DomainParticipantResourceLimits policy.

◆ Event

Event Rti.Dds.Domain.DomainParticipantQos.Event

get

Gets the Event policy.

◆ ReceiverPool

ReceiverPool Rti.Dds.Domain.DomainParticipantQos.ReceiverPool

get

Gets the ReceiverPool policy.

◆ Database

Database Rti.Dds.Domain.DomainParticipantQos.Database

get

Gets the Database policy.

◆ DiscoveryConfig

DiscoveryConfig Rti.Dds.Domain.DomainParticipantQos.DiscoveryConfig

get

Gets the DiscoveryConfig policy.

◆ ExclusiveArea

ExclusiveArea Rti.Dds.Domain.DomainParticipantQos.ExclusiveArea

get

Deprecated

◆ Property

Property Rti.Dds.Domain.DomainParticipantQos.Property

get

Gets the Property policy.

◆ ParticipantName

EntityName Rti.Dds.Domain.DomainParticipantQos.ParticipantName

get

Gets the ParticipantName policy.

◆ Service

Service Rti.Dds.Domain.DomainParticipantQos.Service

get

Gets the Service policy.

◆ Partition

Partition Rti.Dds.Domain.DomainParticipantQos.Partition

get

Gets the Partition policy.

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ WithEntityFactory()

◆ WithUserData()

◆ WithWireProtocol() [1/2]

◆ WithWireProtocol() [2/2]

◆ WithTransportBuiltin() [1/2]

◆ WithTransportBuiltin() [2/2]

◆ WithTransportUnicast() [1/2]

◆ WithTransportUnicast() [2/2]

◆ WithDiscovery() [1/2]

◆ WithDiscovery() [2/2]

◆ WithDatabase() [1/2]

◆ WithDatabase() [2/2]

◆ WithDiscoveryConfig() [1/2]

◆ WithDiscoveryConfig() [2/2]

◆ WithResourceLimits() [1/2]

◆ WithResourceLimits() [2/2]

◆ WithEvent() [1/2]

◆ WithEvent() [2/2]

◆ WithReceiverPool() [1/2]

◆ WithReceiverPool() [2/2]

◆ WithParticipantName() [1/2]

◆ WithParticipantName() [2/2]

◆ WithProperty() [1/2]

◆ WithProperty() [2/2]

◆ WithExclusiveArea() [1/2]

◆ WithExclusiveArea() [2/2]

◆ WithService() [1/2]

◆ WithService() [2/2]

◆ WithPartition()

◆ Equals()

◆ GetHashCode()

◆ ToString() [1/4]

◆ ToString() [2/4]

◆ ToString() [3/4]

◆ ToString() [4/4]

Property Documentation

◆ Default

◆ UserData

◆ EntityFactory

◆ WireProtocol

◆ TransportBuiltin

◆ TransportUnicast

◆ Discovery

◆ ResourceLimits

◆ Event

◆ ReceiverPool

◆ Database

◆ DiscoveryConfig

◆ ExclusiveArea

◆ Property

◆ ParticipantName

◆ Service

◆ Partition