DomainParticipantQos Class Reference

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)
	Creates an instance with a new ExclusiveArea policy. More...
DomainParticipantQos	WithExclusiveArea (Action< ExclusiveAreaBuilder > build)
	Creates a new instance with a new ExclusiveArea policy as configured by a build action 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...
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 [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]
	Gets the ExclusiveArea policy. 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...

Detailed Description

QoS policies supported by a DomainParticipant.

The full documentation is available in the C API: DDS_DomainParticipantQos

Member Function Documentation

Equals()

bool Equals

(

DomainParticipantQos

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	(	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() [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 DomainParticipantQos object being printed and the baseQos are included in the output.

WithDatabase() [1/2]

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

WithDatabase() [2/2]

DomainParticipantQos WithDatabase

(

Database

policy

)

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

WithDiscovery() [1/2]

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

WithDiscovery() [2/2]

DomainParticipantQos WithDiscovery

(

Discovery

policy

)

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

WithDiscoveryConfig() [1/2]

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

WithDiscoveryConfig() [2/2]

DomainParticipantQos WithDiscoveryConfig

(

DiscoveryConfig

policy

)

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

WithEntityFactory()

DomainParticipantQos 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

WithEvent() [1/2]

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

WithEvent() [2/2]

DomainParticipantQos WithEvent

(

Event

policy

)

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

WithExclusiveArea() [1/2]

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

DomainParticipantQos 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

WithParticipantName() [1/2]

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

WithParticipantName() [2/2]

DomainParticipantQos WithParticipantName

(

EntityName

policy

)

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

WithProperty() [1/2]

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

WithProperty() [2/2]

DomainParticipantQos WithProperty

(

Property

policy

)

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

WithReceiverPool() [1/2]

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

WithReceiverPool() [2/2]

DomainParticipantQos WithReceiverPool

(

ReceiverPool

policy

)

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

WithResourceLimits() [1/2]

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

WithResourceLimits() [2/2]

DomainParticipantQos WithResourceLimits

(

DomainParticipantResourceLimits

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

WithService() [1/2]

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

WithService() [2/2]

DomainParticipantQos WithService

(

Service

policy

)

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

WithTransportBuiltin() [1/2]

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

WithTransportBuiltin() [2/2]

DomainParticipantQos WithTransportBuiltin

(

TransportBuiltin

policy

)

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

WithTransportUnicast() [1/2]

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

WithTransportUnicast() [2/2]

DomainParticipantQos WithTransportUnicast

(

TransportUnicast

policy

)

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

WithUserData()

DomainParticipantQos WithUserData

(

UserData

policy

)

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

WithWireProtocol() [2/2]

DomainParticipantQos WithWireProtocol

(

WireProtocol

policy

)

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

Property Documentation

Database

Database Database

get

Gets the Database policy.

Default

DomainParticipantQos Default

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.

Discovery

Discovery Discovery

get

Gets the Discovery policy.

DiscoveryConfig

DiscoveryConfig DiscoveryConfig

get

Gets the DiscoveryConfig policy.

EntityFactory

EntityFactory EntityFactory

get

Gets the EntityFactory policy.

Event

Event Event

get

Gets the Event policy.

ExclusiveArea

ExclusiveArea ExclusiveArea

get

Gets the ExclusiveArea policy.

ParticipantName

EntityName ParticipantName

get

Gets the ParticipantName policy.

Property

Property Property

get

Gets the Property policy.

ReceiverPool

ReceiverPool ReceiverPool

get

Gets the ReceiverPool policy.

ResourceLimits

DomainParticipantResourceLimits ResourceLimits

get

Gets the DomainParticipantResourceLimits policy.

Service

Service Service

get

Gets the Service policy.

TransportBuiltin

TransportBuiltin TransportBuiltin

get

Gets the TransportBuiltin policy.

TransportUnicast

TransportUnicast TransportUnicast

get

Gets the TransportUnicast policy.

UserData

UserData UserData

get

Gets the UserData policy.

WireProtocol

WireProtocol WireProtocol

get

Gets the WireProtocol policy.